add page about borg compact to free archive disk space

This commit is contained in:
Lance Edgar 2025-12-14 13:21:22 -06:00
parent b2e2d2a6d0
commit b496692885
3 changed files with 17 additions and 0 deletions

15
docs/backup/compact.rst Normal file
View file

@ -0,0 +1,15 @@
============================
Freeing Archive Disk Space
============================
Periodically to free disk space used by Borg archive storage, run the
``borg compact`` command with your repo URL:
.. code-block:: sh
sudo borg compact --progress --verbose borg@cloud.example.com:/path/to/borg-repos/myserver
The first time you do so, specify ``--cleanup-commits`` to ensure legacy cruft is removed.
For more info see :doc:`borg:usage/compact`.

View file

@ -24,3 +24,4 @@ existing Rattail app in charge of backups.
running
features/index
restore
compact

View file

@ -39,6 +39,7 @@ extensions = [
intersphinx_mapping = {
'alembic': ('https://alembic.sqlalchemy.org/en/latest/', None),
'borg': ('https://borgbackup.readthedocs.io/en/stable/', None),
'rattail': ('https://docs.wuttaproject.org/rattail/', None),
'tailbone': ('https://docs.wuttaproject.org/tailbone/', None),
'wuttjamaican': ('https://docs.wuttaproject.org/wuttjamaican/', None),