summaryrefslogtreecommitdiff
path: root/example/borgmatic/config.yaml
diff options
context:
space:
mode:
authorLibravatar Daenney <daenney@users.noreply.github.com>2023-07-07 11:45:42 +0200
committerLibravatar GitHub <noreply@github.com>2023-07-07 11:45:42 +0200
commit9ff4c20374ae112c6e7a598d5888e51783038ffe (patch)
treec303a4468f124ea95afd20be22e3efc37cc2efa8 /example/borgmatic/config.yaml
parent[feature] Add media list command (#1943) (diff)
downloadgotosocial-9ff4c20374ae112c6e7a598d5888e51783038ffe.tar.xz
[docs] Rework backups a bit (#1942)
* [docs] Rework backups a bit This changes the existing backup documentation to: * Push a bit harder on people to perform backups, it's not really just a nice to have * Removes the language about migrating to/from GoToSocial and a different ActivityPub server since that's really not supported * Adds a section about using backup software and provides an example on how to do this using Borgmatic * [docs] Remove too much info in db section * [docs] Add docs on how to backup local media This adds documentation pointing people at the media list-local command in order to determine what media files they need to include as part of their backups. Provides a Python script that people can use to transform the media listing from the CLI into Borg patterns. It also includes a Borgmatic config.yaml in the repository so people can easily fetch it instead of copy-pasting from the docs. * [bugfix] Ensure we emit an absolute path prefix It works either way, as a pattern like data/files/<ID> would match a file on /data/files/<ID>. But it would potentially also match any path that happens to include data/files/<ID> but not rooted at the storage-local-base-path. * [docs] Add more links to media list CLI reference
Diffstat (limited to 'example/borgmatic/config.yaml')
-rw-r--r--example/borgmatic/config.yaml26
1 files changed, 26 insertions, 0 deletions
diff --git a/example/borgmatic/config.yaml b/example/borgmatic/config.yaml
new file mode 100644
index 000000000..8c0ab0355
--- /dev/null
+++ b/example/borgmatic/config.yaml
@@ -0,0 +1,26 @@
+location:
+ repositories:
+ - path: ssh://<find it in your provider control panel>
+ label: <anything but typically the provider, for example borgbase>
+ patterns_from:
+ - /etc/borgmatic/gotosocial_patterns
+
+storage:
+ compression: auto,zstd
+ archive_name_format: '{hostname}-{now:%Y-%m-%d-%H%M%S}'
+ retries: 5
+ retry_wait: 30
+
+retention:
+ keep_daily: 7
+ keep_weekly: 6
+ keep_monthly: 12
+
+hooks:
+ before_backup:
+ - /usr/bin/systemctl stop gotosocial
+ after_backup:
+ - /usr/bin/systemctl start gotosocial
+ sqlite_databases:
+ - name: gotosocial
+ path: /path/to/sqlite.db