Skip to content

Syncing

doczi-dominik edited this page Feb 24, 2021 · 2 revisions

tx features a simple system for keeping tasklists up-to-date amongst multiple tx clients. Syncing is achieved using two components:

  • Sync service: An HTTP server responsible for storage and communication with tx.
  • Sync ID: A unique ID that the Sync service generates that can be used for identifying a particular tasklist.

Tasklists are loaded from a Sync service if it is:

  • Configured to do so
  • Has a valid Sync service and Sync ID
  • The tasklist is not outdated (The local taskfile was not modified without Syncing)

Implementing a Sync service

To implement your own Sync service, create a HTTP server which mimics the JSON Blob API. You can then either pass your server's URL to --fallback-sync-url, use tx sync enable -u for a new tasklist or tx sync switch for an existing tasklist.