Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bubba-h57 committed Oct 14, 2019
1 parent 4e2f621 commit 97d3991
Showing 1 changed file with 3 additions and 19 deletions.
22 changes: 3 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,15 @@ We had a similar challenge, specifically accessing a MySQL database over an SSH
So we wrote this package. We hope you enjoy it!

## Requirements
This package has been tested against Laravel/Lumen versions 5.2. 5.3, and 5.4.
This package has been tested against Laravel/Lumen versions 5.5 and 6.0.

We do not support version <=5.1.
We do not support version <5.5 now, look at our older, unsupported, versions for that.

## Installation

```
composer require stechstudio/laravel-ssh-tunnel
```

### Register the Provider (version 5.4 and earlier):

For Lumen services, add:

```php
$app->register(STS\Tunneler\TunnelerServiceProvider::class);
```
to `bootstrap/app.php`. For Laravel applications, add:

```php
STS\Tunneler\TunnelerServiceProvider::class,
```

to the `providers` array in `config/app.php`.

## Configuration
All configuration can and should be done in your `.env` file.
```ini
Expand Down Expand Up @@ -74,7 +58,7 @@ 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 .5 seconds
; 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,
Expand Down

0 comments on commit 97d3991

Please sign in to comment.