cupcakearmy/autorestic
1
0
Fork 0
mirror of https://github.com/cupcakearmy/autorestic.git synced 2024-12-22 08:16:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc(lock): add lockfile doc with customization explanation

Browse Source
This commit is contained in:
Boris Bera 2024-12-01 14:43:29 -05:00
parent c9a1474297
commit de0862a3dd
No known key found for this signature in database
GPG Key ID: 97AF3BB8EEBDF180
3 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/pages/_meta.json
View File

@ -3,6 +3,7 @@
"quick": "Quick Start",
"installation": "Installation",
"config": "Configuration",
"lockfile": "Lockfile",
"location": "Locations",
"backend": "Backend",
"cli": "CLI",

2
docs/pages/cli/general.md
View File

@ -37,7 +37,7 @@ autorestic --restic-bin /some/path/to/my/custom/restic/binary
## `--lockfile-path`
Specify the path for the lockfile used by `autorestic`. If omitted, this will default to `.autorestic.lock.yml` next to the loaded config file.
Specify the path for the [lockfile](../lockfile.md) used by `autorestic`. If omitted, this will default to `.autorestic.lock.yml` next to the loaded config file.
```bash
autorestic --lockfile-path /path/to/my/.autorestic.lock.yml

14
docs/pages/lockfile.md Normal file
View File

@ -0,0 +1,14 @@
# Lockfile
Under the hood, `autorestic` uses a lockfile to ensure that only one instance is running and to keep track of when [cronjobs](./location/cron.md) were last run.
By default, the lockfile is stored next to your [configuration file](./config.md) as `.autorestic.lock.yml`. In other words, if your config file is located at `/some/path/.autorestic.yml`, then the lockfile will be located at `/some/path/.autorestic.lock.yml`.
## Customization
The path to the lockfile can be customized if need be. This can be done is a few ways:
1. Using the `--lockfile-path ...` command line flag
1. Setting `lockfile: ...` in the configuration file
Note that `autorestic` will check for a customized lockfile path in the order listed above. This means that if you specify a lockfile path in multiple places, the method that's higher in the list will win.