studio/docs
Archived
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
This repository has been archived on 2026-03-24. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
d87a2ed4ebc9ca9b6251d6252dee3a65cdd9cfb9
docs/docs/env.md

143 lines
22 KiB
Markdown
Raw Normal View History

📝(docs) describe environmental options for docs backend (#821) Signed-off-by: Berry den Hartog <38954346+berrydenhartog@users.noreply.github.com>
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
📝(project) add missing env var to env.md Update the documentation to include the missing environment variables. The missing environment variables are involved in the build process of the frontend image.
2025-05-13 15:08:18 +02:00
These are the environment variables you can set for the `impress-backend` container.
📝(docs) describe environmental options for docs backend (#821) Signed-off-by: Berry den Hartog <38954346+berrydenhartog@users.noreply.github.com>
2025-03-28 18:15:35 +01:00
| 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 |
✨(backend) allow setting session cookie age via env var We want to be able to increase the duration of the cookie session by setting an environment variable.
2025-05-16 20:07:16 +02:00
| DJANGO_EMAIL_FROM | email address used as sender | from@example.com |
📝(docs) describe environmental options for docs backend (#821) Signed-off-by: Berry den Hartog <38954346+berrydenhartog@users.noreply.github.com>
2025-03-28 18:15:35 +01:00
| 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 | |
🚩(backend) add homepage feature flag Add a homepage feature flag that we will propagate to the frontend. It will be used to enable or disable the homepage at runtime.
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 |
📝(docs) describe environmental options for docs backend (#821) Signed-off-by: Berry den Hartog <38954346+berrydenhartog@users.noreply.github.com>
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 | {} |
✨(backend) allow setting session cookie age via env var We want to be able to increase the duration of the cookie session by setting an environment variable.
2025-05-16 20:07:16 +02:00
| SESSION_COOKIE_AGE | duration of the cookie session | 60*60*12 |
📝(docs) describe environmental options for docs backend (#821) Signed-off-by: Berry den Hartog <38954346+berrydenhartog@users.noreply.github.com>
2025-03-28 18:15:35 +01:00
| 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 | |
✨(backend) allow setting session cookie age via env var We want to be able to increase the duration of the cookie session by setting an environment variable.
2025-05-16 20:07:16 +02:00
| OIDC_OP_AUTHORIZATION_ENDPOINT | Authorization endpoint for OIDC | |
📝(docs) describe environmental options for docs backend (#821) Signed-off-by: Berry den Hartog <38954346+berrydenhartog@users.noreply.github.com>
2025-03-28 18:15:35 +01:00
| OIDC_OP_TOKEN_ENDPOINT | Token endpoint for OIDC | |
| OIDC_OP_USER_ENDPOINT | User endpoint for OIDC | |
| OIDC_OP_LOGOUT_ENDPOINT | Logout endpoint for OIDC | |
✏️(project) automatic typo correction Fix typos in the project.
2025-05-13 16:00:12 +02:00
| OIDC_AUTH_REQUEST_EXTRA_PARAMS | OIDC extra auth parameters | {} |
📝(docs) describe environmental options for docs backend (#821) Signed-off-by: Berry den Hartog <38954346+berrydenhartog@users.noreply.github.com>
2025-03-28 18:15:35 +01:00
| 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 |
✨(backend) allow setting session cookie age via env var We want to be able to increase the duration of the cookie session by setting an environment variable.
2025-05-16 20:07:16 +02:00
| OIDC_ALLOW_DUPLICATE_EMAILS | Allow duplicate emails | false |
📝(docs) describe environmental options for docs backend (#821) Signed-off-by: Berry den Hartog <38954346+berrydenhartog@users.noreply.github.com>
2025-03-28 18:15:35 +01:00
| USER_OIDC_ESSENTIAL_CLAIMS | essential claims in OIDC token | [] |
➕(backend) add `django-lasuite` dependency Use the OIDC backend from the new library and add settings to setup OIDC token storage required for later calls to OIDC Resource Servers.
2025-01-27 15:21:39 +01:00
| OIDC_USERINFO_FULLNAME_FIELDS | OIDC token claims to create full name | ["first_name", "last_name"] |
| OIDC_USERINFO_SHORTNAME_FIELD | OIDC token claims to create shortname | first_name |
📝(docs) describe environmental options for docs backend (#821) Signed-off-by: Berry den Hartog <38954346+berrydenhartog@users.noreply.github.com>
2025-03-28 18:15:35 +01:00
| 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 |
📝(doc) Update env.md add AI_FEATURE_ENABLED This is false by default. Without this env setting on true AI will not be available in the docs application. The setting was missing in the env options.
2025-05-04 13:44:17 +02:00
| AI_FEATURE_ENABLED | Enable AI options | false |
📝(docs) describe environmental options for docs backend (#821) Signed-off-by: Berry den Hartog <38954346+berrydenhartog@users.noreply.github.com>
2025-03-28 18:15:35 +01:00
| 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 |
✨(back) allow theme customnization using a configuration file We want to customize the theme by using a configuration file. This configuration file path can be defined using the settings THEME_CUSTOMIZATION_FILE_PATH. If this file does not exists or is an invalid json, an empty json object will be added in the config endpoint.
2025-05-07 11:50:04 +02:00
| CACHES_KEY_PREFIX | The prefix used to every cache keys. | docs |
✨(backend) configure lasuite.malware_detection module We want to use the malware_detection module from lasuite library. We add a new setting MALWARE_DETECTION to configure the backend we want to use. The callback is also added. It removes the file if it is not safe or change it's status in the metadata to set it as ready.
2025-05-05 15:58:36 +02:00
| MALWARE_DETECTION_BACKEND | The malware detection backend use from the django-lasuite package | lasuite.malware_detection.backends.dummy.DummyBackend |
✨(back) allow theme customnization using a configuration file We want to customize the theme by using a configuration file. This configuration file path can be defined using the settings THEME_CUSTOMIZATION_FILE_PATH. If this file does not exists or is an invalid json, an empty json object will be added in the config endpoint.
2025-05-07 11:50:04 +02:00
| MALWARE_DETECTION_PARAMETERS | A dict containing all the parameters to initiate the malware detection backend | {"callback_path": "core.malware_detection.malware_detection_callback",} |
| THEME_CUSTOMIZATION_FILE_PATH | full path to the file customizing the theme. An example is provided in src/backend/impress/configuration/theme/default.json | BASE_DIR/impress/configuration/theme/default.json |
| THEME_CUSTOMIZATION_CACHE_TIMEOUT | Cache duration for the customization settings | 86400 |
📝(project) add missing env var to env.md Update the documentation to include the missing environment variables. The missing environment variables are involved in the build process of the frontend image.
2025-05-13 15:08:18 +02:00
## impress-frontend image
These are the environment variables you can set to build the `impress-frontend` image.
📝(doc) update xl packages warning (#985) So that people know how to use the PUBLISH_AS_MIT variable Signed-off-by: virgile-dev <virgile.deville@beta.gouv.fr>
2025-05-20 21:10:54 +02:00
Depending on how you are building the front-end application, this variable is used in different ways.
If you want to build the Docker image, this variable is used as an argument in the build command.
Example:
```
docker build -f src/frontend/Dockerfile --target frontend-production --build-arg PUBLISH_AS_MIT=false docs-frontend:latest
```
If you want to build the front-end application using the yarn build command, you can edit the file `src/frontend/apps/impress/.env` with the `NODE_ENV=production` environment variable and modify it. Alternatively, you can use the listed environment variables with the prefix `NEXT_PUBLIC_` (for example, `NEXT_PUBLIC_PUBLISH_AS_MIT=false`).
Example:
```
cd src/frontend/apps/impress
NODE_ENV=production NEXT_PUBLIC_PUBLISH_AS_MIT=false yarn build
```
📝(project) add missing env var to env.md Update the documentation to include the missing environment variables. The missing environment variables are involved in the build process of the frontend image.
2025-05-13 15:08:18 +02:00
| Option | Description | default |
| ----------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| API_ORIGIN | backend domain - it uses the current domain if not initialized | |
| SW_DEACTIVATED | To not install the service worker | |
📝(doc) update xl packages warning (#985) So that people know how to use the PUBLISH_AS_MIT variable Signed-off-by: virgile-dev <virgile.deville@beta.gouv.fr>
2025-05-20 21:10:54 +02:00
| PUBLISH_AS_MIT | Removes packages whose licences are incompatible with the MIT licence (see below) | true |
Packages with licences incompatible with the MIT licence:
* `xl-docx-exporter`: [AGPL-3.0](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-docx-exporter/LICENSE),
* `xl-pdf-exporter`: [AGPL-3.0](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-pdf-exporter/LICENSE)
In `.env.development`, `PUBLISH_AS_MIT` is set to `false`, allowing developers to test Docs with all its features.
⚠️ If you run Docs in production with `PUBLISH_AS_MIT` set to `false` make sure you fulfill your [BlockNote licensing](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-pdf-exporter/LICENSE) or [subscription](https://www.blocknotejs.org/about#partner-with-us) obligations.
Reference in New Issue Copy Permalink