fix : README.md

patternhelloworld · patternhelloworld · commit f67252ceb864 · 2025-09-30T22:11:19.000+09:00
diff --git a/.env.example.php.production.build b/.env.example.php.production.build
@@ -0,0 +1,93 @@
+# IMPORTANT - mac : docker.for.mac.localhost OR check IP. / win : host.docker.internal OR you can just type your host IP.
+HOST_IP=host.docker.internal
+
+APP_URL=https://localhost:8085
+
+USE_COMMERCIAL_SSL=true
+COMMERCIAL_SSL_NAME=laravel-crud-boilerplate
+
+DOCKER_LAYER_CORRUPTION_RECOVERY=false
+
+NGINX_RESTART=false
+
+# The method of acquiring Docker images:
+# build (Used in developer's local environment or during Jenkins builds when a new image needs to be built, so this module is typically used)
+# registry (Used on deployment servers where images are fetched from a repository, so this module is used)
+# If you choose the "build" method, you don't need to input the values below since Dockerfile is used (no image is fetched from the Docker registry).
+GIT_IMAGE_LOAD_FROM=build
+GIT_IMAGE_LOAD_FROM_HOST=xxx
+GIT_IMAGE_LOAD_FROM_PATHNAME=xxx
+GIT_TOKEN_IMAGE_LOAD_FROM_USERNAME=xxx
+GIT_TOKEN_IMAGE_LOAD_FROM_PASSWORD=xxx
+GIT_IMAGE_VERSION=1.0.0
+
+PROJECT_NAME=laravel_crud_boilerplate
+PROJECT_LOCATION=/var/www/app
+PROJECT_PORT=[8085,8081]
+# Example (8093,8094,11000...)
+ADDITIONAL_PORTS=
+
+# If you locate your project on ../ (upper folder)
+HOST_ROOT_LOCATION=./samples/laravel-crud-boilerplate
+# If you locate your project's Dockerfile ../ (upper folder)
+DOCKER_FILE_LOCATION=./samples/laravel-crud-boilerplate
+
+# This is for integrating health checkers such as "https://www.baeldung.com/spring-boot-actuators"
+APP_HEALTH_CHECK_PATH=api/v1/health
+BAD_APP_HEALTH_CHECK_PATTERN=DOWN
+GOOD_APP_HEALTH_CHECK_PATTERN=UP
+
+
+# This is for environment variables for docker-compose-app.
+DOCKER_COMPOSE_ENVIRONMENT={"XDEBUG_CONFIG":"idekey=IDE_DEBUG","PHP_IDE_CONFIG":"serverName=laravel-crud-boilerplate"}
+# This goes with "docker build ... in the 'run.sh' script file", and the command always contain "HOST_IP" and "APP_ENV" above.
+# docker exec -it CONTAINER_NAME cat /var/log/env_build_args.log
+DOCKER_BUILD_ARGS={"SAMPLE":"YAHOO","SAMPLE2":"YAHOO2","shared_volume_group_id":"1351","shared_volume_group_name":"laravel-shared-volume-group"}
+DOCKER_BUILD_LABELS=["foo=happy","bar=sad"]
+# EX. For Mac, add --platform linux/amd64 here
+DOCKER_BUILD_ADDITIONAL_RAW_PARAMS=
+# Your Git's commit SHA will be added as a label to DOCKER_BUILD_LABELS when your container is built.
+DOCKER_BUILD_SHA_INSERT_GIT_ROOT=
+
+# [NOTICE] Set this to be "/your-project-path:/var/www/app" for local development
+DOCKER_COMPOSE_SELECTIVE_VOLUMES=["./shared/app-error-logs:/var/www/app/storage/logs"]
+DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=["./shared/nginx-error-logs:/var/log/nginx"]
+DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
+
+DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD=40s
+
+NGINX_CLIENT_MAX_BODY_SIZE=50M
+
+USE_MY_OWN_APP_YML=false
+
+SKIP_BUILDING_APP_IMAGE=true
+
+ORCHESTRATION_TYPE=compose
+
+ONLY_BUILDING_APP_IMAGE=false
+
+DOCKER_BUILD_MEMORY_USAGE=1G
+
+USE_NGINX_RESTRICTED_LOCATION=false
+# ex. /docs/api-app.html
+NGINX_RESTRICTED_LOCATION=xxx
+
+REDIRECT_HTTPS_TO_HTTP=true
+
+NGINX_LOGROTATE_FILE_NUMBER=7
+NGINX_LOGROTATE_FILE_SIZE=100K
+
+SHARED_VOLUME_GROUP_ID=1351
+SHARED_VOLUME_GROUP_NAME=laravel-shared-volume-group
+UIDS_BELONGING_TO_SHARED_VOLUME_GROUP_ID=1000
+
+ONLY_BUILDING_APP_IMAGE_FOR_PRODUCTION=true
+
+REMOTE_DEPLOYMENT_RUNNER_PATH=/home/my-account/docker-blue-green-runner
+REMOTE_DEPLOYMENT_IP_ADDRESS_LIST=["111.111.111.111"]
+REMOTE_DEPLOYMENT_PORT_NUMBER_LIST=["11222"]
+REMOTE_DEPLOYMENT_SSH_PRIVATE_KEY_LOCAL_PATH_WITH_FILE=~/.ssh/id_rsa_ssh_deployer
+REMOTE_DEPLOYMENT_SSH_USER=my-account
+REMOTE_DEPLOYMENT_FAILURE_STRATEGY=stop
+
+WITH_SUDO=false
diff --git a/.env.example.php.production.remote b/.env.example.php.production.remote
@@ -0,0 +1,93 @@
+# IMPORTANT - mac : docker.for.mac.localhost OR check IP. / win : host.docker.internal OR you can just type your host IP.
+HOST_IP=host.docker.internal
+
+APP_URL=https://localhost:8085
+
+USE_COMMERCIAL_SSL=true
+COMMERCIAL_SSL_NAME=laravel-crud-boilerplate
+
+DOCKER_LAYER_CORRUPTION_RECOVERY=false
+
+NGINX_RESTART=false
+
+# The method of acquiring Docker images:
+# build (Used in developer's local environment or during Jenkins builds when a new image needs to be built, so this module is typically used)
+# registry (Used on deployment servers where images are fetched from a repository, so this module is used)
+# If you choose the "build" method, you don't need to input the values below since Dockerfile is used (no image is fetched from the Docker registry).
+GIT_IMAGE_LOAD_FROM=file
+GIT_IMAGE_LOAD_FROM_HOST=xxx
+GIT_IMAGE_LOAD_FROM_PATHNAME=xxx
+GIT_TOKEN_IMAGE_LOAD_FROM_USERNAME=xxx
+GIT_TOKEN_IMAGE_LOAD_FROM_PASSWORD=xxx
+GIT_IMAGE_VERSION=1.0.0
+
+PROJECT_NAME=laravel_crud_boilerplate
+PROJECT_LOCATION=/var/www/app
+PROJECT_PORT=[8085,8081]
+# Example (8093,8094,11000...)
+ADDITIONAL_PORTS=
+
+# If you locate your project on ../ (upper folder)
+HOST_ROOT_LOCATION=./samples/laravel-crud-boilerplate
+# If you locate your project's Dockerfile ../ (upper folder)
+DOCKER_FILE_LOCATION=./samples/laravel-crud-boilerplate
+
+# This is for integrating health checkers such as "https://www.baeldung.com/spring-boot-actuators"
+APP_HEALTH_CHECK_PATH=api/v1/health
+BAD_APP_HEALTH_CHECK_PATTERN=DOWN
+GOOD_APP_HEALTH_CHECK_PATTERN=UP
+
+
+# This is for environment variables for docker-compose-app.
+DOCKER_COMPOSE_ENVIRONMENT={"XDEBUG_CONFIG":"idekey=IDE_DEBUG","PHP_IDE_CONFIG":"serverName=laravel-crud-boilerplate"}
+# This goes with "docker build ... in the 'run.sh' script file", and the command always contain "HOST_IP" and "APP_ENV" above.
+# docker exec -it CONTAINER_NAME cat /var/log/env_build_args.log
+DOCKER_BUILD_ARGS={"SAMPLE":"YAHOO","SAMPLE2":"YAHOO2","shared_volume_group_id":"1351","shared_volume_group_name":"laravel-shared-volume-group"}
+DOCKER_BUILD_LABELS=["foo=happy","bar=sad"]
+# EX. --platform linux/amd64
+DOCKER_BUILD_ADDITIONAL_RAW_PARAMS=
+# Your Git's commit SHA will be added as a label to DOCKER_BUILD_LABELS when your container is built.
+DOCKER_BUILD_SHA_INSERT_GIT_ROOT=
+
+# [NOTICE] Set this to be "/your-project-path:/var/www/app" for local development
+DOCKER_COMPOSE_SELECTIVE_VOLUMES=["./shared/app-error-logs:/var/www/app/storage/logs"]
+DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=["./shared/nginx-error-logs:/var/log/nginx"]
+DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
+
+DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD=40s
+
+NGINX_CLIENT_MAX_BODY_SIZE=50M
+
+USE_MY_OWN_APP_YML=false
+
+SKIP_BUILDING_APP_IMAGE=false
+
+ORCHESTRATION_TYPE=compose
+
+ONLY_BUILDING_APP_IMAGE=false
+
+DOCKER_BUILD_MEMORY_USAGE=1G
+
+USE_NGINX_RESTRICTED_LOCATION=false
+# ex. /docs/api-app.html
+NGINX_RESTRICTED_LOCATION=xxx
+
+REDIRECT_HTTPS_TO_HTTP=true
+
+NGINX_LOGROTATE_FILE_NUMBER=7
+NGINX_LOGROTATE_FILE_SIZE=100K
+
+SHARED_VOLUME_GROUP_ID=1351
+SHARED_VOLUME_GROUP_NAME=laravel-shared-volume-group
+UIDS_BELONGING_TO_SHARED_VOLUME_GROUP_ID=1002
+
+ONLY_BUILDING_APP_IMAGE_FOR_PRODUCTION=false
+
+REMOTE_DEPLOYMENT_RUNNER_PATH=
+REMOTE_DEPLOYMENT_IP_ADDRESS_LIST=
+REMOTE_DEPLOYMENT_PORT_NUMBER_LIST=
+REMOTE_DEPLOYMENT_SSH_PRIVATE_KEY_LOCAL_PATH_WITH_FILE=
+REMOTE_DEPLOYMENT_SSH_USER=
+REMOTE_DEPLOYMENT_FAILURE_STRATEGY=
+
+WITH_SUDO=false
diff --git a/README.md b/README.md
@@ -55,11 +55,11 @@
    - In contrast, Traefik requires the creation and gradual adjustment of various configuration files, which requires your App's docker binary running.
 
 
