Fix and validate Compose quick start

The list-form environment syntax in the README passed quote characters
through as part of the value, so LIBRARY_ID was read as '"<id>"' and no
matching library was found. Switch to mapping syntax, where YAML strips
the quotes.

- Pin the example to a versioned image instead of implicit latest
- Add a checked-in compose.example.yaml
- Validate it with `docker compose config` in CI
- Link the Docker Hub image from the README
This commit is contained in:
Maxim Shulga committed 2026-08-02 14:53:08 -07:00
1 parent a7abdab1f7
commit d500ddc7ab
4 files changed
+231 -7

No files matched your search

+12 -7
View File
@@ -1,19 +1,24 @@
# docker-seafile-client
Docker image for [Seafile CLI client](https://help.seafile.com/syncing_client/linux-cli/).
Image on Docker Hub:
[snegov/seafile-client](https://hub.docker.com/r/snegov/seafile-client).
### Docker-compose example:
Also available as a ready-to-use [`compose.example.yaml`](compose.example.yaml).
```yaml
services:
seafile-client:
restart: always
image: snegov/seafile-client
image: snegov/seafile-client:0.0.9
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
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
volumes:
- /home/johndow/seafile:/dsc/seafile