Files
taskchampion-sync-server/docs/src/usage.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

23 lines
922 B
Markdown

# Usage
This repository is flexible and can be used in a number of ways, to suit your
needs.
- If you only need a place to sync your tasks, using cloud storage may be
cheaper and easier than running taskchampion-sync-server. See
[task-sync(5)](http://taskwarrior.org/docs/man/task-sync.5/) for details on
cloud storage.
- If you have a publicly accessible server, such as a VPS, you can use `docker
compose` to run taskchampion-sync-server as pre-built docker images. See
[Docker Compose](./usage/docker-compose.md).
- If you would like more control, such as to deploy taskchampion-sync-server
within an orchestration environment such as Kubernetes, you can deploy the
docker images directly. See [Docker Images](./usage/docker-images.md).
- For even more control, or to avoid the overhead of container images, you can
build and run the taskchampion-sync-server binary directly. See
[Binaries](./usage/binaries.md).