From 0647cc160545193dc79c26d736fa481715f572e1 Mon Sep 17 00:00:00 2001 From: Omar Roth Date: Sun, 15 Dec 2019 18:48:23 -0500 Subject: [PATCH] Updated Configuration (markdown) --- Configuration.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/Configuration.md b/Configuration.md index 7d223ce..2b74a4f 100644 --- a/Configuration.md +++ b/Configuration.md @@ -18,10 +18,10 @@ db: - `https_only` (default `false`) Used to tell Invidious it is accessed via https, set to `true` if you have for example a reverse proxy with a ssl certificate -- `domain` (default `nil`) Domain to use for providing `self` links in RSS feeds, issuing cookies, etc. - - `hmac_key` (default `nil`) Signing key for CSRF tokens (when `nil` is randomly generated on startup, can be any random string) +- `domain` (default `nil`) Domain to use for providing `self` links in RSS feeds, issuing cookies, etc. + - `use_pubsub_feeds` (default `false`) Use server-side notifications provided by [YouTube](https://developers.google.com/youtube/v3/guides/push_notifications). Requires `domain` and `hmac_key` to be set - `default_home` (default `"Top"`) Default home page **Moved into `default_user_preferences`** @@ -30,7 +30,7 @@ db: - `top_enabled` (default `true`) Whether top endpoints should be enabled (better privacy for smaller instances) -- `captcha_enabled` (default `true`) Determine if CAPTCHA should be required for login/registration +- `captcha_enabled` (default `true`) Determine if CAPTCHA should be required for registration - `login_enabled` (default `true`) Whether users should be able to login @@ -61,3 +61,11 @@ db: - `pool_size` (default `100`) Pool size for HTTP connections for youtube.com and ytimg.com (each domain has a separate pool of `pool_size`) - `admin_email` (default `omarroth@protonmail.com`) Email provided to users for bug reports + +- `port` (default `3000`) Default port for HTTP server + +- `host_binding` (default `0.0.0.0`) Default host for HTTP server + +- `cookies` (default ``) Cookies to be used when connecting to YouTube + +- `captcha_key` (default `nil`) [Anti-Captcha](https://anti-captcha.com/) API key for solving YouTube CAPTCHAs, see [#886](https://github.com/omarroth/invidious/issues/886). \ No newline at end of file