Skip to content

docs: document DB_STORAGE_TYPE environment variable #19609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 1, 2025

Conversation

ramonsmits
Copy link
Contributor

Description

Document DB_STORAGE_TYPE, I was pointed to this setting on Discord:

https://github.com/immich-app/immich/blob/main/docker/docker-compose.yml#L65-L66`

How Has This Been Tested?

  1. Added envvar to docker compose
  2. Started it
  3. Observed mmich_postgres | Using HDD storage in the logs indicating the envvar was found and used.

Checklist:

NA, no code change, only docs update.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 29, 2025
@danieldietzler
Copy link
Member

I was considering adding an explanation there but I guess people don't actually care about the technical background/what it does.

@ramonsmits
Copy link
Contributor Author

I was considering adding an explanation there but I guess people don't actually care about the technical background/what it does.

I can add it but I don't know what is controls. I would actually want to know :-)

@aviv926
Copy link
Collaborator

aviv926 commented Jun 29, 2025

I was considering adding an explanation there but I guess people don't actually care about the technical background/what it does.

I can add it but I don't know what is controls. I would actually want to know :-)

See here: https://github.com/immich-app/immich/releases/tag/v1.133.0

@mmomjian
Copy link
Collaborator

Can you please follow the syntax with square brackets as in other ENV options?

No need to write out the default, we have a column for that.

@danieldietzler
Copy link
Member

danieldietzler commented Jun 29, 2025

@aviv926 I don't think that page explains it at all? It chooses which of the two postgresql.conf to use from here https://github.com/immich-app/base-images/tree/main/postgres

@ramonsmits
Copy link
Contributor Author

Can you please follow the syntax with square brackets as in other ENV options?

Done

Also added information to what it actually does as @danieldietzler also hinted.

@aviv926
Copy link
Collaborator

aviv926 commented Jun 29, 2025

@aviv926 I don't think that page explains it at all? It chooses which of the two postgresql.conf to use from here https://github.com/immich-app/base-images/tree/main/postgres

I thought he was looking for the simple explanation as explained in the release notes.

Why does it matter whether my database is on an SSD or an HDD?
These storage mediums have different performance characteristics. As a result, the optimal settings for an SSD are not the same as those for an HDD. Either configuration is compatible with SSD and HDD, but using the right configuration will make Immich snappier. As a general tip, we recommend users store the database on an SSD whenever possible.

@alextran1502 alextran1502 changed the title Document DB_STORAGE_TYPE environment variable docs: document DB_STORAGE_TYPE environment variable Jun 30, 2025
@alextran1502 alextran1502 added the fix:formatting Automatically fix formatting on a PR label Jul 1, 2025
@zackpollard zackpollard enabled auto-merge (squash) July 1, 2025 10:26
@zackpollard zackpollard merged commit 639ede7 into immich-app:main Jul 1, 2025
44 of 45 checks passed
danieldietzler pushed a commit that referenced this pull request Jul 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog:documentation documentation Improvements or additions to documentation fix:formatting Automatically fix formatting on a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants