Configuration

Environment variables

Add your environment variables in app.env file.

General

ALLOWED_HOSTS

domains allowed to be used by your instance. Support comma separated values.

Example:

ALLOWED_HOSTS=mysite.fr  # ALLOWED_HOSTS=mysite.fr,my.other.site.fr

SECRET_KEY

unique secret key for your instance. (https://djecrety.ir/)

Example:

SECRET_KEY=zbesj@t3_&u75&l=xk@ftg1yh4wy)i)9!z+(v$ig7*-*lkd6om

SSL_ENABLED

Set true if your site is behind ssl proxy.

Example:

SSL_ENABLED=True

Default:

False

OIDC Connect

To allow OIDC login, you should configure these settings.

OIDC_ENABLE_LOGIN

Enable OIDC connect login.

Example:

OIDC_ENABLE_LOGIN=True

Default:

False

OIDC_DISABLE_INTERNAL_LOGIN

Disable internal login if OIDC enabled. (direct redirection to OIDC login)

Example:

OIDC_DISABLE_INTERNAL_LOGIN=True

Default:

False

OIDC_AUTH_SERVER

Set your OIDC Realm URL.

Example:

OIDC_AUTH_SERVER=https://your.openid.com/realms/master

OIDC_AUTH_CLIENT_ID

Set your OIDC Client ID.

Example:

OIDC_AUTH_CLIENT_ID=your-client-id

OIDC_AUTH_CLIENT_SECRET

Set your OIDC Client secret.

Example:

OIDC_AUTH_CLIENT_SECRET=7GcKm7XiWIE6BRscGHZZku

OIDC_AUTH_SCOPE

Set your OIDC Client scope. Support comma separated values.

Example:

OIDC_AUTH_SCOPE=openid,email

Default:

openid

SENTRY

SENTRY_DSN

Set your SENTRY_DSN to enable sentry reporting.

Example:

SENTRY_DSN=https://your.sentry/dsn

Default:

None

SENTRY_TRACE_SAMPLE_RATE

Specify trace sample rate for your performance tracking.

Example:

SENTRY_TRACE_SAMPLE_RATE=1.0

Default:

0.2

SENTRY_PROFILES_SAMPLE_RATE

Specify profiles sample rate for your performance tracking.

Example:

SENTRY_PROFILES_SAMPLE_RATE=1.0

Default:

0.2

SENTRY_SEND_DEFAULT_PII

Specify if sentry enable user informations.

Example:

SENTRY_SEND_DEFAULT_PII=False

Default:

True

API Schemas

API_SCHEMA

Set true if you want to expose API openapi schema. It expose /api/schema/ endpoint.

Example:

API_SCHEMA=True

Default:

False

API_SWAGGER

Set true if you want to expose API swagger. API_SCHEMA should be enabled. It expose /api/schema/swagger/ endpoint.

Example:

API_SWAGGER=True

Default:

False

API_REDOC

Set true if you want to expose API redoc. API_SCHEMA should be enabled. It expose /api/schema/redoc/ endpoint.

Example:

API_REDOC=True

Default:

False