diff --git a/README.md b/README.md index c5b44da..2b924a3 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,27 @@ Run a seafile client inside docker witch can sync files from seafile repositorie See docker-compose how to use. +## Docker-compose example: +```yaml +version: '3' +services: + seafile-client: + restart: always + build: . + container_name: seafile-client + environment: + - LIBRARY_ID= + - SERVER_HOST= + - SERVER_PORT= + - USERNAME= + - PASSWORD= + - DATA_DIR= + - SEAFILE_UID= + - SEAFILE_GID= + volumes: + - : +``` + ## Environment variables: - `LIBRARY_ID=` ID of library to sync; multiple libraries could be separated by colon `:` - `SERVER_HOST=` Hostname of your seafile server, eg: seafile.example.com diff --git a/docker-compose.yaml b/docker-compose.example.yml similarity index 100% rename from docker-compose.yaml rename to docker-compose.example.yml