From 9a0e2a8b074d209b043b8d9e3d16f1ce4cdcab2d Mon Sep 17 00:00:00 2001 From: Sandro Santilli Date: Sun, 17 Dec 2017 15:37:34 +0100 Subject: [PATCH] Improve cron.archive_cleanup docs in cheat sheet and app.ini.sample (#3215) Include defaults in cheat sheet, for that section --- custom/conf/app.ini.sample | 4 ++++ docs/content/doc/advanced/config-cheat-sheet.en-us.md | 7 +++++++ 2 files changed, 11 insertions(+) diff --git a/custom/conf/app.ini.sample b/custom/conf/app.ini.sample index a5a0b19871..6a8ae48a91 100644 --- a/custom/conf/app.ini.sample +++ b/custom/conf/app.ini.sample @@ -493,7 +493,11 @@ SCHEDULE = @every 24h ; Clean up old repository archives [cron.archive_cleanup] +; Whether to enable the job +ENABLED = true +; Whether to always run at least once at start up time (if ENABLED) RUN_AT_START = true +; Time interval for job to run SCHEDULE = @every 24h ; Archives created more than OLDER_THAN ago are subject to deletion OLDER_THAN = 24h diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md index 55fe5c11d9..440946c7d7 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md +++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md @@ -189,6 +189,13 @@ Note: Actually, Gitea supports only SMTP with STARTTLS. - `ENABLED`: Enable this to run cron tasks periodically. - `RUN_AT_START`: Enable this to run cron tasks at start time. +### Cron - Cleanup old repository archives (`cron.archive_cleanup`) + +- `ENABLED`: Enable service. Defaults to true. +- `RUN_AT_START`: Run tasks at start up time (if ENABLED). Defaults to true. +- `SCHEDULE`: Cron syntax for scheduling repository archive cleanup, e.g. `@every 1h`. Defaults to `@every 24h`. +- `OLDER_THAN`: Archives created more than `OLDER_THAN` ago are subject to deletion, e.g. `12h`. Defaults to `24h`. + ### Cron - Update Mirrors (`cron.update_mirrors`) - `SCHEDULE`: Cron syntax for scheduling update mirrors, e.g. `@every 1h`.