Skip to content

Commit

Permalink
Add a few precisions to the readme (closes #5)
Browse files Browse the repository at this point in the history
  • Loading branch information
christophetd committed Apr 23, 2018
1 parent e65c43b commit 188fb95
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The following environment variables can be used to configure the backup strategy

- `BACKUP_NAME`: The name of your backup (should be unique, e.g. `prod-db-backups`)
- `BACKUP_ENCRYPTION_KEY`: An optional passphrase to encrypt your backups with before they are stored remotely.
- `BACKUP_SCHEDULE`: Cron-like string to define the frequency at which backups should be made (e.g. `0 2 * * *` for `Every day at 2am`)
- `BACKUP_SCHEDULE`: Cron-like string to define the frequency at which backups should be made (e.g. `0 2 * * *` for `Every day at 2am`). Note that this string should be indicated in the UTC timezone.
- `BACKUP_LOCATION`: [Duplicacy URI](https://github.com/gilbertchen/duplicacy/wiki/Storage-Backends) of where to store the backups.
- S3: `s3://[email protected]/bucket/path/to/storage`
- Backblaze B2: `b2://my-bucket/`
Expand Down Expand Up @@ -117,12 +117,12 @@ Backups are useless if you don't make sure they work. This shows the procedure t

More: see [Duplicacy's documentation](https://github.com/gilbertchen/duplicacy/wiki).

## Advanced options
## Other options

Use the following environment variables if you want to customize duplicacy's behavior.

- `DUPLICACY_INIT_OPTIONS`: options passed to `duplicacy init` the first time a backup is made. By default, `-encrypt` if `BACKUP_ENCRYPTION_KEY` is not empty.
- `DUPLICACY_BACKUP_OPTIONS`: options passed to `duplicacy backup` when a backup is performed. By default: `-threads 4 -stats`
- `DUPLICACY_BACKUP_OPTIONS`: options passed to `duplicacy backup` when a backup is performed. By default: `-threads 4 -stats`. **If you are backing up a hard drive (and not a SSD), it is recommended to use `-threads 1 -stats` instead** (see [here](https://duplicacy.com/issue?id=5670666258874368) for more details).

## Disclaimer

Expand Down

0 comments on commit 188fb95

Please sign in to comment.