# TaskChampion Sync Server

TaskChampion Sync Server is the official sync backend for Taskwarrior 3.x and other TaskChampion-enabled applications, letting users sync encrypted task data across multiple devices while the server never sees plaintext. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/3373/taskchampion-sync-server

## Description

TaskChampion Sync Server is the official sync backend for Taskwarrior 3.x and other TaskChampion-enabled applications, letting users sync encrypted task data across multiple devices while the server never sees plaintext.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

75/100 (Good), based on 4 of 5 factors.
- Maintained: 100 (last commit 8 days ago)
- Popular: 46 (200 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Security check: 100 (no serious findings, CI, tests)

## Links

- Unraid: https://ca.unraid.net/apps/taskchampion-sync-server-0wrxsgr06ooe8f?q=taskchampion-sync-server
- Official website: https://gothenburgbitfactory.org/taskchampion-sync-server/
- GitHub: https://github.com/GothenburgBitFactory/taskchampion-sync-server

## Common questions

### How do I connect Taskwarrior 3.x to a local TaskChampion sync server?

Start the server with a data directory, such as -d ~/data/task/. In .taskrc set sync.server, set sync.client_id to a random UUID shared by synced clients, and also set origin and secret.

### How should I prevent unauthorized access to an internet-facing TaskChampion sync server?

Set one or more allowed client UUIDs before starting the container. The server has no built-in HTTP authentication, so put it behind a reverse proxy with HTTP Basic Auth.

### Can TaskChampion clients make changes while offline?

Yes, a replica can perform all operations locally without connecting to a sync server. It shares those operations with other replicas when it later connects.

### Do I need to manually create a user on the sync server for each new device?

No, Taskwarrior's docs say the sync server automatically creates a new user whenever it is presented with a new client ID.

---
Source: Our Local Host (https://ourlocalhost.com/app/3373/taskchampion-sync-server), the self-hosted and open-source app directory.
