bp99/taskchampion-sync-server
1
0
Fork 0
forked from github-mirrorer/taskchampion-sync-server
Code Pull Requests Actions Activity
Files
90a73ea7bd3a28c8cc62fc8aa946fb6ce94277a1
taskchampion-sync-server/docs/src/usage/docker-images.md
Dustin J. Mitchell ab6df362bf Finish building Postgres support (#133) 
This includes:
 - Building a Docker image for Postgres as well as SQLite
 - Fuller instructions for usage of the package, including the Postgres builds.

A few related things changed here:
 - `.env` is not used anymore -- the defaults in the Dockerfiles are
   sufficient
 - The Rust version in the Dockerfiles is increased to match the MSRV,
   and with it the Alpine version bumped to one built with that Rust
   version.
 - Cargo dependencies on native-tls and openssl updated to include only
   the `vendored` feature, so as not to require a system openssl
   installation.
 - Two GitHub jobs are set up, to build the two different Docker images
 - The documentation incorrectly suggested using `DELETE .. CASCADE` to
   delete clients. This syntax does not exist, as the cascading delete
   is configured in the schema.
2025-07-29 21:52:33 -04:00

2.3 KiB
Raw Blame History

Docker Images

Every release of the server generates Docker images. One image is produced for each storage backend:

  • ghcr.io/gothenburgbitfactory/taskchampion-sync-server (SQLite)
  • ghcr.io/gothenburgbitfactory/taskchampion-sync-server-postgres (Postgres)

The image tags include latest for the latest release, and both minor and patch versions, e.g., 0.5 and 0.5.1.

Running the Image

At startup, each image applies some default values and runs the relevant binary directly. Configuration is typically by environment variables, all of which are documented in the --help output of the binaries. These include

  • RUST_LOG - log level, one of trace, debug, info, warn and error.
  • DATA_DIR (SQLite only; default /var/lib/taskchampion-sync-server/data) - directory for the synced data.
  • CONNECTION (Postgres only) - Postgres connection information, in the form of a LibPQ-style connection URI.
  • LISTEN (default 0.0.0.0:8080) - address and port on which to listen for HTTP requests.
  • CLIENT_ID - comma-separated list of client IDs that will be allowed, or empty to allow all clients.
  • CREATE_CLIENTS (default true) - if true, automatically create clients on first sync. If this is set to false, it is up to you to initialize clients in the DB.

Example

docker run -d \
  --name=taskchampion-sync-server \
  -p 8080:8080 \
  -e RUST_LOG=debug \
  -v /data/taskchampion-sync-server:/var/lib/taskchampion-sync-server/data \
  taskchampion-sync-server

Image-Specific Setup

The SQLite image is configured with VOLUME /var/lib/taskchampion-sync-server/data, persisting the task data in an anonymous Docker volume. It is recommended to put this on a named volume, or persistent storage in an environment like Kubernetes, so that it is not accidentally deleted.

The Postgres image does not automatically create its database schema. See the integration section for more detail. This implementation is tested with Postgres version 17 but should work with any recent version.

Note that the Docker images do not implement TLS. The expectation is that another component, such as a Kubernetes ingress, will terminate the TLS connection and proxy HTTP traffic to the taskchampion-sync-server container.