Skip to content

Commit

Permalink
Move maintenance section to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kraih committed Sep 3, 2024
1 parent 814e276 commit 064ea7f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
14 changes: 14 additions & 0 deletions docs/Maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 064ea7f

Please sign in to comment.