Skip to content

Commit

Permalink
Merge pull request #52 from abkrim/master
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
jszobody authored Feb 10, 2022
2 parents 98b0514 + ca5cb17 commit 385186a
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,52 +18,52 @@ composer require stechstudio/laravel-ssh-tunnel
```
## Configuration
All configuration can and should be done in your `.env` file.
```ini
; Process used to verify connection
; Use bash if your distro uses nmap-ncat (RHEL/CentOS 7.x)
```env
# Process used to verify connection
# Use bash if your distro uses nmap-ncat (RHEL/CentOS 7.x)
TUNNELER_VERIFY_PROCESS=nc
; Path to the nc executable
# Path to the nc executable
TUNNELER_NC_PATH=/usr/bin/nc
; Path to the bash executable
# Path to the bash executable
TUNNELER_BASH_PATH=/usr/bin/bash
; Path to the ssh executable
# Path to the ssh executable
TUNNELER_SSH_PATH=/usr/bin/ssh
; Path to the nohup executable
# Path to the nohup executable
TUNNELER_NOHUP_PATH=/usr/bin/nohup
; Log messages for troubleshooting
# Log messages for troubleshooting
SSH_VERBOSITY=
NOHUP_LOG=/dev/null
; The identity file you want to use for ssh auth
# The identity file you want to use for ssh auth
TUNNELER_IDENTITY_FILE=/home/user/.ssh/id_rsa
; The local address and port for the tunnel
# The local address and port for the tunnel
TUNNELER_LOCAL_PORT=13306
TUNNELER_LOCAL_ADDRESS=127.0.0.1
; The remote address and port for the tunnel
# The remote address and port for the tunnel
TUNNELER_BIND_PORT=3306
TUNNELER_BIND_ADDRESS=127.0.0.1
; The ssh connection: sshuser@sshhost:sshport
# The ssh connection: sshuser@sshhost:sshport
TUNNELER_USER=sshuser
TUNNELER_HOSTNAME=sshhost
TUNNELER_PORT=sshport
; How long to wait, in microseconds, before testing to see if the tunnel is created.
; Depending on your network speeds you will want to modify the default of 1 seconds
# How long to wait, in microseconds, before testing to see if the tunnel is created.
# Depending on your network speeds you will want to modify the default of 1 seconds
TUNNELER_CONN_WAIT=1000000
; How often it is checked if the tunnel is created. Useful if the tunnel creation is sometimes slow,
; and you want to minimize waiting times
# How often it is checked if the tunnel is created. Useful if the tunnel creation is sometimes slow,
# and you want to minimize waiting times
TUNNELER_CONN_TRIES=1
; Do you want to ensure you have the Tunnel in place for each bootstrap of the framework?
# Do you want to ensure you have the Tunnel in place for each bootstrap of the framework?
TUNNELER_ON_BOOT=false
; Do you want to use additional SSH options when the tunnel is created?
# Do you want to use additional SSH options when the tunnel is created?
TUNNELER_SSH_OPTIONS="-o StrictHostKeyChecking=no"
```

Expand Down

0 comments on commit 385186a

Please sign in to comment.