# vi: ft=sh # shellcheck disable=SC2034 # THIS IS V5 .ENV ; IF YOU ARE ON V4 PLEASE LOOK AT THE .ENV HERE: https://github.com/zoriya/Kyoo/blob/v4.7.1/.env.example # 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 # A pattern (regex) to ignore files. LIBRARY_IGNORE_PATTERN=".*/[dD]ownloads?/.*" # 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 # 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 PGUSER=kyoo PGPASSWORD=password PGDATABASE=kyoo PGHOST=postgres PGPORT=5432 # 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", "scanner.trigger"], "verified": true}' GUEST_CLAIMS='{"permissions": ["core.read"]}' PROTECTED_CLAIMS="permissions,verified"