Enum taskchampion::server::ServerConfig

pub enum ServerConfig {
    Local {
        server_dir: PathBuf,
    },
    Remote {
        origin: String,
        client_id: Uuid,
        encryption_secret: Vec<u8>,
    },
    Gcp {
        bucket: String,
        credential_path: Option<String>,
        encryption_secret: Vec<u8>,
    },
}

The configuration for a replica’s access to a sync server.

Variants

Local

A local task database, for situations with a single replica.

Fields

server_dir: PathBuf

Path containing the server’s DB

Remote

A remote taskchampion-sync-server instance

Fields

origin: String

Sync server “origin”; a URL with schema and hostname but no path or trailing /

client_id: Uuid

Client ID to identify and authenticate this replica to the server

encryption_secret: Vec<u8>

Private encryption secret used to encrypt all data sent to the server. This can be any suitably un-guessable string of bytes.

Gcp

A remote taskchampion-sync-server instance

Fields

bucket: String

Bucket in which to store the task data. This bucket must not be used for any other purpose.

credential_path: Option<String>

Path to a GCP credential file, in JSON format. This is required for GCP access incase some other application already makes use of Application Default Credentials. See https://cloud.google.com/docs/authentication#service-accounts for more details. See https://cloud.google.com/iam/docs/keys-create-delete for instructions on how to create a service account key.

encryption_secret: Vec<u8>

Private encryption secret used to encrypt all data sent to the server. This can be any suitably un-guessable string of bytes.

Implementations

impl ServerConfig

pub fn into_server(self) -> Result<Box<dyn Server>, Error>

Get a server based on this configuration