Skip to content
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

docs: Add pgadmin4 to docker-compose.yml #9556

Merged
merged 2 commits into from
May 19, 2024
Merged

Conversation

roschaefer
Copy link
Contributor

Motivation

The current documentation encourages to install pgAdmin3 on the host system. It's much simpler to add pgAdmin4 to the docker-compose.yml:

  1. No configuration needs to be modified, just added.
  2. Better security because no additional ports need to be opened on the host.
  3. Easier installation. E.g. on Archlinux there is no package pgAdmin3 anymore.
  4. pgAdmin3 does not seem to be maintained.

How to test

  1. Follow the documentation.
  2. See if you can connect to the immich database

Motivation
----------
The current documentation encourages to install pgAdmin3 on the host
system. It's much simpler to add `pgAdmin4` to the `docker-compose.yml`:

1. No configuration needs to be modified, just added.
2. Better security because no additional ports need to be opened on the host.
3. Easier installation. E.g. on Archlinux there is no package pgAdmin3
   anymore.
4. `pgAdmin3` does not seem to be maintained.

How to test
-----------
1. Follow the documentation.
2. See if you can connect to the immich database
I assume most users will not edit the `docker-compose.yml` and forget
about `pgAdmin` once they're done. So, `pgAdmin` might get exposed to
the internet with default credentials, which is not good.

Better to leave a hint to change the credentials and keep the
configuration separate, so users start `pgAdmin` knowingly and turn it
off once they're done.
@alextran1502 alextran1502 added the documentation Improvements or additions to documentation label May 19, 2024
@alextran1502 alextran1502 merged commit e39ee8a into immich-app:main May 19, 2024
22 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants