Merge pull request #10 from joglomedia/linux

v1.1.1 Suddenly

Author: joglomedia

README.md

@@ -14,8 +14,9 @@ Dockerize your PHP apps ;)
 Easydock comes with:
 
 - Nginx
-- PHP (PHP-FPM 5.x, 7.x and 8.x)
-- MySQL (latest version of MariaDB)
+- PHP (7.4 and 8.0)
+- MariaDB (Drop-in replacement for MySQL)
+- PostgreSQL
 - Redis
 - ~~phpmyadmin~~ Adminer (Lightweight MySQL admin)
 - MailHog
@@ -25,7 +26,7 @@ Easydock comes with:
 
 ## Requirements
 
-Docker and Docker Compose installed on Linux Distro (Debian, Ubuntu)
+Docker and Docker Compose installed on Linux Distro (Debian or Ubuntu).
 
 ## Installation
 
@@ -40,58 +41,96 @@ easydock init && easydock import
 
 - Configure your application path into `.env.easydock` file.
 
-## Getting started
+## Getting Started
 
-- After installation, if you need, configure your `.env.easydock` file and run:
+After installation completed, if required, you could configure your `.env.easydock` file and then run this build command:
 
 ```bash
 easydock build
 ```
 
-### Config your app DB connection (default)
+### Configure Nginx and PHP-FPM
+
+- The default Nginx server configuration (app.conf) will expose your project `/public` folder.
+- If your project uses different directory structure, you should adjust the configuration and update the file accordingly.
+- Your application by default accessible through localhost on port 8008 (`http://localhost:8008`)
+- Supported PHP version: 7.4 & 8.0
+
+```bash
+# APP PORT
+APP_PORT=8008
+
+# PHP VERSION 
+PHP_VERSION=7.4
+```
+
+### Configure database connection
+
+The default database connection for MySQL and PostgreSQL.
+
+```bash
+Username: easydock
+Password: secret
+Database: easydockdb
+Host: mysql ( or postgres for PostgreSQL )
+```
+
+For security reason, you should change the default database username and password configured in `.env.easydock` file.
 
 ```bash
-user: root
-pass: secret
-db: dockerdb
-host: mysql ( or redis for Redis )
+# MYSQL / POSTGRESQL DB NAME
+DB_NAME=easydockdb
+
+# MYSQL / POSTGRESQL USER
+DB_USER=easydock
+
+# MYSQL / POSTGRESQL USER PASSWORD
+DB_PASS=secret
+
+# MYSQL ROOT PASSWORD
+DB_ROOT_PASS=rootsecret
+
+# MYSQL PORT
+MYSQL_PORT=3306
+
+# POSTGRESQL PORT
+POSTGRES_PORT=5432
 ```
 
-### Config your app SMTP conn (default - no user or pass are required)
+### Configure SMTP connection
+
+By default, SMTP connection through MailHog doesn't require any username or password.
 
 ```bash
 host: mailhog
 port: 1025
 ```
 
-- The default Nginx config (app.conf) will expose your project `/public` folder.
-- If your project is using different directory structure, you should adjust the configurations and update the file accordingly.
-
-### To start your Docker istance
+### To start your app instance
 
 ```bash
 easydock up
 ```
 
-### To stop your Docker istance
+### To stop your app instance
 
 ```bash
 easydock stop
 ```
 
-### To restart your Docker istance
+### To restart your app instance
 
 ```bash
 easydock restart
 ```
 
-### To stop and delete your Docker istance
+### To stop and delete your app instance
 
 ```bash
 easydock down
 ```
 
-### To "SSH" into your Docker istance
+### To "SSH" into your app instance
 
 ```bash
 easydock shell
@@ -103,7 +142,7 @@ easydock shell
 easydock info
 ```
 
-### You can reset your Docker istance running
+### You can reset your running instance
 
 ```bash
 easydock reset
@@ -115,7 +154,7 @@ easydock reset
 easydock reset && easydock build
 ```
 
-_*NB: Database data will be removed*_
+_*PS: Resetting your EasyDock instance will delete the database data*_
 
 ## Security Vulnerabilities and Bugs
 

