mirror of
https://github.com/immich-app/immich.git
synced 2025-01-09 21:36:46 +01:00
e39ee8a16f
* docs: Add pgadmin4 to docker-compose.yml 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 * docs: better use separate config file 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.
53 lines
1.6 KiB
Markdown
53 lines
1.6 KiB
Markdown
# Database GUI
|
|
|
|
A short guide on connecting [pgAdmin](https://www.pgadmin.org/) to Immich.
|
|
|
|
## 1. Install pgAdmin
|
|
|
|
Add a file `docker-compose-pgadmin.yml` next to your `docker-compose.yml` with the following content:
|
|
|
|
```
|
|
name: immich
|
|
|
|
services:
|
|
pgadmin:
|
|
image: dpage/pgadmin4
|
|
container_name: pgadmin4_container
|
|
restart: always
|
|
ports:
|
|
- "8888:80"
|
|
environment:
|
|
PGADMIN_DEFAULT_EMAIL: user-name@domain-name.com
|
|
PGADMIN_DEFAULT_PASSWORD: strong-password
|
|
volumes:
|
|
- pgadmin-data:/var/lib/pgadmin
|
|
|
|
volumes:
|
|
pgadmin-data:
|
|
```
|
|
|
|
Change the values of `PGADMIN_DEFAULT_EMAIL` and `PGADMIN_DEFAULT_PASSWORD` in this file.
|
|
|
|
Run `docker compose -f docker-compose.yml -f docker-compose-pgadmin.yml up` to start immich along with `pgAdmin`.
|
|
|
|
## 2. Add a Server
|
|
|
|
Open [localhost:8888](http://localhost:8888) and login with the default credentials from above.
|
|
|
|
Right click on `Servers` and click on `Register >> Server..` then enter the values below in the `Connection` tab.
|
|
|
|
<img src={require('./img/pgadmin-add-new-server.png').default} width="50%" title="new server option" />
|
|
|
|
:::note
|
|
The parameters used here match those specified in the example `.env` file. If you have changed your `.env` file, you'll need to adjust accordingly.
|
|
:::
|
|
|
|
| Name | Value |
|
|
| -------------------- | ----------------- |
|
|
| Host name/address | `immich_postgres` |
|
|
| Port | `5432` |
|
|
| Maintenance database | `immich` |
|
|
| Username | `postgres` |
|
|
| Password | `postgres` |
|
|
|
|
Click on "Save" to connect to the Immich database.
|