documentation/Configuration.md

54 lines
2.8 KiB
Markdown
Raw Normal View History

2019-01-24 18:35:02 +01:00
### What can be configured and what are these configuration options?
The configuration file is located at [invidious/config/config.yml](https://github.com/omarroth/invidious/blob/master/config/config.yml).
2019-05-06 04:20:50 +02:00
`channel_threads (default 1)` Number of threads to use for crawling videos from channels
2019-03-08 18:48:16 +01:00
2019-05-06 04:20:50 +02:00
`feed_threads (default 1)` Number of threads to use for updating subscription feeds
2019-01-24 18:35:02 +01:00
```
db:
user: kemal # your database user
password: kemal # your database password
host: localhost # database host
port: 5432 # postgres port
```
2019-03-08 18:48:16 +01:00
`full_refresh (default false)` Used for crawling channels: threads should check all videos uploaded by a channel
`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)` You should specify the domain you publish your Invidious instance here
`hmac_key (default nil)` Signing key for CSRF tokens and pubsub (randomly generated on startup, should be random string)
`use_pubsub_feeds (default false)` Support server-side notifications from YouTube using [PubSubHubbub](https://developers.google.com/youtube/v3/guides/push_notifications). Requires `domain` and `hmac_key` to be set
`default_home (default "Top")` Default home page
`feed_menu (default ["Popular", "Top", "Trending", "Subscriptions"])` Order of tabs on feed menu
`top_enabled (default true)` Whether top endpoints should be enabled (better for smaller instances)
`captcha_enabled (default true)` Determine if CAPTCHA should be required for login/registration
`login_enabled (default true)` Whether users should be able to login
`registration_enabled (default true)` Whether new users should be able to register
`statistics_enabled (default false)` Whether statistics should be available from `/api/v1/stats`
2019-03-04 17:45:51 +01:00
`admins (default [])` List of user IDs that have access to administrator preferences
2019-03-08 18:48:16 +01:00
`external_port (default nil)` Invidious should supply links to a different port (if running behind a proxy, for example). PubSub notifications (if enabled) will also be sent to this port
2019-05-06 04:18:15 +02:00
2019-05-06 04:18:40 +02:00
`default_user_preferences (default`[`ConfigPreferences`](https://github.com/omarroth/invidious/blob/0.16.0/src/invidious/helpers/helpers.cr#L39)`)` Default preferences to use for new and unregistered users, see [#415](https://github.com/omarroth/invidious/issues/415)
2019-05-06 04:18:15 +02:00
`dmca_content (default [])` For compliance with DMCA requests, disables download widget for list of video IDs
`check_tables (default false)` Check table integrity, automatically try to add any missing columns, create columns, etc.
`cache_annotations (default false)` Cache annotations requested from IA, will not cache empty annotations or annotations that only contain cards
`banner (default nil)` Optional banner to be displayed along top of page for announcements, etc.