Skip to content

Commit 24ca81c

Browse files
committed
Update README.md
1 parent 10b33b5 commit 24ca81c

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
sync a local folder to S3.
33

44
## Description
5-
SyncS3 is a little utlity that watch file changes in a directory and push them in a S3
6-
it uses notification of the kernel to see what files are wrote
5+
SyncS3 is a little utlity that watch file changes in a directory and push them via S3 or sftp
6+
it uses notification of the kernel to see what files are wrote (works only on linux)
77

88
## How to use it
99
All is ready in a docker image. You have just to set some parameters
1010

11-
### docker-compose.yml
11+
### docker-compose.yml
1212
```
1313
services:
1414
app:
@@ -21,8 +21,8 @@ services:
2121
```
2222
the directory to watch must mounted in volume. In this exemple (for bareos : /home/docker/bareos-sd/data/storage)
2323

24-
### variables
25-
fichier .env
24+
### variables for S3
25+
file .env
2626
```
2727
## Endpoint S3
2828
S3_ENDPOINT=https://s3.rbx.io.cloud.ovh.net/
@@ -35,8 +35,18 @@ S3_REGION=RBX
3535
## bucket
3636
S3_BUCKET=My-Bucket
3737
## dir_source (always /data) mounted volume
38-
DIR_SOURCE=/data
38+
S3_DIR_SOURCE=/data
3939
## Prefix S3 exemple file foo.txt will be named /data-sd1/foo.txt in S3
4040
S3_DIR_DEST=/data-sd1
4141
```
4242

43+
### variables for sftp
44+
file .env
45+
```
46+
TYPE="sftp"
47+
SFTP_HOST="mysftp.server.com"
48+
SFTP_USER="myuser"
49+
DIR_SOURCE="/data"
50+
DIR_DEST="/home/myuser/test"
51+
SFTP_PRIVATE_KEY_FILE="/conf/id_ed25519"
52+
```

0 commit comments

Comments
 (0)