Skip to content

Commit 385186a

Browse files
authored
Merge pull request #52 from abkrim/master
Update README.md
2 parents 98b0514 + ca5cb17 commit 385186a

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -18,52 +18,52 @@ composer require stechstudio/laravel-ssh-tunnel
1818
```
1919
## Configuration
2020
All configuration can and should be done in your `.env` file.
21-
```ini
22-
; Process used to verify connection
23-
; Use bash if your distro uses nmap-ncat (RHEL/CentOS 7.x)
21+
```env
22+
# Process used to verify connection
23+
# Use bash if your distro uses nmap-ncat (RHEL/CentOS 7.x)
2424
TUNNELER_VERIFY_PROCESS=nc
2525
26-
; Path to the nc executable
26+
# Path to the nc executable
2727
TUNNELER_NC_PATH=/usr/bin/nc
28-
; Path to the bash executable
28+
# Path to the bash executable
2929
TUNNELER_BASH_PATH=/usr/bin/bash
30-
; Path to the ssh executable
30+
# Path to the ssh executable
3131
TUNNELER_SSH_PATH=/usr/bin/ssh
32-
; Path to the nohup executable
32+
# Path to the nohup executable
3333
TUNNELER_NOHUP_PATH=/usr/bin/nohup
3434
35-
; Log messages for troubleshooting
35+
# Log messages for troubleshooting
3636
SSH_VERBOSITY=
3737
NOHUP_LOG=/dev/null
3838
39-
; The identity file you want to use for ssh auth
39+
# The identity file you want to use for ssh auth
4040
TUNNELER_IDENTITY_FILE=/home/user/.ssh/id_rsa
4141
42-
; The local address and port for the tunnel
42+
# The local address and port for the tunnel
4343
TUNNELER_LOCAL_PORT=13306
4444
TUNNELER_LOCAL_ADDRESS=127.0.0.1
4545
46-
; The remote address and port for the tunnel
46+
# The remote address and port for the tunnel
4747
TUNNELER_BIND_PORT=3306
4848
TUNNELER_BIND_ADDRESS=127.0.0.1
4949
50-
; The ssh connection: sshuser@sshhost:sshport
50+
# The ssh connection: sshuser@sshhost:sshport
5151
TUNNELER_USER=sshuser
5252
TUNNELER_HOSTNAME=sshhost
5353
TUNNELER_PORT=sshport
5454
55-
; How long to wait, in microseconds, before testing to see if the tunnel is created.
56-
; Depending on your network speeds you will want to modify the default of 1 seconds
55+
# How long to wait, in microseconds, before testing to see if the tunnel is created.
56+
# Depending on your network speeds you will want to modify the default of 1 seconds
5757
TUNNELER_CONN_WAIT=1000000
5858
59-
; How often it is checked if the tunnel is created. Useful if the tunnel creation is sometimes slow,
60-
; and you want to minimize waiting times
59+
# How often it is checked if the tunnel is created. Useful if the tunnel creation is sometimes slow,
60+
# and you want to minimize waiting times
6161
TUNNELER_CONN_TRIES=1
6262
63-
; Do you want to ensure you have the Tunnel in place for each bootstrap of the framework?
63+
# Do you want to ensure you have the Tunnel in place for each bootstrap of the framework?
6464
TUNNELER_ON_BOOT=false
6565
66-
; Do you want to use additional SSH options when the tunnel is created?
66+
# Do you want to use additional SSH options when the tunnel is created?
6767
TUNNELER_SSH_OPTIONS="-o StrictHostKeyChecking=no"
6868
```
6969

0 commit comments

Comments
 (0)