mirror of
https://github.com/cupcakearmy/autorestic.git
synced 2024-12-22 16:26:25 +00:00
doc(lock): add lockfile doc with customization explanation
This commit is contained in:
parent
c9a1474297
commit
de0862a3dd
@ -3,6 +3,7 @@
|
|||||||
"quick": "Quick Start",
|
"quick": "Quick Start",
|
||||||
"installation": "Installation",
|
"installation": "Installation",
|
||||||
"config": "Configuration",
|
"config": "Configuration",
|
||||||
|
"lockfile": "Lockfile",
|
||||||
"location": "Locations",
|
"location": "Locations",
|
||||||
"backend": "Backend",
|
"backend": "Backend",
|
||||||
"cli": "CLI",
|
"cli": "CLI",
|
||||||
|
@ -37,7 +37,7 @@ autorestic --restic-bin /some/path/to/my/custom/restic/binary
|
|||||||
|
|
||||||
## `--lockfile-path`
|
## `--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
|
```bash
|
||||||
autorestic --lockfile-path /path/to/my/.autorestic.lock.yml
|
autorestic --lockfile-path /path/to/my/.autorestic.lock.yml
|
||||||
|
14
docs/pages/lockfile.md
Normal file
14
docs/pages/lockfile.md
Normal 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.
|
Loading…
Reference in New Issue
Block a user