config.md

• Overview

• Log config

• Database config

  • Replicate Config
    • Azure blob Params
    • File System Params
    • Ftp Params
    • Gcs Params
    • S3 Params

Overview

replited use toml as its config file format, the structure of config is:

• Log config;
• One or more database configs:
  • sqlite database file path;
  • one or more database replicate backend.

See config sample in sample.toml

Log Config

item	value
level	Trace/Debug/Info/Warn/Error
dir	log files directory

Database Config

item	value
db	sqlite database file path
replicate	one or more database replicate backend

Replicate Config

item	value
name	replicate backend config name, cannot duplicate
params	params of backend, see below

Azure blob Params

item	value
params.type	"Azb"
params.root	root of Azblob service backend.
params.container	container name of Azblob service backend.
params.endpoint	endpoint of Azblob service backend.
params.account_name	account name of Azblob service backend.
params.account_key	account key of Azblob service backend.

File System Params

item	value
params.type	"Fs"
params.root	root directory of file system backend

Ftp Params

item	value
params.type	"Ftp"
params.endpoint	Endpoint of this ftp, use "ftps://127.0.0.1" by default.
params.root	root directory of file system backend, use "/" by default.
params.user	user of ftp backend.
params.password	password of ftp backend.

Gcs Params

item	value
params.type	"Gcs"
params.endpoint	Endpoint of this backend, must be full uri, use "https://storage.googleapis.com" by default.
params.root	Root URI of gcs operations.
params.bucket	Bucket name of this backend.
params.credential	Credentials string for GCS service OAuth2 authentication.

S3 Params

item	value
params.type	"S3"
params.endpoint	Endpoint of this backend, must be full uri, use "https://s3.amazonaws.com" by default.
params.region	Region represent the signing region of this endpoint.If region is empty, use env value AWS_REGION if it is set, or else use us-east-1 by default.
params.bucket	Bucket name of this backend.
params.access_key_id	access_key_id of this backend.
params.secret_access_key	secret_access_key of this backend.
params.root	root of this backend.