Enum ServerConfig

#[non_exhaustive]
pub enum ServerConfig {
    Local {
        server_dir: PathBuf,
    },
    Remote {
        url: String,
        client_id: Uuid,
        encryption_secret: Vec<u8>,
    },
    Gcp {
        bucket: String,
        credential_path: Option<String>,
        encryption_secret: Vec<u8>,
    },
    Aws {
        region: String,
        bucket: String,
        credentials: AwsCredentials,
        encryption_secret: Vec<u8>,
    },
}

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

This enum is non-exhaustive, as users should only be constructing required variants, not matching on it.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future 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

url: String

The base URL of the Sync server

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 Google Cloud Platform storage bucket.

Fields

bucket: String

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

No special bucket configuration is reqiured.

credential_path: Option<String>

Path to a GCP credential file, in JSON format.

If None, then Application Default Credentials are used. Typically these are associated with the user’s Google Cloud account.

If Some(path), then the path must be to a service account key. The service account must have a role with the following permissions:

• storage.buckets.create
• storage.buckets.get
• storage.buckets.update
• storage.objects.create
• storage.objects.get
• storage.objects.list
• storage.objects.update
• storage.objects.delete

See the following GCP resources for more information:

• https://cloud.google.com/docs/authentication#service-accounts
• https://cloud.google.com/iam/docs/keys-create-delete#creating

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.

Aws

An Amazon Web Services storage bucket.

Fields

region: String

Region in which the bucket is located.

bucket: String

Bucket in which to store the task data.

This bucket must not be used for any other purpose. No special bucket configuration is required.

credentials: AwsCredentials

Credential configuration for access to the bucket.

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