From 601d158a327d2e68df0650ffc617eaaea7c12ccb Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Sat, 20 May 2023 09:13:51 +0200 Subject: [PATCH] Update config.yml --- conf/config.yml | 157 +++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 130 insertions(+), 27 deletions(-) diff --git a/conf/config.yml b/conf/config.yml index e3de0b6..6511fed 100644 --- a/conf/config.yml +++ b/conf/config.yml @@ -158,12 +158,12 @@ hsts: true ## See: https://github.com/iv-org/invidious/issues/957#issuecomment-576424042 ## ## Accepted values: true, false -## Default: true +## Default: false ## -#use_quic: true +#use_quic: false ## -## Additionnal cookies to be sent when requesting the youtube API. +## Additional cookies to be sent when requesting the youtube API. ## ## Accepted values: a string in the format "name1=value1; name2=value2..." ## Default: @@ -188,7 +188,7 @@ hsts: true ## ## Path to log file. Can be absolute or relative to the invidious -## binary. This is overriden if "-o OUTPUT" or "--output=OUTPUT" +## binary. This is overridden if "-o OUTPUT" or "--output=OUTPUT" ## are passed on the command line. ## ## Accepted values: a filesystem path or 'STDOUT' @@ -197,7 +197,7 @@ hsts: true #output: STDOUT ## -## Logging Verbosity. This is overriden if "-l LEVEL" or +## Logging Verbosity. This is overridden if "-l LEVEL" or ## "--log-level=LEVEL" are passed on the command line. ## ## Accepted values: All, Trace, Debug, Info, Warn, Error, Fatal, Off @@ -298,6 +298,18 @@ admins: ["__ADMIN__"] ## Email provided to users for bug reports admin_email: __EMAIL__ +## +## Enable/Disable the user notifications for all users +## +## Note: On large instances, it is recommended to set this option to 'false' +## in order to reduce the amount of data written to the database, and hence +## improve the overall performance of the instance. +## +## Accepted values: true, false +## Default: true +## +#enable_user_notifications: true + # ----------------------------- # Background jobs # ----------------------------- @@ -306,16 +318,23 @@ admin_email: __EMAIL__ ## Number of threads to use when crawling channel videos (during ## subscriptions update). ## -## Notes: -## - Setting this to 0 will disable the channel videos crawl job. -## - This setting is overriden if "-c THREADS" or -## "--channel-threads=THREADS" are passed on the command line. +## Notes: This setting is overridden if either "-c THREADS" or +## "--channel-threads=THREADS" is passed on the command line. ## ## Accepted values: a positive integer ## Default: 1 ## channel_threads: 1 +## +## Time interval between two executions of the job that crawls +## channel videos (subscriptions update). +## +## Accepted values: a valid time interval (like 1h30m or 90m) +## Default: 30m +## +#channel_refresh_interval: 30m + ## ## Forcefully dump and re-download the entire list of uploaded ## videos when crawling channel (during subscriptions update). @@ -328,10 +347,8 @@ full_refresh: false ## ## Number of threads to use when updating RSS feeds. ## -## Notes: -## - Setting this to 0 will disable the channel videos crawl job. -## - This setting is overriden if "-f THREADS" or -## "--feed-threads=THREADS" are passed on the command line. +## Notes: This setting is overridden if either "-f THREADS" or +## "--feed-threads=THREADS" is passed on the command line. ## ## Accepted values: a positive integer ## Default: 1 @@ -342,13 +359,49 @@ feed_threads: 1 ## Enable/Disable the polling job that keeps the decryption ## function (for "secured" videos) up to date. ## -## Note: This part of the code is currently broken, so changing +## Note: This part of the code generate a small amount of data every minute. +## This may not be desired if you have bandwidth limits set by your ISP. +## +## Note 2: This part of the code is currently broken, so changing ## this setting has no impact. ## ## Accepted values: true, false -## Default: true +## Default: false ## -#decrypt_polling: true +#decrypt_polling: false + + +jobs: + + ## Options for the database cleaning job + clear_expired_items: + + ## Enable/Disable job + ## + ## Accepted values: true, false + ## Default: true + ## + enable: true + + ## Options for the channels updater job + refresh_channels: + + ## Enable/Disable job + ## + ## Accepted values: true, false + ## Default: true + ## + enable: true + + ## Options for the RSS feeds updater job + refresh_feeds: + + ## Enable/Disable job + ## + ## Accepted values: true, false + ## Default: true + ## + enable: true # ----------------------------- @@ -373,7 +426,7 @@ feed_threads: 1 # ----------------------------- -# Miscellanous +# Miscellaneous # ----------------------------- ## @@ -434,7 +487,22 @@ feed_threads: 1 ## #cache_annotations: false +## +## Source code URL. If your instance is running a modified source +## code, you MUST publish it somewhere and set this option. +## +## Accepted values: a string +## Default: +## +#modified_source_code_url: "" +## +## Maximum custom playlist length limit. +## +## Accepted values: Integer +## Default: 500 +## +#playlist_length_limit: 500 ######################################### # @@ -459,9 +527,9 @@ default_user_preferences: ## ## Default user interface language (locale). ## - ## Note: overridin the default (no preferred caption language) - ## is not recommended, in order to not penalize people using - ## other languages. + ## Note: When hosting a public instance, overriding the + ## default (english) is not recommended, as it may + ## people using other languages. ## ## Accepted values: ## ar (Arabic) @@ -498,9 +566,24 @@ default_user_preferences: locale: __LANGUAGE__ ## - ## Top 3 prefered languages for video captions. + ## Default geographical location for content. ## - ## Note: overridin the default (no preferred + ## Accepted values: + ## AE, AR, AT, AU, AZ, BA, BD, BE, BG, BH, BO, BR, BY, CA, CH, CL, CO, CR, + ## CY, CZ, DE, DK, DO, DZ, EC, EE, EG, ES, FI, FR, GB, GE, GH, GR, GT, HK, + ## HN, HR, HU, ID, IE, IL, IN, IQ, IS, IT, JM, JO, JP, KE, KR, KW, KZ, LB, + ## LI, LK, LT, LU, LV, LY, MA, ME, MK, MT, MX, MY, NG, NI, NL, NO, NP, NZ, + ## OM, PA, PE, PG, PH, PK, PL, PR, PT, PY, QA, RO, RS, RU, SA, SE, SG, SI, + ## SK, SN, SV, TH, TN, TR, TW, TZ, UA, UG, US, UY, VE, VN, YE, ZA, ZW + ## + ## Default: US + ## + #region: US + + ## + ## Top 3 preferred languages for video captions. + ## + ## Note: overriding the default (no preferred ## caption language) is not recommended, in order ## to not penalize people using other languages. ## @@ -544,10 +627,10 @@ default_user_preferences: ## ## Enable/Disable dark mode. ## - ## Accepted values: true, false - ## Default: + ## Accepted values: "dark", "light", "auto" + ## Default: "auto" ## - #dark_mode: true + #dark_mode: "auto" ## ## Enable/Disable thin mode (no video thumbnails). @@ -572,7 +655,7 @@ default_user_preferences: #feed_menu: ["Popular", "Trending", "Subscriptions", "Playlists"] ## - ## Default feed to diplay on the home page. + ## Default feed to display on the home page. ## ## Note: setting this option to "Popular" has no ## effect when 'popular_enabled' is set to false. @@ -737,6 +820,16 @@ default_user_preferences: ## Default: true ## #vr_mode: true + + ## + ## Save the playback position + ## Allow to continue watching at the previous position when + ## watching the same video. + ## + ## Accepted values: true, false + ## Default: false + ## + #save_player_pos: false # ----------------------------- # Subscription feed @@ -790,7 +883,7 @@ default_user_preferences: # ----------------------------- - # Miscellanous + # Miscellaneous # ----------------------------- ## @@ -825,3 +918,13 @@ default_user_preferences: ## Default: false ## #automatic_instance_redirect: false + + ## + ## Show the entire video description by default (when set to 'false', + ## only the first few lines of the description are shown and a + ## "show more" button allows to expand it). + ## + ## Accepted values: true, false + ## Default: false + ## + #extend_desc: false