Container Port: 8000

Objetivo

8000

Por defecto

8000

Valor

8000

An access token that can be used for admin operations.

Objetivo

SERVER_ADMIN_ACCESS_TOKEN

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

Objetivo

SERVER_PRO_KEY

The mailbox format for sending emails.

Objetivo

SERVER_SMTP_MAILBOX

Por defecto

Ryot <no-reply@ryot.io>

Valor

Ryot <no-reply@ryot.io>

The SMTP host to send emails from.

Objetivo

SERVER_SMTP_SERVER

The SMTP user to send emails from.

Objetivo

SERVER_SMTP_USER

The SMTP password to send emails from.

Objetivo

SERVER_SMTP_PASSWORD

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

Objetivo

FRONTEND_URL

Por defecto

http://localhost:8000

Allow users to register for an account.

Objetivo

USERS_ALLOW_REGISTRATION

Por defecto

true|false

The secret used for generating JWT tokens.

Objetivo

USERS_JWT_SECRET

Whether to disable local user authentication completely.

Objetivo

USERS_DISABLE_LOCAL_AUTH

Por defecto

false|true

The client ID for OIDC authentication.

Objetivo

SERVER_OIDC_CLIENT_ID

The client secret for OIDC authentication.

Objetivo

SERVER_OIDC_CLIENT_SECRET

The issuer URL for OIDC authentication.

Objetivo

SERVER_OIDC_ISSUER_URL

URL of the Postgres database

Objetivo

DATABASE_URL

Por defecto

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

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

Objetivo

FILE_STORAGE_S3_ACCESS_KEY_ID

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

Objetivo

FILE_STORAGE_S3_SECRET_ACCESS_KEY

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

Objetivo

FILE_STORAGE_S3_URL

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

Objetivo

FILE_STORAGE_S3_REGION

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

Objetivo

FILE_STORAGE_S3_BUCKET_NAME

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

Objetivo

MEDIA_MONITORING_REMOVE_AFTER_DAYS

Por defecto

30

Valor

30

The preferred language for Anilist data.

Objetivo

ANIME_AND_MANGA_ANILIST_PREFERRED_LANGUAGE

Por defecto

native

Valor

native

The client ID issued by MAL.

Objetivo

ANIME_AND_MANGA_MAL_CLIENT_ID

The locale for Audible data.

Objetivo

AUDIO_BOOKS_AUDIBLE_LOCALE

Por defecto

us

Valor

us

The API key issued by Google Books.

Objetivo

BOOKS_GOOGLE_BOOKS_API_KEY

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

Objetivo

BOOKS_GOOGLE_BOOKS_PASS_RAW_QUERY

Por defecto

false|true

The API key issued by Hardcover.

Objetivo

BOOKS_HARDCOVER_API_KEY

The size of the cover image to fetch from Openlibrary.

Objetivo

BOOKS_OPENLIBRARY_COVER_IMAGE_SIZE

Por defecto

M

Valor

M

The access token issued by TMDB.

Objetivo

MOVIES_AND_SHOWS_TMDB_ACCESS_TOKEN

The preferred language for TMDB data.

Objetivo

MOVIES_AND_SHOWS_TMDB_LOCALE

Por defecto

en

Valor

en

The API key for the TVDB API.

Objetivo

MOVIES_AND_SHOWS_TVDB_API_KEY

The locale for iTunes data.

Objetivo

PODCASTS_ITUNES_LOCALE

Por defecto

en_us

Valor

en_us

The API token issued by Listennotes.

Objetivo

PODCASTS_LISTENNOTES_API_TOKEN

The client ID for the Spotify API.

Objetivo

MUSIC_SPOTIFY_CLIENT_ID

The client secret for the Spotify API.

Objetivo

MUSIC_SPOTIFY_CLIENT_SECRET

The size of the cover image to fetch from IGDB.

Objetivo

VIDEO_GAMES_IGDB_IMAGE_SIZE

Por defecto

t_original

Valor

t_original

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

Objetivo

VIDEO_GAMES_TWITCH_CLIENT_ID

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

Objetivo

VIDEO_GAMES_TWITCH_CLIENT_SECRET

The API key for the GiantBomb API.

Objetivo

VIDEO_GAMES_GIANT_BOMB_API_KEY

Internal port of the container. Not recommended to change.

Objetivo

PORT

Por defecto

8000

Valor

8000

The host address to bind the backend server to.

Objetivo

SERVER_BACKEND_HOST

Por defecto

0.0.0.0

Valor

0.0.0.0

The port number to bind the backend server to.

Objetivo

SERVER_BACKEND_PORT

Por defecto

5000

Valor

5000

An array of URLs for CORS origins.

Objetivo

SERVER_CORS_ORIGINS

Disable background jobs

Objetivo

SERVER_DISABLE_BACKGROUND_JOBS

Por defecto

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.

Objetivo

SERVER_PROGRESS_UPDATE_THRESHOLD

Por defecto

2

Valor

2

Enable the GraphQL playground

Objetivo

SERVER_GRAPHQL_PLAYGROUND_ENABLED

Por defecto

true|false

Enable demo mode

Objetivo

SERVER_IS_DEMO_INSTANCE

Por defecto

false|true

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

Objetivo

SERVER_IMPORTER_TRAKT_CLIENT_ID

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

Objetivo

SERVER_MAX_FILE_SIZE_MB

Por defecto

70

Valor

70

The number of seconds to sleep before starting the server.

Objetivo

SERVER_SLEEP_BEFORE_STARTUP_SECONDS

Por defecto

0

Valor

0

A message to be displayed on the dashboard.

Objetivo

FRONTEND_DASHBOARD_MESSAGE

The button label for OIDC authentication.

Objetivo

FRONTEND_OIDC_BUTTON_LABEL

Por defecto

Continue with OpenID Connect

The number of days till login authentication token is valid.

Objetivo

USERS_TOKEN_VALID_FOR_DAYS

Por defecto

90

Valor

90

Opt out of telemetry metrics

Objetivo

DISABLE_TELEMETRY

Por defecto

true|false

Comma separated list of domain names to provide in analytics

Objetivo

FRONTEND_UMAMI_DOMAINS

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

Objetivo

FRONTEND_UMAMI_SCRIPT_URL

The website ID for Umami analytics

Objetivo

FRONTEND_UMAMI_WEBSITE_ID

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

Objetivo

SCHEDULER_FREQUENT_CRON_JOBS_SCHEDULE

Por defecto

every 5 minutes

Valor

every 5 minutes

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

Objetivo

SCHEDULER_INFREQUENT_CRON_JOBS_SCHEDULE

Por defecto

every midnight

Valor

every midnight

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

Objetivo

INTEGRATION_SYNC_EVERY_MINUTES

Por defecto

5

Valor

5