Adding a Replica¶

To add a new replica, configure a new, empty replica identically to the existing replica, and run `task sync`.

When to Synchronize¶

Taskwarrior can perform a sync operation at every garbage collection (gc) run. This is the default, and is appropriate for local synchronization.

For synchronization to a server, a better solution is to run

$ task sync

periodically, such as via cron(8).

Sync Server¶

To synchronize your tasks to a sync server, you will need the following information from the server administrator:

- The server's URL ("origin", such as "https://tw.example.com")
- A client ID ("client_id") identifying your tasks

Configure Taskwarrior with these details:

$ task config sync.server.origin <origin>
$ task config sync.server.client_id <client_id>

Note that the origin must include the scheme, such as 'http://' or 'https://'.

Google Cloud Platform¶

To synchronize your tasks to GCP, use the GCP Console to create a new project, and within that project a new Cloud Storage bucket. The default settings for the bucket are adequate.

Authenticate to the project with:

$ gcloud config set project $PROJECT_NAME
$ gcloud auth application-default login

Then configure Taskwarrior with:

$ task config sync.gcp.bucket <bucket-name>

However you can bring your own service account credentials if your `application-default` is already being used by some other application

To begin, navigate to the "IAM and Admin" section in the Navigation Menu, then select "Roles."

On the top menu bar within the "Roles" section, click "CREATE ROLE." Provide an appropriate name and description for the new role.

Add permissions to your new role using the filter "Service:storage" (not the "Filter permissions by role" input box). Select the following permissions:

- storage.buckets.create
- storage.buckets.get
- storage.buckets.update
- storage.objects.create
- storage.objects.get
- storage.objects.list
- storage.objects.update

Create your new role.

On the left sidebar, navigate to "Service accounts."

On the top menu bar within the "Service accounts" section, click "CREATE SERVICE ACCOUNT."
Provide an appropriate name and description for the new service account.
Select the role you just created and complete the service account creation process.

Now, in the Service Account dashboard, click into the new service account and select "keys" on the top menu bar.
Click on "ADD KEY" to create and download a new key (a JSON key).

Then configure Taskwarrior with:

$ task config sync.gcp.bucket <bucket-name>
$ task config sync.gcp.credential_path <absolute-path-to-downloaded-credentials>

Local Synchronization¶

In order to take advantage of synchronization's side effect of saving disk space without setting up a remote server, it is possible to sync tasks locally. To configure local sync:

$ task config sync.local.server_dir /path/to/sync

The default configuration is to sync to a database in the task directory ("data.location").

Adding a New User¶

To add a new user to the server, invent a new client ID with a tool like `uuidgen` or an online UUID generator. There is no need to configure the server for this new client ID: the sync server will automatically create a new user whenever presented with a new client ID. Supply the ID, along with the origin, to the user for inclusion in their Taskwarrior config. The user should invent their own "encryption_secret".