Configuration Reference
Every configurable field, documented.
Backup Source Configuration
Fields available when creating or updating a backup source.
| Field | Type | Description |
|---|---|---|
| path | string | Absolute path to the source directory |
| name | string | Human-readable display name |
| group | string | Optional group label for organization |
| enabled | bool | Whether this source is active |
| schedule | string | Schedule type: manual / hourly / daily / weekly / monthly |
| retention | string | Retention policy: keep_all / smart / custom |
| excludes | []string | Glob patterns for files to exclude |
| watch_mode | string | File watch mode: auto / poll / disabled |
| compression_type | string | Compression algorithm: none / zstd / s2 / deflate |
| compression_level | int | Compression level (algorithm-dependent) |
| repo_paths | []string | List of repository paths to back up to |
Repository Configuration
Fields available when creating or updating a repository.
| Field | Type | Description |
|---|---|---|
| path | string | Local path for the repository |
| display_name | string | Human-readable display name |
| type | string | Storage type: local / s3 / webdav |
| encryption | string | Encryption method |
| compression | string | Compression algorithm |
Schedule Types
Available scheduling options.
| Type | Description |
|---|---|
| manual | No automatic backup. You trigger manually. |
| hourly | Run once every hour. |
| daily | Run once per day at a specified time. |
| weekly | Run once per week on a specified day and time. |
| monthly | Run once per month on a specified day and time. |