mirror of
https://github.com/GothenburgBitFactory/taskchampion-sync-server.git
synced 2026-04-05 17:20:35 +00:00
283 lines
14 KiB
HTML
283 lines
14 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="ayu sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>TaskChampion Sync Server</title>
|
|
<meta name="robots" content="noindex">
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="favicon.svg">
|
|
<link rel="shortcut icon" href="favicon.png">
|
|
<link rel="stylesheet" href="css/variables.css">
|
|
<link rel="stylesheet" href="css/general.css">
|
|
<link rel="stylesheet" href="css/chrome.css">
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" id="highlight-css" href="highlight.css">
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="tomorrow-night.css">
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
|
|
<!-- Provide site root and default themes to javascript -->
|
|
<script>
|
|
const path_to_root = "";
|
|
const default_light_theme = "ayu";
|
|
const default_dark_theme = "navy";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="body-container">
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
let theme = localStorage.getItem('mdbook-theme');
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
|
let theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
const html = document.documentElement;
|
|
html.classList.remove('ayu')
|
|
html.classList.add(theme);
|
|
html.classList.add("js");
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
let sidebar = null;
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<!-- populated by js -->
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
|
<noscript>
|
|
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
|
|
</noscript>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">TaskChampion Sync Server</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="introduction"><a class="header" href="#introduction">Introduction</a></h1>
|
|
<p>Taskchampion Sync-Server is an implementation of the TaskChampion <a href="https://gothenburgbitfactory.org/taskchampion/sync.html">sync
|
|
protocol</a> server. It supports synchronizing Taskwarrior tasks
|
|
between multiple systems.</p>
|
|
<p>The project provides both pre-built images for common use-cases (see
|
|
<a href="./usage.html">usage</a>) and Rust libraries that can be used to build more
|
|
sophisticated applications (<a href="./integration.html">integration</a>).</p>
|
|
<div style="break-before: page; page-break-before: always;"></div><h1 id="usage"><a class="header" href="#usage">Usage</a></h1>
|
|
<h2 id="running-the-server"><a class="header" href="#running-the-server">Running the Server</a></h2>
|
|
<p>The server is a simple binary that serves HTTP requests on a TCP port. The
|
|
server does not implement TLS; for public deployments, the recommendation is to
|
|
use a reverse proxy such as Nginx, haproxy, or Apache httpd.</p>
|
|
<h3 id="using-docker-compose"><a class="header" href="#using-docker-compose">Using Docker-Compose</a></h3>
|
|
<p>Every release of the server generates a Docker image in
|
|
<code>ghcr.io/gothenburgbitfactory/taskchampion-sync-server</code>. The tags include
|
|
<code>latest</code> for the latest release, and both minor and patch versions, e.g., <code>0.5</code>
|
|
and <code>0.5.1</code>.</p>
|
|
<p>The
|
|
<a href="https://raw.githubusercontent.com/GothenburgBitFactory/taskchampion-sync-server/refs/tags/v0.6.1/docker-compose.yml"><code>docker-compose.yml</code></a>
|
|
file in this repository is sufficient to run taskchampion-sync-server,
|
|
including setting up TLS certificates using Lets Encrypt, thanks to
|
|
<a href="https://caddyserver.com/">Caddy</a>.</p>
|
|
<p>You will need a server with ports 80 and 443 open to the Internet and with a
|
|
fixed, publicly-resolvable hostname. These ports must be available both to your
|
|
Taskwarrior clients and to the Lets Encrypt servers.</p>
|
|
<p>On that server, download <code>docker-compose.yml</code> from the link above (it is pinned
|
|
to the latest release) into the current directory. Then run</p>
|
|
<pre><code class="language-sh">TASKCHAMPION_SYNC_SERVER_HOSTNAME=taskwarrior.example.com \
|
|
TASKCHAMPION_SYNC_SERVER_CLIENT_ID=your-client-id \
|
|
docker compose up
|
|
</code></pre>
|
|
<p>The <code>TASKCHAMPION_SYNC_SERVER_CLIENT_ID</code> limits the server to the given client
|
|
ID; omit it to allow all client IDs.</p>
|
|
<p>It can take a few minutes to obtain the certificate; the caddy container will
|
|
log a message "certificate obtained successfully" when this is complete, or
|
|
error messages if the process fails. Once this process is complete, configure
|
|
your <code>.taskrc</code>'s to point to the server:</p>
|
|
<pre><code class="language-none">sync.server.url=https://taskwarrior.example.com
|
|
sync.server.client_id=your-client-id
|
|
sync.encryption_secret=your-encryption-secret
|
|
</code></pre>
|
|
<p>The docker-compose images store data in a docker volume named
|
|
<code>taskchampion-sync-server_data</code>. This volume contains all of the task data, as
|
|
well as the TLS certificate information. It will persist over restarts, in a
|
|
typical Docker installation. The docker containers will start automatically on
|
|
system startup. See the docker-compose documentation for more information.</p>
|
|
<h3 id="running-the-binary"><a class="header" href="#running-the-binary">Running the Binary</a></h3>
|
|
<p>The server is configured with command-line options. See
|
|
<code>taskchampion-sync-server --help</code> for full details.</p>
|
|
<p>The <code>--listen</code> option specifies the interface and port the server listens on.
|
|
It must contain an IP-Address or a DNS name and a port number. This option is
|
|
mandatory, but can be repeated to specify multiple interfaces or ports. This
|
|
value can be specified in environment variable <code>LISTEN</code>, as a comma-separated
|
|
list of values.</p>
|
|
<p>The <code>--data-dir</code> option specifies where the server should store its data. This
|
|
value can be specified in the environment variable <code>DATA_DIR</code>.</p>
|
|
<p>By default, the server will allow all clients and create them in the database
|
|
on first contact. There are two ways to limit the clients the server will
|
|
interact with:</p>
|
|
<ul>
|
|
<li>
|
|
<p>To limit the accepted client IDs, specify them in the environment variable
|
|
<code>CLIENT_ID</code>, as a comma-separated list of UUIDs. Client IDs can be specified
|
|
with <code>--allow-client-id</code>, but this should not be used on shared systems, as
|
|
command line arguments are visible to all users on the system. This convenient
|
|
option is suitable for personal and small-scale deployments.</p>
|
|
</li>
|
|
<li>
|
|
<p>To disable the automatic creation of clients, use the <code>--no-create-clients</code>
|
|
flag or the <code>CREATE_CLIENTS=false</code> environment variable. You are now
|
|
responsible for creating clients in the database manually, so this option is
|
|
more suitable for large scale deployments.</p>
|
|
</li>
|
|
</ul>
|
|
<p>The server only logs errors by default. To add additional logging output, set
|
|
environment variable <code>RUST_LOG</code> to <code>info</code> to get a log message for every
|
|
request, or to <code>debug</code> to get more verbose debugging output.</p>
|
|
<div style="break-before: page; page-break-before: always;"></div><h1 id="integration"><a class="header" href="#integration">Integration</a></h1>
|
|
<p>TBD (pending Postgres support)</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="elasticlunr.min.js"></script>
|
|
<script src="mark.min.js"></script>
|
|
<script src="searcher.js"></script>
|
|
|
|
<script src="clipboard.min.js"></script>
|
|
<script src="highlight.js"></script>
|
|
<script src="book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
<script>
|
|
window.addEventListener('load', function() {
|
|
window.setTimeout(window.print, 100);
|
|
});
|
|
</script>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|