https://github.com/feliperdamaceno/docker-postgresql-boilerplate

A Docker PostgreSQL boilerplate with Docker Compose, including PgAdmin for database management, and a detailed setup guide for easy configuration and deployment.
https://github.com/feliperdamaceno/docker-postgresql-boilerplate

docker-compose pgadmin postgresql

Last synced: about 1 month ago
JSON representation

A Docker PostgreSQL boilerplate with Docker Compose, including PgAdmin for database management, and a detailed setup guide for easy configuration and deployment.

• Host: GitHub
• URL: https://github.com/feliperdamaceno/docker-postgresql-boilerplate
• Owner: feliperdamaceno
• License: mit
• Created: 2024-02-27T19:42:54.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-10-24T22:55:17.000Z (2 months ago)
• Last Synced: 2024-10-26T11:12:23.467Z (2 months ago)
• Topics: docker-compose, pgadmin, postgresql
• Homepage:
• Size: 2.93 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## docker-postgresql-boilerplate

A Docker PostgreSQL boilerplate with Docker Compose, including PgAdmin for database management, and a detailed setup guide for easy configuration and deployment.

## How to Setup

### 1. Postgres Setup:

Use `.env.example` file as a reference to setup the required environment variables.

After doing that, run the following command to create your Postgres service:

```bash

docker compose -p postgres up -d

```

To take down the docker services, just use:

```bash

docker-compose -p postgres down

```

### 2. pgAdmin Setup:

Once your containers are up and running, navigate to http://localhost:8080 to access your pgAdmin service, then login with the credentials set in your `.env` file.

Next, create a new server connection and name your server as desired.

Finally, in the Connection tab, set **Host name/address** as **postgres**, **Username** and **Password** as set in your `.env` file, and **Port** number as **5432**, then click save.

Once done, pgAdmin should be connected to the Postgres database.

When consuming your Postgres database, use the following URL structure:

```

postgresql://USERNAME:PASSWORD@localhost:PORT/DATABASE_NAME

```

## Licence

This is an open-source project and is available under the [**MIT License**](LICENSE). You are free to use, modify, and distribute the code in accordance with the terms of the license.

## Contributors

Contributions are highly appreciated! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.

[feliperdamaceno](https://github.com/feliperdamaceno)

## Contact me

Linkedin: [feliperdamaceno](https://www.linkedin.com/in/feliperdamaceno)