Repository files navigation

TaskChampion is the task databaseTaskwarrior uses to store and synctasks. This repository implements a sync server against which Taskwarriorand other applications embedding TaskChampion can sync.

This project provides both pre-built images for common use-cases and Rustlibraries that can be used to build more sophisticated applications. Seethe documentationfor more on how to use this project.

The repository is comprised of four crates:

• taskchampion-sync-server-core implements the core of the protocol
• taskchampion-sync-server-storage-sqlite implements an SQLite backend for the core
• taskchampion-sync-server-storage-postgres implements a Postgres backend for the core
• taskchampion-sync-server implements a simple HTTP server for the protocol

TaskChampion Sync-Server build has been tested with current Rust stablerelease version. You can install Rust from your distribution package or userustup.

rustup default stable

The minimum supported Rust version (MSRV) is given inCargo.toml. Note that package repositories typically do nothave sufficiently new versions of Rust.

If you prefer, you can use the stable version only for installing TaskChampionSync-Server (you must clone the repository first).

rustup overrideset stable

To build TaskChampion Sync-Server binary simply execute the followingcommands.

git clone https://github.com/GothenburgBitFactory/taskchampion-sync-server.gitcd taskchampion-sync-servercargo build --release

After build the binary is located intarget/release/taskchampion-sync-server.

The storage backend is controlled by Cargo featurespostres andsqlite.By default, only thesqlite feature is enabled.To enable building the Postgres backend, add--features postgres.The Postgres binary is located intarget/release/taskchampion-sync-server-postgres.

To build the images, execute the following commands.

SQLite:

docker build \  -t taskchampion-sync-server \  -f Dockerfile-sqlite

Postgres:

source .envdocker build \  -t taskchampion-sync-server-postgres \  -f Dockerfile-postgres

Now to run it, simply exec.

docker run -t -d \  --name=taskchampion \  -p 8080:8080 \  taskchampion-sync-server

This starts TaskChampion Sync-Server and publishes port 8080 to the host. Pleasenote that this is a basic run, all data will be destroyed after stop anddelete container. You may also setDATA_DIR,CLIENT_ID, orLISTEN with-e, e.g.,

docker run -t -d \  --name=taskchampion \  -e LISTEN=0.0.0.0:9000 \  -p 9000:9000 \  taskchampion-sync-server