Skip to content

Doc Updates #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 14, 2019
Merged

Doc Updates #34

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e2f621
Initializing Doc_Updates for empty Pull Request
bubba-h57 Oct 14, 2019
97d3991
Updated Readme
bubba-h57 Oct 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 3 additions & 19 deletions README.md
View file
Open in desktop
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