Skip to content

Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍

Task/extend documentation by ENABLE_FEATURE_AUTH_TOKEN environment variable (#6189)

Wolfgang72ffef1ab8bc
diff --git a/README.md b/README.md
index 35276b2329..8b6fe22962 100644
--- a/README.md
+++ b/README.md
@@ -85,31 +85,32 @@ We provide official container images hosted on [Docker Hub](https://hub.docker.c
### Supported Environment Variables
-| Name | Type | Default Value | Description |
-| ------------------------ | --------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
-| `ACCESS_TOKEN_SALT` | `string` | | A random string used as salt for access tokens |
-| `API_KEY_COINGECKO_DEMO` | `string` (optional) |   | The _CoinGecko_ Demo API key |
-| `API_KEY_COINGECKO_PRO` | `string` (optional) | | The _CoinGecko_ Pro API key |
-| `DATABASE_URL` | `string` | | The database connection URL, e.g. `postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:5432/${POSTGRES_DB}?sslmode=prefer` |
-| `HOST` | `string` (optional) | `0.0.0.0` | The host where the Ghostfolio application will run on |
-| `JWT_SECRET_KEY` | `string` | | A random string used for _JSON Web Tokens_ (JWT) |
-| `LOG_LEVELS` | `string[]` (optional) | | The logging levels for the Ghostfolio application, e.g. `["debug","error","log","warn"]` |
-| `PORT` | `number` (optional) | `3333` | The port where the Ghostfolio application will run on |
-| `POSTGRES_DB` | `string` | | The name of the _PostgreSQL_ database |
-| `POSTGRES_PASSWORD` | `string` | | The password of the _PostgreSQL_ database |
-| `POSTGRES_USER` | `string` | | The user of the _PostgreSQL_ database |
-| `REDIS_DB` | `number` (optional) | `0` | The database index of _Redis_ |
-| `REDIS_HOST` | `string` | | The host where _Redis_ is running |
-| `REDIS_PASSWORD` | `string` | | The password of _Redis_ |
-| `REDIS_PORT` | `number` | | The port where _Redis_ is running |
-| `REQUEST_TIMEOUT` | `number` (optional) | `2000` | The timeout of network requests to data providers in milliseconds |
-| `ROOT_URL` | `string` (optional) | `http://0.0.0.0:3333` | The root URL of the Ghostfolio application, used for generating callback URLs and external links. |
+| Name | Type | Default Value | Description |
+| --------------------------- | --------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `ACCESS_TOKEN_SALT` | `string` | | A random string used as salt for access tokens |
+| `API_KEY_COINGECKO_DEMO` | `string` (optional) |   | The _CoinGecko_ Demo API key |
+| `API_KEY_COINGECKO_PRO` | `string` (optional) | | The _CoinGecko_ Pro API key |
+| `DATABASE_URL` | `string` | | The database connection URL, e.g. `postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:5432/${POSTGRES_DB}?sslmode=prefer` |
+| `ENABLE_FEATURE_AUTH_TOKEN` | `boolean` (optional) | `true` | Enables authentication via security token |
+| `HOST` | `string` (optional) | `0.0.0.0` | The host where the Ghostfolio application will run on |
+| `JWT_SECRET_KEY` | `string` | | A random string used for _JSON Web Tokens_ (JWT) |
+| `LOG_LEVELS` | `string[]` (optional) | | The logging levels for the Ghostfolio application, e.g. `["debug","error","log","warn"]` |
+| `PORT` | `number` (optional) | `3333` | The port where the Ghostfolio application will run on |
+| `POSTGRES_DB` | `string` | | The name of the _PostgreSQL_ database |
+| `POSTGRES_PASSWORD` | `string` | | The password of the _PostgreSQL_ database |
+| `POSTGRES_USER` | `string` | | The user of the _PostgreSQL_ database |
+| `REDIS_DB` | `number` (optional) | `0` | The database index of _Redis_ |
+| `REDIS_HOST` | `string` | | The host where _Redis_ is running |
+| `REDIS_PASSWORD` | `string` | | The password of _Redis_ |
+| `REDIS_PORT` | `number` | | The port where _Redis_ is running |
+| `REQUEST_TIMEOUT` | `number` (optional) | `2000` | The timeout of network requests to data providers in milliseconds |
+| `ROOT_URL` | `string` (optional) | `http://0.0.0.0:3333` | The root URL of the Ghostfolio application, used for generating callback URLs and external links. |
#### OpenID Connect OIDC (Experimental)
| Name | Type | Default Value | Description |
| -------------------------- | --------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------- |
-| `ENABLE_FEATURE_AUTH_OIDC` | `boolean` (optional) | `false` | Enables _OpenID Connect_ authentication |
+| `ENABLE_FEATURE_AUTH_OIDC` | `boolean` (optional) | `false` | Enables authentication via _OpenID Connect_ |
| `OIDC_AUTHORIZATION_URL` | `string` (optional) | | Manual override for the OIDC authorization endpoint (falls back to the discovery from the issuer) |
| `OIDC_CALLBACK_URL` | `string` (optional) | `${ROOT_URL}/api/auth/oidc/callback` | The OIDC callback URL |
| `OIDC_CLIENT_ID` | `string` | | The OIDC client ID |