TudbuT/forgejo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Improve cron.archive_cleanup docs in cheat sheet and app.ini.sample (#3215)

Browse source 
Include defaults in cheat sheet, for that section
This commit is contained in:
Sandro Santilli 2017-12-17 15:37:34 +01:00 committed by Lauris BH
parent 6abfa48c0e
commit 9a0e2a8b07
2 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
custom/conf/app.ini.sample
View file

@ -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

7
docs/content/doc/advanced/config-cheat-sheet.en-us.md
View file

@ -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`.