Skip to content

update docs and examples to match API #444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 4, 2025
Merged

update docs and examples to match API #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 36 additions & 36 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,55 +125,55 @@ For local configuration, the `spec` is composed of the following. See the [Confi
for details of each.

* `dump`: the dump configuration
* `include`: list of tables to include
* `exclude`: list of tables to exclude
* `safechars`: safe characters in filename
* `noDatabaseName`: remove `USE <database>` from dumpfile
* `exclude`: strings, list of tables to exclude
* `include`: strings, list of tables to include
* `safechars`: boolean, enable safe characters in filename
* `noDatabaseName`: boolean, remove `USE <database>` from dumpfile
* `schedule`: the schedule configuration
* `frequency`: the frequency of the schedule
* `begin`: the time to begin the schedule
* `cron`: the cron schedule
* `once`: run once and exit
* `compression`: the compression to use
* `compact`: compact the dump
* `triggersAndFunctions`: include triggers and functions and procedures in the dump
* `maxAllowedPacket`: max packet size
* `filenamePattern`: the filename pattern
* `frequency`: int, the frequency of the schedule in minutes
* `begin`: int, the time to begin the schedule in minutes from start of process
* `cron`: string, the cron schedule
* `once`: boolean, run once and exit
* `compression`: string, the compression to use
* `compact`: boolean, compact the dump
* `triggersAndFunctions`: boolean, include triggers and functions and procedures in the dump
* `maxAllowedPacket`: int, max packet size
* `filenamePattern`: string, the filename pattern
* `scripts`:
* `preBackup`: path to directory with pre-backup scripts
* `postBackup`: path to directory with post-backup scripts
* `targets`: list of names of known targets, defined in the `targets` section, where to save the backup
* `preBackup`: string, path to directory with pre-backup scripts
* `postBackup`: string, path to directory with post-backup scripts
* `targets`: strings, list of names of known targets, defined in the `targets` section, where to save the backup
* `restore`: the restore configuration
* `scripts`:
* `preRestore`: path to directory with pre-restore scripts
* `postRestore`: path to directory with post-restore scripts
* `preRestore`: string, path to directory with pre-restore scripts
* `postRestore`: string, path to directory with post-restore scripts
* `database`: the database configuration
* `server`: host:port
* `server`: string, host:port
* `port`: port (deprecated)
* `credentials`: access credentials for the database
* `username`: user
* `password`: password
* `username`: string, user
* `password`: string, password
* `prune`: the prune configuration
* `retention`: retention policy
* `retention`: string, retention policy
* `targets`: target configurations, each of which can be reference by other sections. Key is the name of the target that is referenced elsewhere. Each one has the following structure:
* `type`: the type of target, one of: file, s3, smb
* `url`: the URL of the target
* `type`: string, the type of target, one of: file, s3, smb
* `url`: string, the URL of the target
* `spec`: access details for the target, depends on target type:
* Type s3:
* `region`: the region
* `endpoint`: the endpoint
* `pathStyle` (boolean): use path-style bucket addressing instead of virtual-host style bucket addressing, see [AWS docs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html)
* `accessKeyID`: the access key ID
* `secretAccessKey`: the secret access key
* `region`: string, the region
* `endpoint`: string, the endpoint
* `pathStyle` boolean, use path-style bucket addressing instead of virtual-host style bucket addressing, see [AWS docs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html)
* `accessKeyID`: string, the access key ID
* `secretAccessKey`: string, the secret access key
* Type smb:
* `domain`: the domain
* `username`: the username
* `password`: the password
* `logging`: the log level, one of: error,warning,info,debug,trace; default is info
* `domain`: string, the domain
* `username`: string, the username
* `password`: string, the password
* `logging`: string, the log level, one of: error,warning,info,debug,trace; default is info
* `telemetry`: configuration for sending telemetry data (optional)
* `url`: URL to telemetry service
* `certificate`: the certificate for the telemetry server or a CA that signed the server's TLS certificate. Not required if telemetry server does not use TLS, or if the system's certificate store already contains the server's cert or CA.
* `credentials`: unique token provided by the remote service as credentials, base64-encoded
* `url`: string, URL to telemetry service
* `certificate`: string, the certificate for the telemetry server or a CA that signed the server's TLS certificate. Not required if telemetry server does not use TLS, or if the system's certificate store already contains the server's cert or CA.
* `credentials`: string, unique token provided by the remote service as credentials, base64-encoded

#### Remote Configuration

Expand Down
12 changes: 8 additions & 4 deletions docs/scheduling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ You can set it to run just once via:
* Config file:
```yaml
dump:
run-once: true
schedule:
once: true
```

If you set it to run just once, the backup will run once and then exit.
Expand All @@ -49,7 +50,8 @@ You can set a cron schedule via:
* Config file:
```yaml
dump:
cron: 0 * * * *
schedule:
cron: 0 * * * *
```

The cron dump schedule option uses standard [crontab syntax](https://en.wikipedia.org/wiki/Cron), a
Expand All @@ -71,7 +73,8 @@ You can set the frequency start via:
* Config file:
```yaml
dump:
frequency: 60
schedule:
frequency: 60
```

You can set the delayed start via:
Expand All @@ -81,5 +84,6 @@ You can set the delayed start via:
* Config file:
```yaml
dump:
delay: 120
schedule:
delay: 120
```
4 changes: 2 additions & 2 deletions examples/configs/local.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ spec:
s3:
type: s3
url: s3://bucket.us-west.amazonaws.com/databackup
details:
spec:
region: us-west-1
endpoint: https://s3.us-west-1.amazonaws.com
accessKeyId: access_key_id
Expand All @@ -72,7 +72,7 @@ spec:
smbshare:
type: smb
url: smb://cifshost:2125/databackup
details:
spec:
domain: mydomain
username: user
password: password
8 changes: 4 additions & 4 deletions examples/configs/telemetry.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ spec:
s3:
type: s3
url: s3://bucket.us-west.amazonaws.com/databackup
region: us-west-1
endpoint: https://s3.us-west-1.amazonaws.com
credentials:
spec:
region: us-west-1
endpoint: https://s3.us-west-1.amazonaws.com
accessKeyId: access_key_id
secretAccessKey: secret_access_key
file:
Expand All @@ -86,7 +86,7 @@ spec:
smbshare:
type: smb
url: smb://cifshost:2125/databackup
credentials:
spec:
domain: mydomain
username: user
password: password
Loading