Container Port: 8000

Target

8000

Default

8000

Value

8000

Path to the media folder

Target

/home/nonroot/pdfding/media

Theme

Target

DEFAULT_THEME

Default

dark|light

Theme color

Target

DEFAULT_THEME_COLOR

Default

green|blue|red|pink|orange|gray

Used for securing signed data. Should be to a large random value.

Target

SECRET_KEY

The host/domain name where PdfDing will be reachable.

Target

HOST_NAME

Default

127.0.0.1

Value

127.0.0.1

Block users until they have verified their email address.

Target

ACCOUNT_EMAIL_VERIFICATION

Default

TRUE|FALSE

Disable user signups

Target

DISABLE_USER_SIGNUPS

Default

FALSE|TRUE

Database type

Target

DATABASE_TYPE

Default

SQLITE|POSTGRES

Postgres database host. Remove if using SQLite.

Target

POSTGRES_HOST

Postgres database port. Remove if using SQLite.

Target

POSTGRES_PORT

Default

5432

Postgres database password. Remove if using SQLite.

Target

POSTGRES_PASSWORD

Enable OpenID Connect

Target

OIDC_ENABLE

Default

FALSE|TRUE

OpenID Connect provider name

Target

OIDC_PROVIDER_NAME

OpenID Connect client ID

Target

OIDC_CLIENT_ID

OpenID Connect client secret

Target

OIDC_CLIENT_SECRET

OpenID Connect authorization URL

Target

OIDC_AUTH_URL

Require users to use OIDC

Target

OIDC_ONLY

Default

FALSE|TRUE

Whether to send account related emails, e.g a password reset or account verification, to the console or via an SMTP server.

Target

EMAIL_BACKEND

Default

CONSOLE|SMTP

SMTP server host. Remove if using the console backend.

Target

SMTP_HOST

SMTP server port. Remove if using the console backend.

Target

SMTP_PORT

Default

25

SMTP server user. Remove if using the console backend.

Target

SMTP_USER

SMTP server password. Remove if using the console backend.

Target

SMTP_PASSWORD

Secure the connection to the SMTP server with TLS. Remove if using the console backend.

Target

SMTP_USE_TLS

Default

FALSE|TRUE

Secure the connection to the SMTP server with SSL. Remove if using the console backend.

Target

SMTP_USE_SSL

Default

FALSE|TRUE

Enable the consumption folder as an alternative way for adding PDFs.

Target

CONSUME_ENABLE

Default

FALSE|TRUE

Skip the addition PDF files if the user already has PDF with the same name and file size.

Target

CONSUME_SKIP_EXISTING

Default

TRUE|FALSE

Comma separated list of tags to add to the PDFs added via the consumption folder.

Target

CONSUME_TAGS

Enable periodic backups to S3 compatible storage.

Target

BACKUP_ENABLE

Default

FALSE|TRUE

S3 compatible storage endpoint. Remove if not using backups.

Target

BACKUP_ENDPOINT

S3 compatible storage access key. Remove if not using backups.

Target

BACKUP_ACCESS_KEY

S3 compatible storage secret key. Remove if not using backups.

Target

BACKUP_SECRET_KEY

S3 compatible storage bucket. Remove if not using backups.

Target

BACKUP_BUCKET_NAME

Cron schedule for the backups. Default is midnight every day.

Target

BACKUP_SCHEDULE

Default

0 0 * * *

Secure the connection to the S3 compatible storage with TLS.

Target

BACKUP_SECURE

Default

FALSE|TRUE

Encrypt the backups before uploading them to the S3 compatible storage.

Target

BACKUP_ENCRYPTION_ENABLE

Default

FALSE|TRUE

Password to encrypt the backups. Remove if not using encryption.

Target

BACKUP_ENCRYPTION_PASSWORD

Salt to encrypt the backups. Remove if not using encryption.

Target

BACKUP_ENCRYPTION_SALT

Path to the SQLite database folder. Remove if using Postgres. May need to update write permissions.

Target

/home/nonroot/pdfding/db

Default

/mnt/user/appdata/pdfding/db

Value

/mnt/user/appdata/pdfding/db

Default

1000

Value

1000

Default

1000

Value

1000

Log level

Target

LOG_LEVEL

Default

ERROR|WARN|INFO|DEBUG

Set this to TRUE to avoid transmitting the CSRF cookie over HTTP accidentally.

Target

CSRF_COOKIE_SECURE

Default

TRUE|FALSE

Set this to TRUE to avoid transmitting the session cookie over HTTP accidentally.

Target

SESSION_COOKIE_SECURE

Default

TRUE|FALSE

Redirects all non-HTTPS requests to HTTPS. If PdfDing is running behind a reverse proxy this can cause infinite redirects.

Target

SECURE_SSL_REDIRECT

Default

FALSE|TRUE

See details: https://github.com/mrmn2/PdfDing/blob/master/docs/configuration.md#secure_hsts_seconds

Target

SECURE_HSTS_SECONDS

The default protocol for account related URLs, e.g. for the password forgotten procedure.

Target

ACCOUNT_DEFAULT_HTTP_PROTOCOL

Default

https|http

The port where the internal server is reachable. Not recommended to change.

Target

HOST_PORT

Default

8000

Value

8000