mirror of
https://github.com/immich-app/immich.git
synced 2025-12-13 00:01:09 -08:00
58e516c766
* minor * add image * PR feedback * npm run format:fix of course 4_4 * Remove what is not relevant * pr feedback * PR feedback * revert npm run format * Update docs/docs/FAQ.mdx Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> * Update FAQ.mdx --------- Co-authored-by: Alex <alex.tran1502@gmail.com> Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
# Database GUI
|
|
|
|
A short guide on connecting [pgAdmin](https://www.pgadmin.org/) to Immich.
|
|
|
|
:::note
|
|
|
|
In order to connect to the database the immich_postgres container **must be running**.
|
|
|
|
The passwords and usernames used below match the ones specified in the example `.env` file. If changed, please use actual values instead.
|
|
|
|
**Optional:** To connect to the database **outside** of your Docker's network:
|
|
|
|
- Expose port 5432 in your `docker-compose.yml` file.
|
|
- Edit the PostgreSQL [`pg_hba.conf`](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html) file.
|
|
- Make sure your firewall does not block access to port 5432.
|
|
Note that exposing the database port increases the risk of getting attacked by hackers.
|
|
Make sure to remove the binding port after finishing the database's tasks.
|
|
|
|
:::
|
|
|
|
## 1. Install pgAdmin
|
|
|
|
Download and install [pgAdmin](https://www.pgadmin.org/download/) following the official documentation.
|
|
|
|
## 2. Add a Server
|
|
|
|
Open pgAdmin and click "Add New Server".
|
|
|
|
<img src={require('./img/add-new-server-option.png').default} width="50%" title="new server option" />
|
|
|
|
## 3. Enter Connection Details
|
|
|
|
| Name | Value |
|
|
| -------------------- | ----------- |
|
|
| Host name/address | `localhost` |
|
|
| Port | `5432` |
|
|
| Maintenance database | `immich` |
|
|
| Username | `postgres` |
|
|
| Password | `postgres` |
|
|
|
|
<img src={require('./img/Connection-Pgadmin.png').default} width="75%" title="Connection" />
|
|
|
|
## 4. Save Connection
|
|
|
|
Click on "Save" to connect to the Immich database.
|
|
|
|
:::tip
|
|
View [Database Queries](/docs/guides/database-queries/) for common database queries.
|
|
:::
|