-2. **Isomorphic local-and-remote runner**
-  - The same `run.sh` and `.env` drive deployments locally and on remote servers over SSH.
+2. **Isomorphic standalone-and-remote runner**
+  - The same `run.sh` and `.env` drive deployments on standalone hosts and on remote servers over SSH.
   - Remote servers receive the image binary and execute the same pipeline with `GIT_IMAGE_LOAD_FROM=file` (see [Production > GIT_IMAGE_LOAD_FROM=file](#1-git_image_load_fromfile-strategy-without-docker-registry)).
   - Behavior stays consistent across environments; only the image source differs (build/registry/file).
-  - Example: Run the same pipeline across local and remote (SSH) environments using a single `run.sh` and `.env`. Includes a file-based image delivery and remote execution flow via `GIT_IMAGE_LOAD_FROM=file`.
+  - Example: Run the same pipeline across standalone and remote (SSH) environments using a single `run.sh` and `.env`. Includes a file-based image delivery and remote execution flow via `GIT_IMAGE_LOAD_FROM=file`.
 
 3. **No unpredictable errors in reverse proxy and deployment : Implement safety measures to handle errors caused by your app or Nginx**
   - If any error occurs in the app or router, ``deployment is halted`` to prevent any impact on the existing deployment
@@ -487,39 +487,22 @@ graph TD;
   E -->|Send Docker Image Binary| D[Server 3]
   F[Git] -->|Github Action or Jenkins| E[Build Server]
 ```
-- Set the Load Balancer to use "Round-Robin"
-  - What is "Round-Robin"?
-    - Round-robin is a load-balancing method that distributes incoming requests evenly across all available servers in a sequential order. For example, the first request goes to Server 1, the second request to Server 2, the third request to Server 3, and then it cycles back to Server 1. This ensures a balanced distribution of traffic across the servers.
-- Your Github Action or Jenkins scripts just send the source codes to the Build Server or run ``git pull`` on the server.
-- Set the 'Docker-Blue-Green-Runner' on the Build Server, and run ``run.sh`` with ``ONLY_BUILDING_APP_IMAGE_FOR_PRODUCTION`` set to ``true``.
-- The ``ONLY_BUILDING_APP_IMAGE_FOR_PRODUCTION=true`` creates the Docker binary file to ``./.docker/binary``
-- If ``REMOTE_DEPLOYMENT_RUNNER_PATH``, ``REMOTE_DEPLOYMENT_IP_ADDRESS_LIST``, ``REMOTE_DEPLOYMENT_PORT_NUMBER_LIST``, and ``REMOTE_DEPLOYMENT_SSH_PRIVATE_KEY_LOCAL_PATH_WITH_FILE`` are set:
-  - The Runner automatically copies the binary to each server at ``${REMOTE_DEPLOYMENT_RUNNER_PATH}/.docker/binary``.
-  - If ``REMOTE_DEPLOYMENT_FAILURE_STRATEGY`` is set (``stop`` | ``rollback`` | ``go``), the Runner connects via SSH and executes ``sudo bash run.sh`` on each server after pre-checks (``GIT_IMAGE_LOAD_FROM=file`` and sudo). Failures follow the configured strategy.
-- If ``REMOTE_DEPLOYMENT_FAILURE_STRATEGY`` is NOT set, you can perform the steps manually:
-  - Set ``GIT_IMAGE_LOAD_FROM=file`` on each server.
-  - Copy the binary to each server's ``${REMOTE_DEPLOYMENT_RUNNER_PATH}/.docker/binary``.
-  - Run ``run.sh`` on ``Server 1``; if any issues are found, run ``rollback.sh``.
-  - If no problems are detected, run ``run.sh`` on both ``Server 2`` and ``Server 3``.
-
+- From the sample envs (``.env.example.php.production.build``for the Build Server, ``.env.example.php.production.remote``for the Server 1,2,3),
+  - Your Github Action or Jenkins scripts just send the source codes to the Build Server or run ``git pull`` on the server.
+  - Set the 'Docker-Blue-Green-Runner' on the Build Server, and run ``run.sh`` with ``ONLY_BUILDING_APP_IMAGE_FOR_PRODUCTION`` set to ``true``.
+    - If you want to deploy without building and only use the files already present on Server 1, 2, and 3, set ``SKIP_BUILDING_APP_IMAGE=true``.
+  - The ``ONLY_BUILDING_APP_IMAGE_FOR_PRODUCTION=true`` creates the Docker binary file to ``./.docker/binary``
+  - If ``REMOTE_DEPLOYMENT_RUNNER_PATH``, ``REMOTE_DEPLOYMENT_IP_ADDRESS_LIST``, ``REMOTE_DEPLOYMENT_PORT_NUMBER_LIST``, and ``REMOTE_DEPLOYMENT_SSH_PRIVATE_KEY_LOCAL_PATH_WITH_FILE`` are set:
+    - The Runner automatically copies the binary to each server at ``${REMOTE_DEPLOYMENT_RUNNER_PATH}/.docker/binary``.
+    - If ``REMOTE_DEPLOYMENT_FAILURE_STRATEGY`` is set (``stop`` | ``rollback`` | ``go``), the Runner connects via SSH and executes ``sudo bash run.sh`` on each server after pre-checks (``GIT_IMAGE_LOAD_FROM=file`` and sudo). Failures follow the configured strategy.
+  - If ``REMOTE_DEPLOYMENT_FAILURE_STRATEGY`` is NOT set, you can perform the steps manually:
+    - Set ``GIT_IMAGE_LOAD_FROM=file`` on each server.
+    - Copy the binary to each server's ``${REMOTE_DEPLOYMENT_RUNNER_PATH}/.docker/binary``.
+    - Run ``run.sh`` on ``Server 1``; if any issues are found, run ``rollback.sh``.
+    - If no problems are detected, run ``run.sh`` on both ``Server 2`` and ``Server 3``.
 - Tip: For smooth permission and volume access, include the UID of the ``REMOTE_DEPLOYMENT_SSH_USER`` in ``UIDS_BELONGING_TO_SHARED_VOLUME_GROUP_ID`` (in your `.env`).
-
 - CI tip: If you set ``REMOTE_DEPLOYMENT_SSH_PRIVATE_KEY_LOCAL_PATH_WITH_FILE`` and ``REMOTE_DEPLOYMENT_SSH_USER`` to match your GitHub Actions credentials, and your workflow triggers ``sudo bash run.sh`` on the build server, then with ``REMOTE_DEPLOYMENT_FAILURE_STRATEGY`` configured, the Runner can perform end-to-end distribution and remote execution in a single run.
 
-
-APP_URL=https://localhost:8085
-
-USE_COMMERCIAL_SSL=true
-COMMERCIAL_SSL_NAME=laravel-crud-boilerplate
-# COMMERCIAL_SSL_NAME 이름은 pk, chained crt 
-
-REMOTE_DEPLOYMENT_RUNNER_PATH=/home/teamlead/test-projects/docker-blue-green-runner
-REMOTE_DEPLOYMENT_IP_ADDRESS_LIST=["223.130.154.176"]
-REMOTE_DEPLOYMENT_PORT_NUMBER_LIST=["10222"]
-REMOTE_DEPLOYMENT_SSH_PRIVATE_KEY_LOCAL_PATH_WITH_FILE=~/.ssh/id_rsa_ssh_dev
-REMOTE_DEPLOYMENT_SSH_USER=teamlead
-REMOTE_DEPLOYMENT_FAILURE_STRATEGY=stop
-
 ### 2. ``GIT_IMAGE_LOAD_FROM=registry`` strategy (with Docker Registry)
 #### Upload Image (CI/CD Server -> Git)
   - If you run the ``push-to-git.sh`` command, it pushes the container image currently running on the test server to the ``Git Container Registry`` at the specified address.
