Initial commit

seralaci · seralaci · commit a736a8817eaf · 2023-06-18T12:14:09.000+02:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Guillaume Simonneau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,2 +1,53 @@
-# postgres-docker-compose
-PostgreSQL and pgAdmin by Docker Compose
+# PostgreSQL and pgAdmin 4 by Docker Compose
+
+## Requirements:
+* docker >= 17.12.0+
+* docker-compose
+
+## Quick Start
+* Clone or download this repository
+* Go inside of directory,  `cd postgres-docker-compose`
+* Run this command `docker-compose up -d`
+
+
+## Environments
+This Compose file contains the following environment variables:
+
+* `POSTGRES_USER` the default value is **postgres**
+* `POSTGRES_PASSWORD` the default value is **setyourpassword**
+* `PGADMIN_PORT` the default value is **5050**
+* `PGADMIN_DEFAULT_EMAIL` the default value is **pgadmin4@pgadmin.org**
+* `PGADMIN_DEFAULT_PASSWORD` the default value is **admin**
+
+## Access to postgres: 
+* `localhost:5432`
+* **Username:** postgres 
+* **Password:** setyourpassword 
+
+## Access to PgAdmin: 
+* **URL:** [http://localhost:5050](http://localhost:5050)
+* **Username:** pgadmin@pgadmin.org 
+* **Password:** admin 
+
+## Add a new server in PgAdmin:
+* **Host name/address** `postgres`
+* **Port** `5432`
+* **Username** as `POSTGRES_USER`, by default: `postgres`
+* **Password** as `POSTGRES_PASSWORD`, by default `setyourpassword`
+
+![Alt text](register_server.png)
+
+## Logging
+
+There are no easy way to configure pgadmin log verbosity and it can be overwhelming at times. It is possible to disable pgadmin logging on the container level.
+
+Add the following to `pgadmin` service in the `docker-compose.yml`:
+
+```
+logging:
+  driver: "none"
+```
+
+## Are you new to PostgreSQL?
+
+[Learn PostgreSQL Tutorial - Full Course for Beginners](https://www.youtube.com/watch?v=qw--VYLpxG4)
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,41 @@
+version: '3.5'
+
+services:
+  postgres:
+    container_name: postgres_container
+    image: postgres
+    environment:
+      POSTGRES_USER: ${POSTGRES_USER:-postgres}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-setyourpassword}
+      PGDATA: /data/postgres
+    volumes:
+       - postgres:/data/postgres
+    ports:
+      - "5432:5432"
+    networks:
+      - postgres
+    restart: unless-stopped
+  
+  pgadmin:
+    container_name: pgadmin_container
+    image: dpage/pgadmin4
+    environment:
+      PGADMIN_DEFAULT_EMAIL: ${PGADMIN_DEFAULT_EMAIL:-pgadmin@pgadmin.org}
+      PGADMIN_DEFAULT_PASSWORD: ${PGADMIN_DEFAULT_PASSWORD:-admin}
+      PGADMIN_CONFIG_SERVER_MODE: 'False'
+    volumes:
+       - pgadmin:/var/lib/pgadmin
+
+    ports:
+      - "${PGADMIN_PORT:-5050}:80"
+    networks:
+      - postgres
+    restart: unless-stopped
+
+networks:
+  postgres:
+    driver: bridge
+
+volumes:
+    postgres:
+    pgadmin:
diff --git a/register_server.png b/register_server.png
