Container Port: 8000

Target

8000

Default

8000

Value

8000

An access token that can be used for admin operations.

Target

SERVER_ADMIN_ACCESS_TOKEN

Key to activate pro features. If left blank, will default to community edition.

Target

SERVER_PRO_KEY

The mailbox format for sending emails.

Target

SERVER_SMTP_MAILBOX

Default

Ryot <no-reply@ryot.io>

Value

Ryot <no-reply@ryot.io>

The SMTP host to send emails from.

Target

SERVER_SMTP_SERVER

The SMTP user to send emails from.

Target

SERVER_SMTP_USER

The SMTP password to send emails from.

Target

SERVER_SMTP_PASSWORD

Used as the base URL when generating item links for the frontend.

Target

FRONTEND_URL

Default

http://localhost:8000

Allow users to register for an account.

Target

USERS_ALLOW_REGISTRATION

Default

true|false

The secret used for generating JWT tokens.

Target

USERS_JWT_SECRET

Whether to disable local user authentication completely.

Target

USERS_DISABLE_LOCAL_AUTH

Default

false|true

The client ID for OIDC authentication.

Target

SERVER_OIDC_CLIENT_ID

The client secret for OIDC authentication.

Target

SERVER_OIDC_CLIENT_SECRET

The issuer URL for OIDC authentication.

Target

SERVER_OIDC_ISSUER_URL

URL of the Postgres database

Target

DATABASE_URL

Default

postgres://USERNAME:PASSWORD@HOST:5432/DATABASE_NAME

The access key ID for the S3 compatible file storage. Required to enable file storage.

Target

FILE_STORAGE_S3_ACCESS_KEY_ID

The secret access key for the S3 compatible file storage. Required to enable file storage.

Target

FILE_STORAGE_S3_SECRET_ACCESS_KEY

The URL for the S3 compatible file storage. Required to enable file storage.

Target

FILE_STORAGE_S3_URL

The region for the S3 compatible file storage. Required to enable file storage.

Target

FILE_STORAGE_S3_REGION

The bucket name for the S3 compatible file storage. Required to enable file storage.

Target

FILE_STORAGE_S3_BUCKET_NAME

Number of days after which a media should be removed from the Monitoring collection.

Target

MEDIA_MONITORING_REMOVE_AFTER_DAYS

Default

30

Value

30

The preferred language for Anilist data.

Target

ANIME_AND_MANGA_ANILIST_PREFERRED_LANGUAGE

Default

native

Value

native

The client ID issued by MAL.

Target

ANIME_AND_MANGA_MAL_CLIENT_ID

The locale for Audible data.

Target

AUDIO_BOOKS_AUDIBLE_LOCALE

Default

us

Value

us

The API key issued by Google Books.

Target

BOOKS_GOOGLE_BOOKS_API_KEY

Whether to pass the raw query string to the search API.

Target

BOOKS_GOOGLE_BOOKS_PASS_RAW_QUERY

Default

false|true

The API key issued by Hardcover.

Target

BOOKS_HARDCOVER_API_KEY

The size of the cover image to fetch from Openlibrary.

Target

BOOKS_OPENLIBRARY_COVER_IMAGE_SIZE

Default

M

Value

M

The access token issued by TMDB.

Target

MOVIES_AND_SHOWS_TMDB_ACCESS_TOKEN

The preferred language for TMDB data.

Target

MOVIES_AND_SHOWS_TMDB_LOCALE

Default

en

Value

en

The API key for the TVDB API.

Target

MOVIES_AND_SHOWS_TVDB_API_KEY

The locale for iTunes data.

Target

PODCASTS_ITUNES_LOCALE

Default

en_us

Value

en_us

The API token issued by Listennotes.

Target

PODCASTS_LISTENNOTES_API_TOKEN

The client ID for the Spotify API.

Target

MUSIC_SPOTIFY_CLIENT_ID

The client secret for the Spotify API.

Target

MUSIC_SPOTIFY_CLIENT_SECRET

The size of the cover image to fetch from IGDB.

Target

VIDEO_GAMES_IGDB_IMAGE_SIZE

Default

t_original

Value

t_original

The client ID issued by Twitch. Required to enable video games tracking.

Target

VIDEO_GAMES_TWITCH_CLIENT_ID

The client secret issued by Twitch. Required to enable video games tracking.

Target

VIDEO_GAMES_TWITCH_CLIENT_SECRET

The API key for the GiantBomb API.

Target

VIDEO_GAMES_GIANT_BOMB_API_KEY

Internal port of the container. Not recommended to change.

Target

PORT

Default

8000

Value

8000

The host address to bind the backend server to.

Target

SERVER_BACKEND_HOST

Default

0.0.0.0

Value

0.0.0.0

The port number to bind the backend server to.

Target

SERVER_BACKEND_PORT

Default

5000

Value

5000

An array of URLs for CORS origins.

Target

SERVER_CORS_ORIGINS

Disable background jobs

Target

SERVER_DISABLE_BACKGROUND_JOBS

Default

false|true

The hours in which a media can be marked as seen again for a user. This is used so that the same media can not be used marked as started when it has been already marked as seen in the last `n` hours.

Target

SERVER_PROGRESS_UPDATE_THRESHOLD

Default

2

Value

2

Enable the GraphQL playground

Target

SERVER_GRAPHQL_PLAYGROUND_ENABLED

Default

true|false

Enable demo mode

Target

SERVER_IS_DEMO_INSTANCE

Default

false|true

The client ID for the Trakt importer. Required to enable Trakt importer.

Target

SERVER_IMPORTER_TRAKT_CLIENT_ID

The maximum file size, in MB, for user uploads.

Target

SERVER_MAX_FILE_SIZE_MB

Default

70

Value

70

The number of seconds to sleep before starting the server.

Target

SERVER_SLEEP_BEFORE_STARTUP_SECONDS

Default

0

Value

0

A message to be displayed on the dashboard.

Target

FRONTEND_DASHBOARD_MESSAGE

The button label for OIDC authentication.

Target

FRONTEND_OIDC_BUTTON_LABEL

Default

Continue with OpenID Connect

The number of days till login authentication token is valid.

Target

USERS_TOKEN_VALID_FOR_DAYS

Default

90

Value

90

Opt out of telemetry metrics

Target

DISABLE_TELEMETRY

Default

true|false

Comma separated list of domain names to provide in analytics

Target

FRONTEND_UMAMI_DOMAINS

URL of the Umami analytics script. For example: https://umami.is/script.js

Target

FRONTEND_UMAMI_SCRIPT_URL

The website ID for Umami analytics

Target

FRONTEND_UMAMI_WEBSITE_ID

English expression for frequent cron tasks (syncing integrations, workout revisions). Uses https://github.com/kaplanelad/english-to-cron.

Target

SCHEDULER_FREQUENT_CRON_JOBS_SCHEDULE

Default

every 5 minutes

Value

every 5 minutes

English expression for infrequent cron jobs (cleaning up data, refreshing calendar). Uses https://github.com/kaplanelad/english-to-cron.

Target

SCHEDULER_INFREQUENT_CRON_JOBS_SCHEDULE

Default

every midnight

Value

every midnight

Sync data from push and yank based integrations every `n` minutes.

Target

INTEGRATION_SYNC_EVERY_MINUTES

Default

5

Value

5