10000 📝(docs) describe environmental options for docs backend (#821) · ag-python/docs@3e974be · GitHub
[go: up one dir, main page]
Skip to content

Commit 3e974be

Browse files
berrydenhartogberrydenhartog
authored
📝(docs) describe environmental options for docs backend (suitenumerique#821)
Signed-off-by: Berry den Hartog <38954346+berrydenhartog@users.noreply.github.com>
1 parent 10f9d25 commit 3e974be

File tree

2 files changed

+104
-11
lines changed

2 files changed

+104
-11
lines changed

‎docs/env.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Docs variables
2+
3+
Here we describe all environment variables that can be set for the docs application.
4+
5+
## impress-backend container
6+
7+
These are the environmental variables you can set for the impress-backend container.
8+
9+
| Option | Description | default |
10+
| ----------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
11+
| DJANGO_ALLOWED_HOSTS | allowed hosts | [] |
12+
| DJANGO_SECRET_KEY | secret key | |
13+
| DJANGO_SERVER_TO_SERVER_API_TOKENS | | [] |
14+
| DB_ENGINE | engine to use for database connections | django.db.backends.postgresql_psycopg2 |
15+
| DB_NAME | name of the database | impress |
16+
| DB_USER | user to authenticate with | dinum |
17+
| DB_PASSWORD | password to authenticate with | pass |
18+
| DB_HOST | host of the database | localhost |
19+
| DB_PORT | port of the database | 5432 |
20+
| MEDIA_BASE_URL | | |
21+
| STORAGES_STATICFILES_BACKEND | | whitenoise.storage.CompressedManifestStaticFilesStorage |
22+
| AWS_S3_ENDPOINT_URL | S3 endpoint | |
23+
| AWS_S3_ACCESS_KEY_ID | access id for s3 endpoint | |
24+
| AWS_S3_SECRET_ACCESS_KEY | access key for s3 endpoint | |
25+
| AWS_S3_REGION_NAME | region name for s3 endpoint | |
26+
| AWS_STORAGE_BUCKET_NAME | bucket name for s3 endpoint | impress-media-storage |
27+
| DOCUMENT_IMAGE_MAX_SIZE | maximum size of document in bytes | 10485760 |
28+
| LANGUAGE_CODE | default language | en-us |
29+
| API_USERS_LIST_THROTTLE_RATE_SUSTAINED | throttle rate for api | 180/hour |
30+
| API_USERS_LIST_THROTTLE_RATE_BURST | throttle rate for api on burst | 30/minute |
31+
| SPECTACULAR_SETTINGS_ENABLE_DJANGO_DEPLOY_CHECK | | false |
32+
| TRASHBIN_CUTOFF_DAYS | trashbin cutoff | 30 |
33+
| DJANGO_EMAIL_BACKEND | email backend library | django.core.mail.backends.smtp.EmailBackend |
34+
| DJANGO_EMAIL_BRAND_NAME | brand name for email | |
35+
| DJANGO_EMAIL_HOST | host name of email | |
36+
| DJANGO_EMAIL_HOST_USER | user to authenticate with on the email host | |
37+
| DJANGO_EMAIL_HOST_PASSWORD | password to authenticate with on the email host | |
38+
| DJANGO_EMAIL_LOGO_IMG | logo for the email | |
39+
| DJANGO_EMAIL_PORT | port used to connect to email host | |
40+
| DJANGO_EMAIL_USE_TLS | use tls for email host connection | false |
41+
| DJANGO_EMAIL_USE_SSL | use sstl for email host connection | false |
42+
| DJANGO_EMAIL_FROM | email adress used as sender | from@example.com |
43+
| DJANGO_CORS_ALLOW_ALL_ORIGINS | allow all CORS origins | true |
44+
| DJANGO_CORS_ALLOWED_ORIGINS | list of origins allowed for CORS | [] |
45+
| DJANGO_CORS_ALLOWED_ORIGIN_REGEXES | list of origins allowed for CORS using regulair expressions | [] |
46+
| SENTRY_DSN | sentry host | |
47+
| COLLABORATION_API_URL | collaboration api host | |
48+
| COLLABORATION_SERVER_SECRET | collaboration api secret | |
49+
| COLLABORATION_WS_URL | collaboration websocket url | |
50+
| FRONTEND_THEME | frontend theme to use | |
51+
| POSTHOG_KEY | posthog key for analytics | |
52+
| CRISP_WEBSITE_ID | crisp website id for support | |
53+
| DJANGO_CELERY_BROKER_URL | celery broker url | redis://redis:6379/0 |
54+
| DJANGO_CELERY_BROKER_TRANSPORT_OPTIONS | celery broker transport options | {} |
55+
| OIDC_CREATE_USER | create used on OIDC | false |
56+
| OIDC_RP_SIGN_ALGO | verification algorithm used OIDC tokens | RS256 |
57+
| OIDC_RP_CLIENT_ID | client id used for OIDC | impress |
58+
| OIDC_RP_CLIENT_SECRET | client secret used for OIDC | |
59+
| OIDC_OP_JWKS_ENDPOINT | JWKS endpoint for OIDC | |
60+
| OIDC_OP_AUTHORIZATION_ENDPOINT | Autorization endpoint for OIDC | |
61+
| OIDC_OP_TOKEN_ENDPOINT | Token endpoint for OIDC | |
62+
| OIDC_OP_USER_ENDPOINT | User endpoint for OIDC | |
63+
| OIDC_OP_LOGOUT_ENDPOINT | Logout endpoint for OIDC | |
64+
| OIDC_AUTH_REQUEST_EXTRA_PARAMS | OIDC extra auth paramaters | {} |
65+
| OIDC_RP_SCOPES | scopes requested for OIDC | openid email |
66+
| LOGIN_REDIRECT_URL | login redirect url | |
67+
| LOGIN_REDIRECT_URL_FAILURE | login redirect url on failure | |
68+
| LOGOUT_REDIRECT_URL | logout redirect url | |
69+
| OIDC_USE_NONCE | use nonce for OIDC | true |
70+
| OIDC_REDIRECT_REQUIRE_HTTPS | Require https for OIDC redirect url | false |
71+
| OIDC_REDIRECT_ALLOWED_HOSTS | Allowed hosts for OIDC redirect url | [] |
72+
| OIDC_STORE_ID_TOKEN | Store OIDC token | true |
73+
| OIDC_FALLBACK_TO_EMAIL_FOR_IDENTIFICATION | faillback to email for identification | true |
74+
| OIDC_ALLOW_DUPLICATE_EMAILS | Allow dupplicate emails | false |
75+
| USER_OIDC_ESSENTIAL_CLAIMS | essential claims in OIDC token | [] |
76+
| USER_OIDC_FIELDS_TO_FULLNAME | OIDC token claims to create full name | ["first_name", "last_name"] |
77+
| USER_OIDC_FIELD_TO_SHORTNAME | OIDC token claims to create shortname | first_name |
78+
| ALLOW_LOGOUT_GET_METHOD | Allow get logout method | true |
79+
| AI_API_KEY | AI key to be used for AI Base url | |
80+
| AI_BASE_URL | OpenAI compatible AI base url | |
81+
| AI_MODEL | AI Model to use | |
82+
| AI_ALLOW_REACH_FROM | Users that can use AI must be this level. options are "public", "authenticated", "restricted" | authenticated |
83+
| Y_PROVIDER_API_KEY | Y provider API key | |
84+
| Y_PROVIDER_API_BASE_URL | Y Provider url | |
85+
| CONVERSION_API_ENDPOINT | Conversion API endpoint | convert-markdown |
86+
| CONVERSION_API_CONTENT_FIELD | Conversion api content field | content |
87+
| CONVERSION_API_TIMEOUT | Conversion api timeout | 30 |
88+
| CONVERSION_API_SECURE | Require secure conversion api | false |
89+
| LOGGING_LEVEL_LOGGERS_ROOT | default logging level. options are "DEBUG", "INFO", "WARN", "ERROR", "CRITICAL" | INFO |
90+
| LOGGING_LEVEL_LOGGERS_APP | application logging level. options are "DEBUG", "INFO", "WARN", "ERROR", "CRITICAL" | INFO |
91+
| API_USERS_LIST_LIMIT | Limit on API users | 5 |
92+
| DJANGO_CSRF_TRUSTED_ORIGINS | CSRF trusted origins | [] |
93+
| REDIS_URL | cache url | redis://redis:6379/1 |
94+
| CACHES_DEFAULT_TIMEOUT | cache default timeout | 30 |

0 commit comments

Comments
 (0)
0