Skip to content

docs(admin): document the cleanup of old file versions - #1222

Draft
pbleser-oc wants to merge 1 commit into
opencloud-eu:mainfrom
pbleser-oc:feat/1419-revisions-cleanup
Draft

pbleser-oc wants to merge 1 commit into
opencloud-eu:mainfrom
pbleser-oc:feat/1419-revisions-cleanup

Conversation

@pbleser-oc

Copy link
Copy Markdown
Member

Documents the cleanup of old file versions for administrators: opencloud-eu/opencloud#1419, implemented in opencloud-eu/reva#895 and opencloud-eu/opencloud#3778.

Draft until opencloud-eu/opencloud#3778 is merged, as it documents its configuration and its command.

What's new

  • A new page, "Cleaning Up Old Versions", in Admin → Configuration → Storage (docs/admin/configuration/storage/revisions-cleanup.md):
    • what the cleanup does, and when it runs (uploads, restores, changes on disk with PosixFS);
    • how to turn it on, with OpenCloud Compose (a compose file of one's own added to COMPOSE_FILE, so that the setting survives updates) and with other installations;
    • the strategies, explained one by one with the same example file throughout, so that the effect of each one can be compared: a number of versions, a duration, counting from midnight, auto, and their combinations, with an overview table and suggestions for common needs;
    • how the age of a version is measured, with an example of a document that was left alone for two months;
    • trying out a strategy with a dry run, the background workers, and the logs.
  • The command to clean up versions on demand, opencloud storage-users revisions cleanup, in Admin → Maintenance → Maintenance Commands: when to use it, a dry run first, selecting the files, choosing the strategy, reading the output, a nightly cron job with a timeout, the exit codes, and how it differs from the older opencloud revisions purge.
  • Features and FAQ: the statements that every version can always be restored now say that versions are kept by default, and that administrators can have old ones deleted, with a link to the new page.

The environment variables (OC_REVISIONS_CLEANUP_*) and the storage-users README section reach the Dev section automatically with the next env var update, once opencloud-eu/opencloud#3778 is merged. The new page links to the generated environment variables page.

Checks

pnpm build --locale en passes, without broken links or anchors on these pages. prettier --check and markdownlint-cli2 pass for the changed files.

OpenCloud can now delete old file versions according to a cleanup
strategy (opencloud-eu/opencloud#1419, opencloud-eu/opencloud#3778).

- a new page, Cleaning Up Old Versions, in the storage configuration:
  what the cleanup does and when it runs, how to turn it on with
  OpenCloud Compose and other installations, the strategies explained
  with one example file throughout, how the age of a version is
  measured, how to try a strategy out, the background workers and the
  logs
- the command to clean up versions on demand, in the maintenance
  commands: a dry run first, selecting the files, choosing the
  strategy, the output, a nightly cron job with a timeout, the exit
  codes, and what to know when it runs while OpenCloud is running
  (versions in an open Versions panel, NATS for PosixFS)
- features and FAQ: versions are kept by default, administrators can
  have old ones deleted
@pbleser-oc
pbleser-oc force-pushed the feat/1419-revisions-cleanup branch from fe8d544 to c15af4f Compare October 25, 2026 01:18
@maki5 maki5 removed the status in OpenCloud Team Board Oct 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants