Skip to content

Commit dcce611

Browse files
ramonsmitszackpollard
authored andcommitted
docs: document DB_STORAGE_TYPE environment variable (#19609)
Co-authored-by: Zack Pollard <[email protected]>
1 parent 18173d3 commit dcce611

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

docs/docs/install/environment-variables.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,22 +72,25 @@ Information on the current workers can be found [here](/docs/administration/jobs
7272

7373
## Database
7474

75-
| Variable | Description | Default | Containers |
76-
| :---------------------------------- | :--------------------------------------------------------------------------- | :--------: | :----------------------------- |
77-
| `DB_URL` | Database URL | | server |
78-
| `DB_HOSTNAME` | Database host | `database` | server |
79-
| `DB_PORT` | Database port | `5432` | server |
80-
| `DB_USERNAME` | Database user | `postgres` | server, database<sup>\*1</sup> |
81-
| `DB_PASSWORD` | Database password | `postgres` | server, database<sup>\*1</sup> |
82-
| `DB_DATABASE_NAME` | Database name | `immich` | server, database<sup>\*1</sup> |
83-
| `DB_SSL_MODE` | Database SSL mode | | server |
84-
| `DB_VECTOR_EXTENSION`<sup>\*2</sup> | Database vector extension (one of [`vectorchord`, `pgvector`, `pgvecto.rs`]) | | server |
85-
| `DB_SKIP_MIGRATIONS` | Whether to skip running migrations on startup (one of [`true`, `false`]) | `false` | server |
75+
| Variable | Description | Default | Containers |
76+
| :---------------------------------- | :------------------------------------------------------------------------------------- | :--------: | :----------------------------- |
77+
| `DB_URL` | Database URL | | server |
78+
| `DB_HOSTNAME` | Database host | `database` | server |
79+
| `DB_PORT` | Database port | `5432` | server |
80+
| `DB_USERNAME` | Database user | `postgres` | server, database<sup>\*1</sup> |
81+
| `DB_PASSWORD` | Database password | `postgres` | server, database<sup>\*1</sup> |
82+
| `DB_DATABASE_NAME` | Database name | `immich` | server, database<sup>\*1</sup> |
83+
| `DB_SSL_MODE` | Database SSL mode | | server |
84+
| `DB_VECTOR_EXTENSION`<sup>\*2</sup> | Database vector extension (one of [`vectorchord`, `pgvector`, `pgvecto.rs`]) | | server |
85+
| `DB_SKIP_MIGRATIONS` | Whether to skip running migrations on startup (one of [`true`, `false`]) | `false` | server |
86+
| `DB_STORAGE_TYPE` | Optimize concurrent IO on SSDs or sequential IO on HDDs ([`SSD`, `HDD`])<sup>\*3</sup> | `SSD` | server |
8687

8788
\*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`.
8889

8990
\*2: If not provided, the appropriate extension to use is auto-detected at startup by introspecting the database. When multiple extensions are installed, the order of preference is VectorChord, pgvecto.rs, pgvector.
9091

92+
\*3: Uses either [`postgresql.ssd.conf`](https://github.com/immich-app/base-images/blob/main/postgres/postgresql.ssd.conf) or [`postgresql.hdd.conf`](https://github.com/immich-app/base-images/blob/main/postgres/postgresql.hdd.conf) which mainly controls the Postgres `effective_io_concurrency` setting to allow for concurrenct IO on SSDs and sequential IO on HDDs.
93+
9194
:::info
9295

9396
All `DB_` variables must be provided to all Immich workers, including `api` and `microservices`.

0 commit comments

Comments
 (0)