mirror of
https://github.com/zoriya/Kyoo.git
synced 2025-05-23 17:52:36 -04:00
105 lines
4.6 KiB
Plaintext
105 lines
4.6 KiB
Plaintext
# vi: ft=sh
|
|
# shellcheck disable=SC2034
|
|
|
|
|
|
# Useful config options
|
|
|
|
# Library root can either be an absolute path or a relative path to your docker-compose.yml file.
|
|
LIBRARY_ROOT=./video
|
|
# You should set this to a path where kyoo can write large amount of data, this is used as a cache by the transcoder.
|
|
# It will automatically be cleaned up on kyoo's startup/shutdown/runtime.
|
|
CACHE_ROOT=/tmp/kyoo_cache
|
|
LIBRARY_LANGUAGES=en
|
|
# If this is true, kyoo will prefer to download the media in the original language of the item.
|
|
MEDIA_PREFER_ORIGINAL_LANGUAGE=false
|
|
# A pattern (regex) to ignore files.
|
|
LIBRARY_IGNORE_PATTERN=".*/[dD]ownloads?/.*|.*[Tt][Rr][Aa][Ii][Ll][Ee][Rr].*"
|
|
|
|
# If this is true, new accounts wont have any permissions before you approve them in your admin dashboard.
|
|
REQUIRE_ACCOUNT_VERIFICATION=true
|
|
# Specify permissions of guest accounts, default is no permissions.
|
|
UNLOGGED_PERMISSIONS=
|
|
# but you can allow anyone to use your instance without account by doing:
|
|
# UNLOGGED_PERMISSIONS=overall.read,overall.play
|
|
# You can specify this to allow guests users to see your collection without behing able to play videos for example:
|
|
# UNLOGGED_PERMISSIONS=overall.read
|
|
|
|
# Specify permissions of new accounts.
|
|
DEFAULT_PERMISSIONS=overall.read,overall.play
|
|
|
|
# Hardware transcoding (equivalent of --profile docker compose option).
|
|
COMPOSE_PROFILES=cpu # cpu (no hardware acceleration) or vaapi or qsv or nvidia
|
|
# the preset used during transcode. faster means worst quality, you can probably use a slower preset with hwaccels
|
|
# warning: using vaapi hwaccel disable presets (they are not supported).
|
|
GOCODER_PRESET=fast
|
|
|
|
|
|
# The following value should be set to a random sequence of characters.
|
|
# You MUST change it when installing kyoo (for security)
|
|
# You can input multiple api keys separated by a ,
|
|
KYOO_APIKEYS=t7H5!@4iMNsAaSJQ49pat4jprJgTcF656if#J3
|
|
|
|
# Keep those empty to use kyoo's default api key. You can also specify a custom API key if you want.
|
|
# go to https://www.themoviedb.org/settings/api and copy the api key (not the read access token, the api key)
|
|
THEMOVIEDB_APIKEY=
|
|
# go to https://thetvdb.com/api-information/signup and copy the api key
|
|
TVDB_APIKEY=
|
|
# you can also input your subscriber's pin to support TVDB
|
|
TVDB_PIN=
|
|
|
|
|
|
# The url you can use to reach your kyoo instance. This is used during oidc to redirect users to your instance.
|
|
PUBLIC_URL=http://localhost:8901
|
|
|
|
# Use a builtin oidc service (google, discord, trakt, or simkl):
|
|
# When you create a client_id, secret combo you may be asked for a redirect url. You need to specify https://YOUR-PUBLIC-URL/api/auth/logged/YOUR-SERVICE-NAME
|
|
OIDC_DISCORD_CLIENTID=
|
|
OIDC_DISCORD_SECRET=
|
|
# Or add your custom one:
|
|
OIDC_SERVICE_NAME=YourPrettyName
|
|
OIDC_SERVICE_LOGO=https://url-of-your-logo.com
|
|
OIDC_SERVICE_CLIENTID=
|
|
OIDC_SERVICE_SECRET=
|
|
OIDC_SERVICE_AUTHORIZATION=https://url-of-the-authorization-endpoint-of-the-oidc-service.com/auth
|
|
OIDC_SERVICE_TOKEN=https://url-of-the-token-endpoint-of-the-oidc-service.com/token
|
|
OIDC_SERVICE_PROFILE=https://url-of-the-profile-endpoint-of-the-oidc-service.com/userinfo
|
|
OIDC_SERVICE_SCOPE="the list of scopes space separeted like email identity"
|
|
# Token authentication method as seen in https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication
|
|
# Supported values: ClientSecretBasic (default) or ClientSecretPost
|
|
# If in doubt, leave this empty.
|
|
OIDC_SERVICE_AUTHMETHOD=ClientSecretBasic
|
|
# on the previous list, service is the internal name of your service, you can add as many as you want.
|
|
|
|
|
|
# Following options are optional and only useful for debugging.
|
|
|
|
# To debug the front end, you can set the following to an external backend
|
|
KYOO_URL=
|
|
|
|
# Database things
|
|
POSTGRES_USER=KyooUser
|
|
POSTGRES_PASSWORD=KyooPassword
|
|
POSTGRES_DB=kyooDB
|
|
POSTGRES_SERVER=postgres
|
|
POSTGRES_PORT=5432
|
|
|
|
# Read by the api container to know if it should run meilisearch's migrations/sync
|
|
# and download missing images. This is a good idea to only have one instance with this on
|
|
# Note: it does not run postgres migrations, use the migration container for that.
|
|
RUN_MIGRATIONS=true
|
|
|
|
MEILI_HOST="http://meilisearch:7700"
|
|
MEILI_MASTER_KEY="ghvjkgisbgkbgskegblfqbgjkebbhgwkjfb"
|
|
|
|
RABBITMQ_HOST=rabbitmq
|
|
RABBITMQ_PORT=5672
|
|
RABBITMQ_DEFAULT_USER=kyoo
|
|
RABBITMQ_DEFAULT_PASS=aohohunuhouhuhhoahothonseuhaoensuthoaentsuhha
|
|
|
|
|
|
# v5 stuff, does absolutely nothing on master (aka: you can delete this)
|
|
EXTRA_CLAIMS='{"permissions": ["core.read"], "verified": false}'
|
|
FIRST_USER_CLAIMS='{"permissions": ["users.read", "users.write", "apikeys.read", "apikeys.write", "users.delete", "core.read", "core.write"], "verified": true}'
|
|
GUEST_CLAIMS='{"permissions": ["core.read"]}'
|
|
PROTECTED_CLAIMS="permissions,verified"
|