2025-03-28 18:15:35 +01:00
|
|
|
# Docs variables
|
|
|
|
|
|
|
|
|
|
Here we describe all environment variables that can be set for the docs application.
|
|
|
|
|
|
|
|
|
|
## impress-backend container
|
|
|
|
|
|
|
|
|
|
These are the environmental variables you can set for the impress-backend container.
|
|
|
|
|
|
|
|
|
|
| Option | Description | default |
|
|
|
|
|
| ----------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
|
|
|
|
|
| DJANGO_ALLOWED_HOSTS | allowed hosts | [] |
|
|
|
|
|
| DJANGO_SECRET_KEY | secret key | |
|
|
|
|
|
| DJANGO_SERVER_TO_SERVER_API_TOKENS | | [] |
|
|
|
|
|
| DB_ENGINE | engine to use for database connections | django.db.backends.postgresql_psycopg2 |
|
|
|
|
|
| DB_NAME | name of the database | impress |
|
|
|
|
|
| DB_USER | user to authenticate with | dinum |
|
|
|
|
|
| DB_PASSWORD | password to authenticate with | pass |
|
|
|
|
|
| DB_HOST | host of the database | localhost |
|
|
|
|
|
| DB_PORT | port of the database | 5432 |
|
|
|
|
|
| MEDIA_BASE_URL | | |
|
|
|
|
|
| STORAGES_STATICFILES_BACKEND | | whitenoise.storage.CompressedManifestStaticFilesStorage |
|
|
|
|
|
| AWS_S3_ENDPOINT_URL | S3 endpoint | |
|
|
|
|
|
| AWS_S3_ACCESS_KEY_ID | access id for s3 endpoint | |
|
|
|
|
|
| AWS_S3_SECRET_ACCESS_KEY | access key for s3 endpoint | |
|
|
|
|
|
| AWS_S3_REGION_NAME | region name for s3 endpoint | |
|
|
|
|
|
| AWS_STORAGE_BUCKET_NAME | bucket name for s3 endpoint | impress-media-storage |
|
|
|
|
|
| DOCUMENT_IMAGE_MAX_SIZE | maximum size of document in bytes | 10485760 |
|
|
|
|
|
| LANGUAGE_CODE | default language | en-us |
|
|
|
|
|
| API_USERS_LIST_THROTTLE_RATE_SUSTAINED | throttle rate for api | 180/hour |
|
|
|
|
|
| API_USERS_LIST_THROTTLE_RATE_BURST | throttle rate for api on burst | 30/minute |
|
|
|
|
|
| SPECTACULAR_SETTINGS_ENABLE_DJANGO_DEPLOY_CHECK | | false |
|
|
|
|
|
| TRASHBIN_CUTOFF_DAYS | trashbin cutoff | 30 |
|
|
|
|
|
| DJANGO_EMAIL_BACKEND | email backend library | django.core.mail.backends.smtp.EmailBackend |
|
|
|
|
|
| DJANGO_EMAIL_BRAND_NAME | brand name for email | |
|
|
|
|
|
| DJANGO_EMAIL_HOST | host name of email | |
|
|
|
|
|
| DJANGO_EMAIL_HOST_USER | user to authenticate with on the email host | |
|
|
|
|
|
| DJANGO_EMAIL_HOST_PASSWORD | password to authenticate with on the email host | |
|
|
|
|
|
| DJANGO_EMAIL_LOGO_IMG | logo for the email | |
|
|
|
|
|
| DJANGO_EMAIL_PORT | port used to connect to email host | |
|
|
|
|
|
| DJANGO_EMAIL_USE_TLS | use tls for email host connection | false |
|
|
|
|
|
| DJANGO_EMAIL_USE_SSL | use sstl for email host connection | false |
|
|
|
|
|
| DJANGO_EMAIL_FROM | email adress used as sender | from@example.com |
|
|
|
|
|
| DJANGO_CORS_ALLOW_ALL_ORIGINS | allow all CORS origins | true |
|
|
|
|
|
| DJANGO_CORS_ALLOWED_ORIGINS | list of origins allowed for CORS | [] |
|
|
|
|
|
| DJANGO_CORS_ALLOWED_ORIGIN_REGEXES | list of origins allowed for CORS using regulair expressions | [] |
|
|
|
|
|
| SENTRY_DSN | sentry host | |
|
|
|
|
|
| COLLABORATION_API_URL | collaboration api host | |
|
|
|
|
|
| COLLABORATION_SERVER_SECRET | collaboration api secret | |
|
|
|
|
|
| COLLABORATION_WS_URL | collaboration websocket url | |
|
2025-04-09 15:32:25 +02:00
|
|
|
| FRONTEND_CSS_URL | To add a external css file to the app | |
|
|
|
|
|
| FRONTEND_HOMEPAGE_FEATURE_ENABLED | frontend feature flag to display the homepage | false |
|
|
|
|
|
| FRONTEND_FOOTER_FEATURE_ENABLED | frontend feature flag to display the footer | false |
|
|
|
|
|
| FRONTEND_FOOTER_VIEW_CACHE_TIMEOUT | Cache duration of the json footer | 86400 |
|
|
|
|
|
| FRONTEND_URL_JSON_FOOTER | Url with a json to configure the footer | |
|
2025-03-28 18:15:35 +01:00
|
|
|
| FRONTEND_THEME | frontend theme to use | |
|
|
|
|
|
| POSTHOG_KEY | posthog key for analytics | |
|
|
|
|
|
| CRISP_WEBSITE_ID | crisp website id for support | |
|
|
|
|
|
| DJANGO_CELERY_BROKER_URL | celery broker url | redis://redis:6379/0 |
|
|
|
|
|
| DJANGO_CELERY_BROKER_TRANSPORT_OPTIONS | celery broker transport options | {} |
|
|
|
|
|
| OIDC_CREATE_USER | create used on OIDC | false |
|
|
|
|
|
| OIDC_RP_SIGN_ALGO | verification algorithm used OIDC tokens | RS256 |
|
|
|
|
|
| OIDC_RP_CLIENT_ID | client id used for OIDC | impress |
|
|
|
|
|
| OIDC_RP_CLIENT_SECRET | client secret used for OIDC | |
|
|
|
|
|
| OIDC_OP_JWKS_ENDPOINT | JWKS endpoint for OIDC | |
|
|
|
|
|
| OIDC_OP_AUTHORIZATION_ENDPOINT | Autorization endpoint for OIDC | |
|
|
|
|
|
| OIDC_OP_TOKEN_ENDPOINT | Token endpoint for OIDC | |
|
|
|
|
|
| OIDC_OP_USER_ENDPOINT | User endpoint for OIDC | |
|
|
|
|
|
| OIDC_OP_LOGOUT_ENDPOINT | Logout endpoint for OIDC | |
|
|
|
|
|
| OIDC_AUTH_REQUEST_EXTRA_PARAMS | OIDC extra auth paramaters | {} |
|
|
|
|
|
| OIDC_RP_SCOPES | scopes requested for OIDC | openid email |
|
|
|
|
|
| LOGIN_REDIRECT_URL | login redirect url | |
|
|
|
|
|
| LOGIN_REDIRECT_URL_FAILURE | login redirect url on failure | |
|
|
|
|
|
| LOGOUT_REDIRECT_URL | logout redirect url | |
|
|
|
|
|
| OIDC_USE_NONCE | use nonce for OIDC | true |
|
|
|
|
|
| OIDC_REDIRECT_REQUIRE_HTTPS | Require https for OIDC redirect url | false |
|
|
|
|
|
| OIDC_REDIRECT_ALLOWED_HOSTS | Allowed hosts for OIDC redirect url | [] |
|
|
|
|
|
| OIDC_STORE_ID_TOKEN | Store OIDC token | true |
|
|
|
|
|
| OIDC_FALLBACK_TO_EMAIL_FOR_IDENTIFICATION | faillback to email for identification | true |
|
|
|
|
|
| OIDC_ALLOW_DUPLICATE_EMAILS | Allow dupplicate emails | false |
|
|
|
|
|
| USER_OIDC_ESSENTIAL_CLAIMS | essential claims in OIDC token | [] |
|
|
|
|
|
| USER_OIDC_FIELDS_TO_FULLNAME | OIDC token claims to create full name | ["first_name", "last_name"] |
|
|
|
|
|
| USER_OIDC_FIELD_TO_SHORTNAME | OIDC token claims to create shortname | first_name |
|
|
|
|
|
| ALLOW_LOGOUT_GET_METHOD | Allow get logout method | true |
|
|
|
|
|
| AI_API_KEY | AI key to be used for AI Base url | |
|
|
|
|
|
| AI_BASE_URL | OpenAI compatible AI base url | |
|
|
|
|
|
| AI_MODEL | AI Model to use | |
|
|
|
|
|
| AI_ALLOW_REACH_FROM | Users that can use AI must be this level. options are "public", "authenticated", "restricted" | authenticated |
|
|
|
|
|
| Y_PROVIDER_API_KEY | Y provider API key | |
|
|
|
|
|
| Y_PROVIDER_API_BASE_URL | Y Provider url | |
|
|
|
|
|
| CONVERSION_API_ENDPOINT | Conversion API endpoint | convert-markdown |
|
|
|
|
|
| CONVERSION_API_CONTENT_FIELD | Conversion api content field | content |
|
|
|
|
|
| CONVERSION_API_TIMEOUT | Conversion api timeout | 30 |
|
|
|
|
|
| CONVERSION_API_SECURE | Require secure conversion api | false |
|
|
|
|
|
| LOGGING_LEVEL_LOGGERS_ROOT | default logging level. options are "DEBUG", "INFO", "WARN", "ERROR", "CRITICAL" | INFO |
|
|
|
|
|
| LOGGING_LEVEL_LOGGERS_APP | application logging level. options are "DEBUG", "INFO", "WARN", "ERROR", "CRITICAL" | INFO |
|
|
|
|
|
| API_USERS_LIST_LIMIT | Limit on API users | 5 |
|
|
|
|
|
| DJANGO_CSRF_TRUSTED_ORIGINS | CSRF trusted origins | [] |
|
|
|
|
|
| REDIS_URL | cache url | redis://redis:6379/1 |
|
|
|
|
|
| CACHES_DEFAULT_TIMEOUT | cache default timeout | 30 |
|
