Skip to content

Commit 9a0e2a8

Browse files
strklafriks
authored andcommitted
Improve cron.archive_cleanup docs in cheat sheet and app.ini.sample (#3215)
Include defaults in cheat sheet, for that section
1 parent 6abfa48 commit 9a0e2a8

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

custom/conf/app.ini.sample

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,11 @@ SCHEDULE = @every 24h
493493

494494
; Clean up old repository archives
495495
[cron.archive_cleanup]
496+
; Whether to enable the job
497+
ENABLED = true
498+
; Whether to always run at least once at start up time (if ENABLED)
496499
RUN_AT_START = true
500+
; Time interval for job to run
497501
SCHEDULE = @every 24h
498502
; Archives created more than OLDER_THAN ago are subject to deletion
499503
OLDER_THAN = 24h

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,13 @@ Note: Actually, Gitea supports only SMTP with STARTTLS.
189189
- `ENABLED`: Enable this to run cron tasks periodically.
190190
- `RUN_AT_START`: Enable this to run cron tasks at start time.
191191

192+
### Cron - Cleanup old repository archives (`cron.archive_cleanup`)
193+
194+
- `ENABLED`: Enable service. Defaults to true.
195+
- `RUN_AT_START`: Run tasks at start up time (if ENABLED). Defaults to true.
196+
- `SCHEDULE`: Cron syntax for scheduling repository archive cleanup, e.g. `@every 1h`. Defaults to `@every 24h`.
197+
- `OLDER_THAN`: Archives created more than `OLDER_THAN` ago are subject to deletion, e.g. `12h`. Defaults to `24h`.
198+
192199
### Cron - Update Mirrors (`cron.update_mirrors`)
193200

194201
- `SCHEDULE`: Cron syntax for scheduling update mirrors, e.g. `@every 1h`.

0 commit comments

Comments
 (0)