Run app via docker compose (#594)

Author: gomzyakov

.env.ci

@@ -1,4 +1,4 @@
-APP_NAME=Laravel
+APP_NAME=Secretic
 APP_ENV=local
 APP_KEY=base64:g3cPbmSz3AC3CoGXtbK81jFgYJnobc4iT27AwRs+FQc=
 APP_DEBUG=true

.env.local

@@ -1,18 +1,18 @@
-APP_NAME=Laravel
+APP_NAME=Secretic
 APP_ENV=local
 APP_KEY=base64:g3cPbmSz3AC3CoGXtbK81jFgYJnobc4iT27AwRs+FQc=
 APP_DEBUG=true
-APP_URL=http://localhost
+APP_URL=http://localhost:8000
 
 LOG_CHANNEL=stack
 LOG_DEPRECATIONS_CHANNEL=null
 LOG_LEVEL=debug
 
 DB_CONNECTION=mysql
-DB_HOST=mysql
+DB_HOST=db
 DB_PORT=3306
 DB_DATABASE=secretic
-DB_USERNAME=root
+DB_USERNAME=secretic_user
 DB_PASSWORD=password
 
 BROADCAST_DRIVER=log

.htaccess

@@ -0,0 +1,34 @@
+FROM php:8.2-fpm
+
+# Arguments defined in docker-compose.yml
+ARG user
+ARG uid
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y \
+    git \
+    curl \
+    libpng-dev \
+    libonig-dev \
+    libxml2-dev \
+    zip \
+    unzip
+
+# Clear cache
+RUN apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# Install PHP extensions
+RUN docker-php-ext-install pdo_mysql mbstring exif pcntl bcmath gd
+
+# Get latest Composer
+COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+
+# Create system user to run Composer and Artisan Commands
+RUN useradd -G www-data,root -u $uid -d /home/$user $user
+RUN mkdir -p /home/$user/.composer && \
+    chown -R $user:$user /home/$user
+
+# Set working directory
+WORKDIR /var/www
+
+USER $user

Dockerfile

@@ -23,24 +23,50 @@ The following features will be implemented soon:
 - QR code for paste URLs, to easily transfer them over to mobile devices https://github.com/gomzyakov/secretic/issues/489
 - API for integration with third parties https://github.com/gomzyakov/secretic/issues/405
 
+
 ## Requesting features
 
 Open a [new issue](https://github.com/gomzyakov/secretic/issues/new) to request a feature (or if you find a bug).
 
 
-## Run the app with Docker
+## How to run Secretic locally?
+
+I believe you already have Docker installed. If not, just do it on [Mac](https://docs.docker.com/desktop/install/mac-install/), [Windows](https://docs.docker.com/desktop/install/windows-install/) or [Linux](https://docs.docker.com/desktop/install/linux-install/).
+
+
+Build the `app` image with the following command:
+
+```shell
+docker compose build --no-cache
+```
+
+>This command might take a few minutes to complete.
+
+When the build is finished, you can run the environment in background mode with:
+
+```shell
+docker compose up -d
+```
+
+We’ll now run `composer install` to install the application dependencies:
+
+```shell
+docker compose exec app composer install
+```
 
-Before running the Secretic locally:
+Copy the environment settings:
 
-- Instead of repeatedly typing `vendor/bin/sail` to execute Sail commands, you may wish to configure a Bash alias ```alias sail='[ -f sail ] && bash sail || bash vendor/bin/sail'```
-- Copy the environment settings ```cp .env.local .env```
+```shell
+docker compose exec app cp .env.local .env
+```
 
-After that just run the command:
+Migrate DB & seed fake data with the `artisan` Laravel command-line tool:
 
-- ```sail up -d``` to run the Secretic ([What if I don't have PHP and Composer on my computer?](https://github.com/gomzyakov/secretic/issues/570))
-- ```sail artisan migrate:fresh --seed``` to migrate DB & seed fake data
+```shell
+docker compose exec app ./artisan migrate:fresh --seed
+```
 
-And open http://127.0.0.1 in your favorite browser. Happy using Secretic! 
+And open http://127.0.0.1:8000 in your favorite browser. Happy using Secretic! 
 
 
 ## Can I trust a instance of Secretic not hosted by me?

README.md

@@ -2,7 +2,6 @@
 
 namespace App\Providers;
 
-use Illuminate\Support\Facades\URL;
 use Illuminate\Support\ServiceProvider;
 
 class AppServiceProvider extends ServiceProvider
@@ -24,6 +23,6 @@ public function register()
      */
     public function boot()
     {
-        URL::forceScheme('https');
+        //
     }
 }

app/Providers/AppServiceProvider.php

@@ -1,96 +1,50 @@
-# For more information: https://laravel.com/docs/sail
-version: '3'
+version: "3.7"
+
 services:
-    laravel.test:
+    app:
         build:
-            context: ./vendor/laravel/sail/runtimes/8.1
-            dockerfile: Dockerfile
             args:
-                WWWGROUP: '${WWWGROUP}'
-        image: sail-8.1/app
-        extra_hosts:
-            - 'host.docker.internal:host-gateway'
-        ports:
-            - '${APP_PORT:-80}:80'
-        environment:
-            WWWUSER: '${WWWUSER}'
-            LARAVEL_SAIL: 1
-            XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}'
-            XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
+                user: sammy
+                uid: 1000
+            context: ./
+            dockerfile: Dockerfile
+        image: secretic
+        container_name: secretic-app
+        restart: unless-stopped
+        working_dir: /var/www/
         volumes:
-            - '.:/var/www/html'
+            - ./:/var/www
         networks:
-            - sail
-        depends_on:
-            - mysql
-            - redis
-            - meilisearch
-            - selenium
-    mysql:
-        image: 'mysql/mysql-server:8.0'
-        ports:
-            - '${FORWARD_DB_PORT:-3306}:3306'
+            - secretic
+
+    db:
+        image: mysql:8.0
+        container_name: secretic-db
+        restart: unless-stopped
         environment:
-            MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
-            MYSQL_ROOT_HOST: "%"
-            MYSQL_DATABASE: '${DB_DATABASE}'
-            MYSQL_USER: '${DB_USERNAME}'
-            MYSQL_PASSWORD: '${DB_PASSWORD}'
-            MYSQL_ALLOW_EMPTY_PASSWORD: 1
-        volumes:
-            - 'sail-mysql:/var/lib/mysql'
-        networks:
-            - sail
-        healthcheck:
-            test: ["CMD", "mysqladmin", "ping", "-p${DB_PASSWORD}"]
-            retries: 3
-            timeout: 5s
-    redis:
-        image: 'redis:alpine'
-        ports:
-            - '${FORWARD_REDIS_PORT:-6379}:6379'
-        volumes:
-            - 'sail-redis:/data'
-        networks:
-            - sail
-        healthcheck:
-            test: ["CMD", "redis-cli", "ping"]
-            retries: 3
-            timeout: 5s
-    meilisearch:
-        image: 'getmeili/meilisearch:latest'
-        ports:
-            - '${FORWARD_MEILISEARCH_PORT:-7700}:7700'
+            MYSQL_DATABASE: ${DB_DATABASE}
+            MYSQL_ROOT_PASSWORD: ${DB_PASSWORD}
+            MYSQL_PASSWORD: ${DB_PASSWORD}
+            MYSQL_USER: ${DB_USERNAME}
+            SERVICE_TAGS: dev
+            SERVICE_NAME: mysql
         volumes:
-            - 'sail-meilisearch:/data.ms'
+            - ./docker-compose/mysql:/docker-entrypoint-initdb.d
         networks:
-            - sail
-        healthcheck:
-            test: ["CMD", "wget", "--no-verbose", "--spider",  "http://localhost:7700/health"]
-            retries: 3
-            timeout: 5s
-    mailhog:
-        image: 'mailhog/mailhog:latest'
-        platform: linux/amd64
+            - secretic
+
+    nginx:
+        image: nginx:1.17-alpine
+        container_name: secretic-nginx
+        restart: unless-stopped
         ports:
-            - '${FORWARD_MAILHOG_PORT:-1025}:1025'
-            - '${FORWARD_MAILHOG_DASHBOARD_PORT:-8025}:8025'
-        networks:
-            - sail
-    selenium:
-        image: 'selenium/standalone-chrome'
-        platform: linux/amd64
+            - 8000:80
         volumes:
-            - '/dev/shm:/dev/shm'
+            - ./:/var/www
+            - ./docker-compose/nginx:/etc/nginx/conf.d
         networks:
-            - sail
+            - secretic
+
 networks:
-    sail:
+    secretic:
         driver: bridge
-volumes:
-    sail-mysql:
-        driver: local
-    sail-redis:
-        driver: local
-    sail-meilisearch:
-        driver: local

docker-compose.yml

@@ -0,0 +1,21 @@
+
+server {
+    listen 80;
+    index index.php index.html;
+    error_log  /var/log/nginx/error.log;
+    access_log /var/log/nginx/access.log;
+    root /var/www/public;
+    location ~ \.php$ {
+        try_files $uri =404;
+        fastcgi_split_path_info ^(.+\.php)(/.+)$;
+        fastcgi_pass app:9000;
+        fastcgi_index index.php;
+        include fastcgi_params;
+        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+        fastcgi_param PATH_INFO $fastcgi_path_info;
+    }
+    location / {
+        try_files $uri $uri/ /index.php?$query_string;
+        gzip_static on;
+    }
+}

docker-compose/nginx/secretic.conf

@@ -0,0 +1,21 @@
+<?php
+
+/**
+ * Laravel - A PHP Framework For Web Artisans
+ *
+ * @package  Laravel
+ * @author   Taylor Otwell <[email protected]>
+ */
+
+$uri = urldecode(
+    parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH)
+);
+
+// This file allows us to emulate Apache's "mod_rewrite" functionality from the
+// built-in PHP web server. This provides a convenient way to test a Laravel
+// application without having installed a "real" web server software here.
+if ($uri !== '/' && file_exists(__DIR__.'/public'.$uri)) {
+    return false;
+}
+
+require_once __DIR__.'/public/index.php';