Version 3

Support for multiple libraries synchronization (#44, #43, #41) Support for Docker Secrets (#25) Support for Seafile client's version through Docker tags (#9) Mock Seafile server for testings (#6) Revised project layout and workflow (#38, #39) Working Docker Hub description publishing (#10)
2024-03-16 21:58:04 +00:00
parent 4c347b9156
commit f25b0182d2
42 changed files with 1196 additions and 788 deletions
@@ -1,91 +1,153 @@
-[![](https://img.shields.io/gitlab/pipeline/flwgns-docker/seafile-client/2.2.0?label=Build)](https://gitlab.com/flwgns-docker/seafile-client/commits/2.2.0)
-[![](https://img.shields.io/docker/image-size/flowgunso/seafile-client/latest?label=Docker%20image%20size&color=%230778b8)](https://hub.docker.com/r/flowgunso/seafile-client)
-[![](https://img.shields.io/docker/pulls/flowgunso/seafile-client?label=Docker%20pulls&color=%230778b8)](https://hub.docker.com/r/flowgunso/seafile-client)
-[![](https://img.shields.io/badge/License-GPLv3-red.svg)](https://www.gnu.org/licenses/gpl-3.0)
-[![](https://img.shields.io/badge/Source%20code-GitLab-red.svg)](https://gitlab.com/flwgns-docker/seafile-client/)
+[![][badge-pipeline]][url-pipelines]
+[![][badge-image-size]][url-docker]
+[![][badge-pulls]][url-docker]
+[![][badge-release]][url-sources]
+![][badge-license]
+
+[url-pipelines]: https://gitlab.com/flwgns-docker/seafile-client/-/pipelines
+[url-docker]: https://hub.docker.com/r/flowgunso/seafile-client
+[url-sources]: https://gitlab.com/flwgns-docker/seafile-client/
+
+[badge-pipeline]: https://img.shields.io/gitlab/pipeline-status/flwgns-docker%2Fseafile-client
+[badge-image-size]: https://img.shields.io/docker/image-size/flowgunso/seafile-client/latest?logo=docker&label=Image%20size&color=%230778b8
+[badge-pulls]: https://img.shields.io/docker/pulls/flowgunso/seafile-client?logo=docker&label=Pulls&color=%230778b8
+[badge-license]: https://img.shields.io/gitlab/license/11322291?label=License&color=fca326
+[badge-release]: https://img.shields.io/gitlab/v/release/11322291?logo=gitlab&label=Source%20code&color=fca326

 **Share a Seafile library as a volume to other containers.**

-# Supported tags
-[`2`, `2.2`, `2.2.0`, `latest`](seafile-client/Dockerfile)
-
-# Informations
-* Synchronize a single Seafile library, available at the path `/library/'.
-* Password protected librairies are supported.
-* Two factor authentication is supported.
-* Upload and download speeds are configurable.
-* SSL certificates are skippable.
-<!-- -->
-* Ask questions on [Seafile forum](https://forum.seafile.com/t/docker-client-to-sync-files-with-containers/8573).
-* Contribute and report issues on [Gitlab](https://gitlab.com/flwgns-docker/seafile-client/).
-
+# Features
+* Synchronize one or more Seafile libraries.
+* Support password protected librairies.
+* Support two factor authentication.
+* Configure upload and download limits.
+* Skip SSL certificates.
+* Set file ownership with user/group ID

 # Usage
-## Required configuration
-__SEAF_SERVER_URL__, __SEAF_USERNAME__, __SEAF_PASSWORD__, __SEAF_LIBRARY_UUID__  
-Provide your Seafile _server URL_, _username_, _password_ and _library UUID_ to synchronise your library at `/library`, then share it as a volume.

-The `seaf-cli` is ran within the container as the user `seafuser`. 
+## Start a Seafile client

-## Optional configurations
-__SEAF_2FA_SECRET__  
-_Two factor authentication is supported but your secret key must be provided._ That key can be found on your Seafile web interface, only at the 2FA setup, when the QR code is shown. The secret key is embedded in the QR or available as a cookie.
-
-__SEAF_LIBRARY_PASSWORD__  
-Password protected librairies can be sync provided with the _password_.
-
-__SEAF_UPLOAD_LIMIT__, __SEAF_DOWNLOAD_LIMIT__  
-Upload and download speeds are configurable as _absolute bytes_.
-
-__SEAF_SKIP_SSL_CERT__  
-Skip SSL certificates verifications. _Any string is considered true, omit the variable to set to false_. Enable this if you have synchronization failures regarding SSL certificates.
-
-__UID__, __GID__  
-Override the _UID_ and _GID_ for volume read/write permissions.
-
-# Examples
-## As a Docker command 
-```
+### Docker command-line
+The following command start the Seafile client with one library:
+```bash
 docker run \ 
-    -e SEAF_SERVER_URL=https://seafile.example/ \
-    -e SEAF_USERNAME=a_seafile_user \
-    -e SEAF_PASSWORD=SoMePaSSWoRD \
-    -e SEAF_LIBRARY_UUID=an-hexadecimal-library-uuid \
-    -v path/to/shared/volume:/library \
+    -e SEAF_SERVER_URL="https://seafile.example/" \
+    -e SEAF_USERNAME="a_seafile_user" \
+    -e SEAF_PASSWORD="SoMePaSSWoRD" \
+    -e SEAF_LIBRARY="an-hexadecimal-library-uuid" \
+    -v path/to/library:/library \
+    -v path/to/client/data:/seafile \
    flowgunso/seafile-client:latest
 ```
-## As a Docker Compose
+
+### Docker Compose
+The following Docker Compose start a Seafile client with two libraries, with one password protected:
 ```yaml
+version: "3"
+
 services:

  seafile-client:
    image: flowgunso/seafile-client:latest
    volumes:
-      - shared_volume:/library
+      - audio:/library/audio
+      - documents:/library/documents
+      - client:/seafile
    environment:
      SEAF_SERVER_URL: "https://seafile.example/"
      SEAF_USERNAME: "a_seafile_user"
      SEAF_PASSWORD: "SoMePaSSWoRD"
-      SEAF_LIBRARY_UUID: "an-hexadecimal-library-uuid"
+      SEAF_LIBRARY_AUDIO: "audio-library-uuid"
+      SEAF_LIBRARY_AUDIO_PASSWORD: "auDioLiBRaRyPaSSWoRD"
+      SEAF_LIBRARY_DOCUMENTS: "documents-library-uuid"

 volumes:
-  shared_volume:
+  audio:
+  documents:
+  client:
 ```
-## With all optional configurations
-```yaml
+
+## Librairies
+Environment variables allows librairies configuration, as shown in the examples above.
+
+You can configure either a single librairy or multiple librairies.
+
+### Single library
+To synchronize a single library, use the environment variables `SEAF_LIBRARY` and `SEAF_LIBRARY_PASSWORD`. The library will be synchronized in _/library_.
+
+### Multiple librairies
+To synchronise multiple librairies, use the same environment variable as above but suffixed with a single identifier word. That word will be used for the library password and it's synchronization path as well.
+
+Hence, to synchronise a library identified as **audio**, the environment variables would be `SEAF_LIBRARY_AUDIO` for the library UUID and `SEAF_LIBRARY_AUDIO_PASSWORD` for the library password. The library will be then synchronized in _/library/audio_.
+
+Identifiers allows to add as many libraries as possible. Identifier are single word only.
+
+## Environment variables
+Environment variable allows you to configure the Seafile client.
+
+### `SEAF_SERVER_URL`
+> This variable is mandatory.
+
+The Seafile server URL.
+
+### `SEAF_USERNAME`
+> This variable is mandatory.
+
+The username for the Seafile account.
+
+### `SEAF_PASSWORD`
+> This variable is mandatory.
+
+The password for the Seafile account.
+
+### `SEAF_LIBRARY`, `SEAF_LIBRARY_[IDENTIFIER]`
+> This variable is mandatory.
+
+The UUID of the library, libraries to synchronize.
+Replace `[IDENTIFIER]` with the a unique single word identifier for each library you want to synchronize.
+
+### `SEAF_LIBRARY_PASSWORD`, `SEAF_LIBRARY_[IDENTIFIER]_PASSWORD`
+The password of the library, libraries to synchronize.
+Replace `[IDENTIFIER]` with the a unique single word identifier for each library you want to synchronize corresponding to the `SEAF_LIBRARY_[IDENTIFIER]`.
+
+### `SEAF_2FA_SECRET`
+_Two factor authentication is supported but your secret key must be provided._ That key can be found on your Seafile web interface, only at the 2FA setup, when the QR code is shown. The secret key is embedded in the QR or available as a cookie.
+
+### `SEAF_UPLOAD_LIMIT`, `SEAF_DOWNLOAD_LIMIT`
+Set upload and download speeds limits. Limits are in bytes.
+
+### `SEAF_SKIP_SSL_CERT`  
+Skip SSL certificates verifications.
+
+> Any string is considered true, omit the variable to set to false. Enable this if you have synchronization failures regarding SSL certificates.
+
+### `UID`, `GID`  
+Override the _UID_ and _GID_ for user running the Seafile client, hence the volume ownership.
+
+## Docker Secrets
+All environments variable supports Docker Secrets, as environment variable variant suffixed with `_FILE` as files.
+
+## Full example
+```bash
+version: "3"
+
 services:

  seafile-client:
    image: flowgunso/seafile-client:latest
    volumes:
-      - shared_volume:/library
+      - audio:/library/audio
+      - documents:/library/documents
+      - client:/seafile
    environment:
      SEAF_SERVER_URL: "https://seafile.example/"
      SEAF_USERNAME: "a_seafile_user"
      SEAF_PASSWORD: "SoMePaSSWoRD"
-      SEAF_LIBRARY_UUID: "an-hexadecimal-library-uuid"
+      SEAF_LIBRARY_AUDIO: "audio-library-uuid"
+      SEAF_LIBRARY_AUDIO_PASSWORD: "auDioLiBRaRyPaSSWoRD"
+      SEAF_LIBRARY_DOCUMENTS: "documents-library-uuid"
      SEAF_2FA_SECRET: "JBSWY3DPEHPK3PXPIXDAUMXEDOXIUCDXWC32CS"
-      SEAF_LIBRARY_PASSWORD: "LiBRaRyPaSSWoRD"
      SEAF_UPLOAD_LIMIT: "1000000"
      SEAF_DOWNLOAD_LIMIT: "1000000"
      SEAF_SKIP_SSL_CERT: "true"
@@ -93,6 +155,11 @@ services:
      GID: "1000"

 volumes:
-  shared_volume:
+  audio:
+  documents:
+  client:
 ```
-Or use the [docker-compose.yml](documentations/docker-compose.yml) template.
+
+# Troubleshooting
+* Ask questions on [Seafile forum](https://forum.seafile.com/t/docker-client-to-sync-files-with-containers/8573).
+* Contribute and report issues on [Gitlab](https://gitlab.com/flwgns-docker/seafile-client/).