diff --git a/docs/docs/install/environment-variables.md b/docs/docs/install/environment-variables.md index 6f06539dc6..0e6a278f3e 100644 --- a/docs/docs/install/environment-variables.md +++ b/docs/docs/install/environment-variables.md @@ -17,10 +17,11 @@ If this should not work, try running `docker compose up -d --force-recreate`. ## Docker Compose -| Variable | Description | Default | Services | -| :---------------- | :-------------------- | :-------: | :-------------------------------------- | -| `IMMICH_VERSION` | Image tags | `release` | server, microservices, machine learning | -| `UPLOAD_LOCATION` | Host Path for uploads | | server, microservices | +| Variable | Description | Default | Services | +| :----------------- | :------------------------------ | :-------: | :-------------------------------------- | +| `IMMICH_VERSION` | Image tags | `release` | server, microservices, machine learning | +| `UPLOAD_LOCATION` | Host Path for uploads | | server, microservices | +| `DB_DATA_LOCATION` | Host Path for Postgres database | | database | :::tip @@ -58,18 +59,20 @@ These environment variables are used by the `docker-compose.yml` file and do **N ## Database -| Variable | Description | Default | Services | -| :---------------------------------- | :----------------------------------------------------------------------- | :----------: | :-------------------- | -| `DB_URL` | Database URL | | server, microservices | -| `DB_HOSTNAME` | Database Host | `database` | server, microservices | -| `DB_PORT` | Database Port | `5432` | server, microservices | -| `DB_USERNAME` | Database User | `postgres` | server, microservices | -| `DB_PASSWORD` | Database Password | `postgres` | server, microservices | -| `DB_DATABASE_NAME` | Database Name | `immich` | server, microservices | -| `DB_VECTOR_EXTENSION`\*1 | Database Vector Extension (one of [`pgvector`, `pgvecto.rs`]) | `pgvecto.rs` | server, microservices | -| `DB_SKIP_MIGRATIONS` | Whether to skip running migrations on startup (one of [`true`, `false`]) | `false` | server, microservices | +| Variable | Description | Default | Services | +| :---------------------------------- | :----------------------------------------------------------------------- | :----------: | :-------------------------------------------- | +| `DB_URL` | Database URL | | server, microservices | +| `DB_HOSTNAME` | Database Host | `database` | server, microservices | +| `DB_PORT` | Database Port | `5432` | server, microservices | +| `DB_USERNAME` | Database User | `postgres` | server, microservices, database\*1 | +| `DB_PASSWORD` | Database Password | `postgres` | server, microservices, database\*1 | +| `DB_DATABASE_NAME` | Database Name | `immich` | server, microservices, database\*1 | +| `DB_VECTOR_EXTENSION`\*2 | Database Vector Extension (one of [`pgvector`, `pgvecto.rs`]) | `pgvecto.rs` | server, microservices | +| `DB_SKIP_MIGRATIONS` | Whether to skip running migrations on startup (one of [`true`, `false`]) | `false` | server, microservices | -\*1: This setting cannot be changed after the server has successfully started up. +\*1: The values of `DB_USERNAME`, `DB_PASSWORD`, and `DB_DATABASE_NAME` are passed to the Postgres container as the variables `POSTGRES_USER`, `POSTGRES_PASSWORD`, and `POSTGRES_DB` in `docker-compose.yml`. + +\*2: This setting cannot be changed after the server has successfully started up. :::info @@ -101,6 +104,9 @@ More info can be found in the upstream [ioredis][redis-api] documentation. Redis (Sentinel) URL example JSON before encoding: +
+JSON + ```json { "sentinels": [ @@ -121,6 +127,8 @@ Redis (Sentinel) URL example JSON before encoding: } ``` +
+ ## Machine Learning | Variable | Description | Default | Services |