config/.env.easydock

@@ -22,20 +22,23 @@ APP_PORT=8008
 # PHP VERSION 
 PHP_VERSION=7.4
 
-# MYSQL DB NAME
+# MYSQL / POSTGRESQL DB NAME
 DB_NAME=easydockdb
 
-# MYSQL USER
+# MYSQL / POSTGRESQL USER
 DB_USER=easydock
 
-# MYSQL USER PASSWORD
+# MYSQL / POSTGRESQL USER PASSWORD
 DB_PASS=secret
 
 # MYSQL ROOT PASSWORD
 DB_ROOT_PASS=rootsecret
 
-# MYSQL DB PORT
-DB_PORT=3306
+# MYSQL PORT
+MYSQL_PORT=3306
+
+# POSTGRESQL PORT
+POSTGRES_PORT=5432
 
 # REDIS PORT
 REDIS_PORT=6379

src/docker-compose.yml

@@ -17,12 +17,12 @@ services:
       SERVICE_NAME: webapp
     working_dir: /var/www
     volumes:
-      - ${APP_DIR}/:/var/www/:cached
+      - ${APP_DIR}:/var/www:cached
       - ${APP_DIR}/.easydock/config/php/php.ini:/usr/local/etc/php/conf.d/local.ini
       - ${APP_DIR}/.easydock/config/php/opcache.ini:/usr/local/etc/php/conf.d/opcache.ini
       - ${APP_DIR}/.easydock/config/php/zz-docker.conf:/usr/local/etc/php-fpm.d/zz-docker.conf
-      - ${APP_DIR}/.easydock/log/php/:/var/log/php/
-#      - phpsocket:/var/run/
+      - ${APP_DIR}/.easydock/log/php:/var/log/php
+#      - phpsocket:/var/run
     networks:
       - easydocknet
   # Nginx
@@ -36,10 +36,10 @@ services:
     depends_on:
       - webapp
     volumes:
-      - ${APP_DIR}/:/var/www/:cached
-      - ${APP_DIR}/.easydock/config/nginx/:/etc/nginx/conf.d/
-      - ${APP_DIR}/.easydock/log/nginx/:/var/log/nginx/
-#      - phpsocket:/var/run/
+      - ${APP_DIR}:/var/www:cached
+      - ${APP_DIR}/.easydock/config/nginx:/etc/nginx/conf.d
+      - ${APP_DIR}/.easydock/log/nginx:/var/log/nginx
+#      - phpsocket:/var/run
     networks:
       - easydocknet
   # MySQL (MariaDB)
@@ -53,11 +53,27 @@ services:
       MYSQL_PASSWORD: ${DB_PASS}
       MYSQL_ROOT_PASSWORD: ${DB_ROOT_PASS}
     ports:
-      - ${DB_PORT}:3306
+      - ${MYSQL_PORT}:3306
     command: ['--character-set-server=utf8mb4','--collation-server=utf8mb4_unicode_ci','--default-authentication-plugin=mysql_native_password']
     volumes:
-      - ${APP_DIR}/.easydock/data:/var/lib/mysql/
-      - ${APP_DIR}/.easydock/log/mysql/:/var/log/mysql/
+      - ${APP_DIR}/.easydock/data/mysql:/var/lib/mysql
+      - ${APP_DIR}/.easydock/log/mysql:/var/log/mysql
+    networks:
+      - easydocknet
+  # PostgreSQL
+  postgres:
+    image: postgres:alpine
+    container_name: ${APP_SID}_postgres
+    restart: always
+    environment:
+      POSTGRES_USER: ${DB_USER}
+      POSTGRES_PASSWORD: ${DB_PASS}
+      POSTGRES_DB: ${DB_NAME}
+      PGDATA: /var/lib/postgresql/data/pgdata
+    ports:
+      - ${POSTGRES_PORT}:5432
+    volumes:
+      - ${APP_DIR}/.easydock/data/postgres:/var/lib/postgresql/data
     networks:
       - easydocknet
   # Redis

src/easydock

