Skip to content

Commit 6269939

Browse files
committed
Added SFTP filesystem section to README.md
1 parent 9d8f8e5 commit 6269939

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,43 @@ return [
290290
];
291291
```
292292

293+
### SFTP filesystem
294+
295+
Either run
296+
297+
```bash
298+
$ composer require league/flysystem-sftp
299+
```
300+
301+
or add
302+
303+
```
304+
"league/flysystem-sftp": "~1.0"
305+
```
306+
307+
to the `require` section of your `composer.json` file and configure application `components` as follows
308+
309+
```php
310+
return [
311+
//...
312+
'components' => [
313+
//...
314+
'sftpFs' => [
315+
'class' => 'creocoder\flysystem\FtpFilesystem',
316+
'host' => 'sftp.example.com',
317+
// 'port' => 22,
318+
'username' => 'your-username',
319+
'password' => 'your-password',
320+
'privateKey' => '/path/to/or/contents/of/privatekey',
321+
// 'timeout' => 60,
322+
// 'root' => '/path/to/root',
323+
// 'permPrivate' => 0700,
324+
// 'permPublic' => 0744,
325+
],
326+
],
327+
];
328+
```
329+
293330
### WebDAV filesystem
294331

295332
Either run

0 commit comments

Comments
 (0)