From 7b4186720c43b3e39bf93138c5ec076a0d6be3e2 Mon Sep 17 00:00:00 2001 From: Mattias Persson Date: Thu, 22 Oct 2020 20:02:28 +0200 Subject: Clarify app.example.ini documentation (#13256) * Clarify app.example.ini documentation Hard to understand if cron i needed to activate all other cron. * Added missing "Extended cron tasks" to config-cheat-sheet.en-us.md cron default is false - setting it true activates all cron. Changed the documentation accordingly * Fixed spelling Co-authored-by: techknowlogick --- custom/conf/app.example.ini | 43 +++++++++++++++++++++---------------------- 1 file changed, 21 insertions(+), 22 deletions(-) (limited to 'custom') diff --git a/custom/conf/app.example.ini b/custom/conf/app.example.ini index dc273ced80..a4e35d2495 100644 --- a/custom/conf/app.example.ini +++ b/custom/conf/app.example.ini @@ -915,12 +915,25 @@ PASSWD = RECEIVERS = [cron] -; Enable running cron tasks periodically. -ENABLED = true +; Enable running all cron tasks periodically with default settings. +ENABLED = false ; Run cron tasks when Gitea starts. RUN_AT_START = false -; Basic cron tasks +; Basic cron tasks - enabled by default + +; 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 +; Notice if not success +NO_SUCCESS_NOTICE = false +; Time interval for job to run +SCHEDULE = @every 24h +; Archives created more than OLDER_THAN ago are subject to deletion +OLDER_THAN = 24h ; Update mirrors [cron.update_mirrors] @@ -956,18 +969,15 @@ RUN_AT_START = true NO_SUCCESS_NOTICE = false SCHEDULE = @every 24h -; Clean up old repository archives -[cron.archive_cleanup] -; Whether to enable the job +[cron.update_migration_poster_id] +; Update migrated repositories' issues and comments' posterid, it will always attempt synchronization when the instance starts. ENABLED = true -; Whether to always run at least once at start up time (if ENABLED) +; Update migrated repositories' issues and comments' posterid when starting server (default true) RUN_AT_START = true ; Notice if not success NO_SUCCESS_NOTICE = false -; Time interval for job to run +; Interval as a duration between each synchronization. (default every 24h) SCHEDULE = @every 24h -; Archives created more than OLDER_THAN ago are subject to deletion -OLDER_THAN = 24h ; Synchronize external user data (only LDAP user synchronization is supported) [cron.sync_external_users] @@ -994,18 +1004,7 @@ SCHEDULE = @every 24h ; deleted branches than OLDER_THAN ago are subject to deletion OLDER_THAN = 24h -[cron.update_migration_poster_id] -; Update migrated repositories' issues and comments' posterid, it will always attempt synchronization when the instance starts. -ENABLED = true -; Update migrated repositories' issues and comments' posterid when starting server (default true) -RUN_AT_START = true -; Notice if not success -NO_SUCCESS_NOTICE = false -; Interval as a duration between each synchronization. (default every 24h) -SCHEDULE = @every 24h - -; Extened cron task -; they was not enabled as default +; Extended cron task - not enabled by default ; Delete all unactivated accounts [cron.delete_inactive_accounts] -- cgit v1.2.3