docker-seafile-client/README.md

69 lines
2.6 KiB
Markdown
Raw Normal View History

2018-04-18 16:28:15 +00:00
# docker-seafile-client
2023-10-21 00:32:34 +00:00
Docker image for [Seafile CLI client](https://help.seafile.com/syncing_client/linux-cli/).
2018-04-18 16:38:25 +00:00
### Docker-compose example:
2019-04-14 10:18:09 +00:00
```yaml
services:
seafile-client:
restart: always
image: snegov/seafile-client
2019-04-14 10:18:09 +00:00
environment:
- LIBRARY_ID="79867cbf-2944-488d-9105-852463ecdf9e:my_library"
- SERVER_HOST=seafile.example.com
- USERNAME=user
- PASSWORD=password
- SEAFILE_UID=1000
- SEAFILE_GID=100
hostname: dsc
2019-04-14 10:18:09 +00:00
volumes:
- /home/johndow/seafile:/dsc/seafile
- sync-data:/dsc/seafile-data
container_name: seafile-client
2021-02-28 20:27:26 +00:00
volumes:
sync-data:
2019-04-14 10:18:09 +00:00
```
### Environment variables:
2023-10-21 00:32:34 +00:00
- `LIBRARY_ID` - library to sync, ID or name. Multiple libraries could be
separated by colon `:`.
- `SERVER_HOST` - hostname of your Seafile server, eg: _seafile.example.com_.
If you're using non-standard port, you can specify it here,
eg: _seafile.example.com:8080_.
- `USERNAME` / `PASSWORD` - credentials to access Seafile server.
- `SEAFILE_UID` / `SEAFILE_GID` - UID/GID of user inside container. You can
use it to set permissions on synced files. Default values are _1000_ / _1000_.
- `DELETE_CONFIRM_THRESHOLD` - represents the number of files that require
confirmation before being deleted simultaneously. Default value is _500_.
- `DISABLE_VERIFY_CERTIFICATE` - set to _true_ to disable server's certificate
verification. Default value is _false_.
- `UPLOAD_LIMIT` / `DOWNLOAD_LIMIT` - upload/download speed limit in B/s
(bytes per second). Default values are _0_ (unlimited).
### Volumes:
- `/dsc/seafile-data` Seafile client data directory (sync status, etc).
- `/dsc/seafile` Seafile libraries content.
### Some notes
2023-10-21 00:32:34 +00:00
`LIBRARY_ID` could be library ID or library name. Library ID is a 36-character
string, which is a part of URI when you open library in webUI. Library name is
a name you gave to library when you created it.
2021-02-28 20:27:51 +00:00
2023-10-21 00:32:34 +00:00
Libraries will be synced in subdirectories of `/dsc/seafile` directory inside
container. You can mount it to host directory to access files.
2021-02-28 20:24:37 +00:00
2023-10-21 00:32:34 +00:00
`hostname` parameter is optional, but it's recommended to set it to some unique
value, it will be shown in Seafile webUI as client name (`terminal-dsc` in
given example).
2021-02-28 20:27:51 +00:00
2023-10-21 00:32:34 +00:00
`sync-data` volume is optional too, but it's recommended to use it. Otherwise,
sync status will be lost when container is recreated.
2021-02-28 20:27:51 +00:00
2023-10-21 00:32:34 +00:00
At the moment there is no suitable way to confirm deletion of large number of
files. So, if you're going to delete a lot of files, you should set
`DELETE_CONFIRM_THRESHOLD` to some larger value.
### Links
- [Official Seafile CLI client documentation](https://help.seafile.com/syncing_client/linux-cli/)