@@ -250,30 +250,42 @@ function ed_portscheck() {
     else
         ed_unavailableport "${ed_portapp}"
     fi
-    ed_checkingport "${ed_portdb}"
-    if ed_isthisportfree "${ed_portdb}"; then
-        ed_availableport "${ed_portdb}"
+
+    ed_checkingport "${ed_portmysql}"
+    if ed_isthisportfree "${ed_portmysql}"; then
+        ed_availableport "${ed_portmysql}"
+    else
+        ed_unavailableport "${ed_portmysql}"
+    fi
+
+    ed_checkingport "${ed_portpgsql}"
+    if ed_isthisportfree "${ed_portpgsql}"; then
+        ed_availableport "${ed_portpgsql}"
+    else
+        ed_unavailableport "${ed_portpgsql}"
+    fi
+
+
+    ed_checkingport "${ed_portrds}"
+    if ed_isthisportfree "${ed_portrds}"; then
+        ed_availableport "${ed_portrds}"
     else
-        ed_unavailableport "${ed_portdb}"
+        ed_unavailableport "${ed_portrds}"
     fi
+
     ed_checkingport "${ed_portpma}"
     if ed_isthisportfree "${ed_portpma}"; then
         ed_availableport "${ed_portpma}"
     else
         ed_unavailableport "${ed_portpma}"
     fi
+
     ed_checkingport "${ed_portmh}"
     if ed_isthisportfree "${ed_portmh}"; then
         ed_availableport "${ed_portmh}"
     else
         ed_unavailableport "${ed_portmh}"
     fi
-    ed_checkingport "${ed_portrds}"
-    if ed_isthisportfree "${ed_portrds}"; then
-        ed_availableport "${ed_portrds}"
-    else
-        ed_unavailableport "${ed_portrds}"
-    fi
 }
 
 ############################################################ CLI FUNCTIONS
@@ -334,9 +346,9 @@ function ed_info() {
 
 function ed_build() {
     echo -e "${blue}Wait... ${reset}${br}"
-    echo -e "${bgblue}${white} Checking required ports ${reset}"
-    ed_portscheck
-    echo -e "${br}${bgblue}${white} Pulling Docker images ${reset}${br}"
+    #echo -e "${bgblue}${white} Checking required ports ${reset}${br}"
+    #ed_portscheck
+    echo -e "${bgblue}${white} Pulling Docker images ${reset}${br}"
     #docker-compose -f ./.easydock/docker-compose.yml --env-file=./.env.easydock build --no-cache --pull
     docker-compose -f ./.easydock/docker-compose.yml --env-file=./.env.easydock build --pull
     sleep 1s    
@@ -372,8 +384,8 @@ function ed_remove() {
 
 function ed_up() {
     echo -e "${blue}Wait...${reset}${br}"
-    docker-compose -f ./.easydock/docker-compose.yml --env-file=./.env.easydock down
-    echo -e "${br}${bgblue}${white} Checking required ports ${reset}"
+    #docker-compose -f ./.easydock/docker-compose.yml --env-file=./.env.easydock down
+    echo -e "${bgblue}${white} Checking required ports ${reset}${br}"
     ed_portscheck
     echo -e "${br}${bgblue}${white} Create and start easydock system ${reset}${br}"
     docker-compose -f ./.easydock/docker-compose.yml --env-file=./.env.easydock up -d --force-recreate
@@ -580,7 +592,8 @@ function ed_bootstrap() {
         ed_logo
 
         ed_portapp=$(grep APP_PORT .env.easydock | cut -d '=' -f2)
-        ed_portdb=$(grep DB_PORT .env.easydock | cut -d '=' -f2)
+        ed_portmysql=$(grep MYSQL_PORT .env.easydock | cut -d '=' -f2)
+        ed_portpgsql=$(grep POSTGRES_PORT .env.easydock | cut -d '=' -f2)
         ed_portrds=$(grep REDIS_PORT .env.easydock | cut -d '=' -f2)
         ed_portpma=$(grep PMA_PORT .env.easydock | cut -d '=' -f2)
         ed_portmh=$(grep MH_PORT .env.easydock | cut -d '=' -f2)