Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andrezatcascais/docker-postgres-pgadm

Docker Compose script to create a local environment for development with PostgreSQL and pgAdmin
https://github.com/andrezatcascais/docker-postgres-pgadm

automation docker docker-compose pgadmin4 postgres script

Last synced: 15 days ago
JSON representation

Docker Compose script to create a local environment for development with PostgreSQL and pgAdmin

Host: GitHub
URL: https://github.com/andrezatcascais/docker-postgres-pgadm
Owner: andrezatcascais
Created: 2024-09-06T16:40:17.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-09-29T02:57:34.000Z (about 2 months ago)
Last Synced: 2024-10-16T12:19:48.920Z (30 days ago)
Topics: automation, docker, docker-compose, pgadmin4, postgres, script
Language: Shell
Homepage:
Size: 465 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# PostgreSQL and pgAdmin with Docker Compose

#### Docker Compose script to create a local environment for development with PostgreSQL and pgAdmin

### To run this script is necessary:
- docker-compose-example.yml
- setup_docker_env.sh

### Instructions:

1. Save the shell script `setup_docker_env.sh` and make it executable by running:
```bash
chmod +x setup_docker_env.sh
```
> ⚠ If you want to change the Docker network name, you should edit the setup_docker_env.sh file and update the global variable NETWORK_NAME.

2. Run script (By using source setup_docker_env.sh, it runs in the same shell session as your terminal, meaning cd will change the directory in the terminal session itself.)
```bash
source setup_docker_env.sh
```

3. if case you need to run the shell script by ./setup_docker_env.sh, so,
"please manually change to the 'postgres-env-dev' directory by running":
```bash
cd postgres-env-dev
```
4. Whenever you need to work with these tools, just open the terminal in the folder where you added the docker-compose.yml file and run the following command:
```bash
docker-compose -f docker-compose.yml up
```
5. To view the containers, open a new terminal tab and type:
```bash
docker ps
```
6. Verify that the directory being mounted in the container has the correct permissions. In your docker-compose.yml, you're mounting the host directory ./data/pgadmin to /var/lib/pgadmin in the container. Ensure that the user running Docker has read and write permissions for this directory.
```bash
cd postgres-env-dev
sudo chmod -R 777 ./data/pgadmin/
```

> To test if the pgAdmin service is working, access http://localhost:8080 in your browser. You will see an authentication screen where you should enter the username and password that we set in the Compose file. If you prefer, you can also change the application language.
>

### The screen should look similar to this:

![alt text](assets/image-1.png)

#### Once authenticated, let's add our server and test the connection.

### Adding a Server in pgAdmin

To add a server in pgAdmin, go to the Object Explorer tab, right-click on the "Servers" item, and then select the "Register" and "Server" options. Alternatively, you can use the shortcut available in the quick links.

![alt text](assets/image-2.png)

A window will open for you to configure the server. In the **General** tab, provide a name to identify your connection. In this tutorial, I named it **Server Project 1**.

![alt text](assets/image-3.png)

Move to the **Connection** tab and in the **Host name** field, enter the name of the PostgreSQL container. In the **Username** field, enter the user, and in the respective field, enter the password. Click **Save** to continue.

These values were defined in the docker-compose.yml file

![alt text](assets/image-4.png)

There are also other useful settings, but for this scenario, we'll configure only the essentials to start testing PostgreSQL.

After saving, if you have followed all the steps so far, the result will be a dashboard displaying information about the database you are connected to.

![alt text](assets/image-5.png)

Finally, let's create our database. Right-click on **Databases**.

![alt text](assets/image-6.png)

Enter a name for your database and click **Save** to continue.

![alt text](assets/image-7.png)

Once finished, in the **Object Explorer** tab, you should see your new database listed.

![alt text](assets/image-8.png)

### Done! We've reached the end, and now you have an environment with PostgreSQL and the pgAdmin web interface. :clap: :rocket: