ConvertX/.env.example

95 lines
3.2 KiB
Plaintext

# Copy this file to .env and fill in the values you need.
# .env is gitignored - never commit real secrets.
# All variables are optional unless noted otherwise; ConvertX runs fine with
# none of these set. See README.md for the full description of each.
### Core / auth ###
# A long, random, secret string used to sign session JWTs. Strongly
# recommended to set explicitly - if unset, a new random value is generated
# on every restart, which logs out all existing sessions. Generate one with:
# openssl rand -hex 32
JWT_SECRET=
# Allow anyone to register a new local account (true/false). Defaults to false.
ACCOUNT_REGISTRATION=false
# Allow the app to run over plain HTTP (true/false). Defaults to false. Only
# set this to true for local/non-HTTPS testing - required if you are not
# accessing the app via localhost or HTTPS, otherwise login cookies won't be set.
HTTP_ALLOWED=false
# Skip login entirely and let anyone use the service (true/false). Defaults to
# false. Only use this locally / on a trusted network.
ALLOW_UNAUTHENTICATED=false
# When ALLOW_UNAUTHENTICATED=true, share the same conversion history between
# all unauthenticated users/devices instead of giving each a separate one
# (true/false). Defaults to false.
UNAUTHENTICATED_USER_SHARING=false
### OIDC / SSO login (e.g. Authentik) ###
# Set the first four to enable the "Login with ..." button. All are optional.
# The provider's issuer URL, e.g. https://authentik.example.com/application/o/convertx/
OIDC_ISSUER=
# OAuth2/OIDC client ID issued by the provider.
OIDC_CLIENT_ID=
# OAuth2/OIDC client secret issued by the provider.
OIDC_CLIENT_SECRET=
# The public callback URL registered with the provider, must match exactly,
# e.g. https://convertx.example.com/login/oidc/callback
OIDC_REDIRECT_URI=
# Space-separated scopes requested from the provider. Defaults to "openid profile email".
OIDC_SCOPES=openid profile email
# Display name used on the "Login with ..." button. Defaults to "SSO".
OIDC_NAME=SSO
# Hide local email/password login and registration entirely, only allow OIDC
# login (true/false). Defaults to false.
OIDC_ONLY=false
### App behavior ###
# Checks every n hours for files older than n hours and deletes them. Set to 0
# to disable. Defaults to 24.
AUTO_DELETE_EVERY_N_HOURS=24
# Hide the history page (true/false). Defaults to false.
HIDE_HISTORY=false
# The root path of the web interface. E.g. setting this to "/convertx" serves
# the app at "example.com/convertx/". Leave empty to serve at the domain root.
WEBROOT=
# Language to format date strings in, as a BCP 47 language tag. Defaults to "en".
LANGUAGE=en
# Maximum number of concurrent conversion processes. Set to 0 for unlimited.
# Defaults to 0.
MAX_CONVERT_PROCESS=0
# Timezone used for displaying dates, e.g. Europe/Stockholm. Defaults to UTC.
TZ=
### ffmpeg tuning ###
# Extra arguments passed to ffmpeg before the input file, e.g. -hwaccel vaapi.
# See https://github.com/C4illin/ConvertX/issues/190 for hardware acceleration.
FFMPEG_ARGS=
# Extra arguments passed to ffmpeg for the output, e.g. -preset veryfast.
FFMPEG_OUTPUT_ARGS=
### Misc ###
# Port the app listens on inside the container. Defaults to 3000. Usually left
# alone - change the host-side port via your compose file's `ports:` mapping
# instead.
PORT=3000