From 064ea7f729837c5d0489103c9c4d5b61031ab299 Mon Sep 17 00:00:00 2001 From: Sebastian Riedel Date: Tue, 3 Sep 2024 21:54:57 +0200 Subject: [PATCH] Move maintenance section to documentation --- README.md | 7 ++----- docs/Maintenance.md | 14 ++++++++++++++ 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9efaa72ad..f6d11d9ed 100644 --- a/README.md +++ b/README.md @@ -76,9 +76,6 @@ There are currently two example implementations for a companion server applicati The `morbo` development web server will make the web application available under `http://127.0.0.1:3000`. And `script/cavil minion worker` will start the job queue for processing background jobs. -## Ongoing Maintenance +## Documentation -To keep your reports and checksums fresh even after new license patterns have been added or updated, we recommend -running `script/cavil rindex` in regular intervals (we do it every weekend). And to free up space you can run -`script/cavil cleanup` in regular intervals as well. It helps to organize reports into products to exclude them from -cleanup. +For more information see the included [documentation](/docs). diff --git a/docs/Maintenance.md b/docs/Maintenance.md index 29c0b147c..1aab616fe 100644 --- a/docs/Maintenance.md +++ b/docs/Maintenance.md @@ -23,3 +23,17 @@ names like `processing_pkg_$id`, and release them (simialr to how you would retr job. Not all failures will be as self explanatory as HTTP timeouts and might require more investigation. + +## Automated Maintenance + +Maintenance tasks that can be automated. + +### Weekly reindexing + +To keep your reports and checksums fresh even after new license patterns have been added or updated, we recommend +running `script/cavil rindex` in regular intervals (we do it every weekend). + +### Weekly cleanup + +To free up space you can run `script/cavil cleanup` in regular intervals. It helps to organize reports into products to +exclude them from cleanup.