From 890c5b986cf82245b13cd0594dc198a99075e918 Mon Sep 17 00:00:00 2001 From: Thomas Kaul <4159106+dtslvr@users.noreply.github.com> Date: Wed, 10 Jul 2024 17:22:47 +0200 Subject: [PATCH] Feature/improve formatting of variables in README.md (#3546) --- README.md | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index ef2021b27..42c8220fc 100644 --- a/README.md +++ b/README.md @@ -87,21 +87,21 @@ We provide official container images hosted on [Docker Hub](https://hub.docker.c | 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) | -| `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 | +| `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) | +| `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 | ### Run with Docker Compose @@ -233,18 +233,18 @@ Deprecated: `GET http://localhost:3333/api/v1/auth/anonymous/