Add documentation to config

src/invidious/helpers/helpers.cr

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