docs: bring README.md in line with Standard Readme
This commit is contained in:
parent
26cc8c3b18
commit
bc64f86595
1 changed files with 25 additions and 1 deletions
26
README.md
26
README.md
|
|
@ -1,6 +1,8 @@
|
||||||
# verae-backup
|
# verae-backup
|
||||||
|
|
||||||
Snapshot and restore **zappier SQLite**, staff IAM data, keep state, fleet-runtime (worm/tree blobs), and JetStream store if present.
|
[](https://github.com/RichardLitt/standard-readme)
|
||||||
|
|
||||||
|
Snapshot and restore **zappier SQLite**, staff IAM data, keep state, fleet-runtime (worm/tree blobs), and JetStream...
|
||||||
|
|
||||||
**Forgejo:** https://git.georgelambert.org/marchon/verae-backup
|
**Forgejo:** https://git.georgelambert.org/marchon/verae-backup
|
||||||
**SSH:** `ssh://git@git.georgelambert.org:2223/marchon/verae-backup.git`
|
**SSH:** `ssh://git@git.georgelambert.org:2223/marchon/verae-backup.git`
|
||||||
|
|
@ -21,3 +23,25 @@ User timer: `systemd/verae-backup.timer` (03:17 UTC). Enable with linger.
|
||||||
Does **not** back up private keys. Restore identityFile **paths** on the operator host by hand.
|
Does **not** back up private keys. Restore identityFile **paths** on the operator host by hand.
|
||||||
|
|
||||||
Does **not** connect to NATS; it copies the JetStream directory if `NATS_STORE` exists.
|
Does **not** connect to NATS; it copies the JetStream directory if `NATS_STORE` exists.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone ssh://git@git.georgelambert.org:2223/marchon/verae-backup.git
|
||||||
|
cd verae-backup
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# No single entrypoint is declared in this tree.
|
||||||
|
ls
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Questions: open an issue at https://git.georgelambert.org/marchon/verae-backup/issues. Pull requests are accepted.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
UNLICENSED © George Lambert
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue