Add documentation to config

This commit is contained in:
Omar Roth 2019-01-23 14:28:31 -06:00
parent af449161ff
commit 71ba071160

View file

@ -1,21 +1,21 @@
class Config
YAML.mapping({
crawl_threads: Int32,
channel_threads: Int32,
feed_threads: Int32,
video_threads: Int32,
db: NamedTuple(
user: String,
password: String,
host: String,
port: Int32,
dbname: String,
),
dl_api_key: String?,
https_only: Bool?,
hmac_key: String?,
full_refresh: Bool,
domain: String,
crawl_threads: Int32, # Number of threads to use for finding new videos from YouTube (used to popular top page)
channel_threads: Int32, # Number of threads to use for crawling videos from channels (for updating subscriptions)
feed_threads: Int32, # Number of threads to use for updating feeds
video_threads: Int32, # Number of threads to use for updating videos in cache (mostly non-functional)
db: NamedTuple( # Database configuration
user: String,
password: String,
host: String,
port: Int32,
dbname: String,
),
dl_api_key: String?, # DetectLanguage API Key (used to filter non-English results from top page), mostly non-functional
https_only: Bool?, # Used to tell Invidious it is behind a proxy, so links to resources should be https://
hmac_key: String?, # HMAC signing key for CSRF tokens
full_refresh: Bool, # Used for crawling channels: threads should check all videos uploaded by a channel
domain: String, # Domain to be used for links to resources on the site where an absolute URL is required
})
end