Skip to content

Commit e313df7

Browse files
fix : README
1 parent 69382b1 commit e313df7

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,11 @@
5555
- In contrast, Traefik requires the creation and gradual adjustment of various configuration files, which requires your App's docker binary running.
5656

5757

58-
2. Isomorphic local-and-remote runner**
58+
2. **Isomorphic local-and-remote runner**
5959
- The same `run.sh` and `.env` drive deployments locally and on remote servers over SSH.
6060
- 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)).
6161
- Behavior stays consistent across environments; only the image source differs (build/registry/file).
62+
- 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`.
6263

6364
3. **No unpredictable errors in reverse proxy and deployment : Implement safety measures to handle errors caused by your app or Nginx**
6465
- If any error occurs in the app or router, ``deployment is halted`` to prevent any impact on the existing deployment
@@ -267,6 +268,7 @@ WITH_SUDO=true
267268
- When `true`, the runner executes privileged operations with `sudo` where needed.
268269
- When `false`, `sudo` is not used. After installing Docker-Blue-Green-Runner, follow the steps in the [Security](#security) section and then run the root-level `apply-security.sh` to set secure permissions. Also, grant appropriate host permissions for Docker, Nginx, and related resources to the user running the runner.
269270
- For security, it is recommended to keep this `false` where possible and rely on proper host permissions and ACLs instead of broad sudo usage.
271+
- Example: Recommended to operate with `WITH_SUDO=false`, supported by `apply-security.sh`. Safely applies host permissions and ACLs via `SHARED_VOLUME_GROUP_*`.
270272

271273
#### ``APP_URL``
272274
- ```shell
@@ -505,6 +507,19 @@ graph TD;
505507
- 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.
506508
507509
510+
APP_URL=https://localhost:8085
511+
512+
USE_COMMERCIAL_SSL=true
513+
COMMERCIAL_SSL_NAME=laravel-crud-boilerplate
514+
# COMMERCIAL_SSL_NAME 이름은 pk, chained crt
515+
516+
REMOTE_DEPLOYMENT_RUNNER_PATH=/home/teamlead/test-projects/docker-blue-green-runner
517+
REMOTE_DEPLOYMENT_IP_ADDRESS_LIST=["223.130.154.176"]
518+
REMOTE_DEPLOYMENT_PORT_NUMBER_LIST=["10222"]
519+
REMOTE_DEPLOYMENT_SSH_PRIVATE_KEY_LOCAL_PATH_WITH_FILE=~/.ssh/id_rsa_ssh_dev
520+
REMOTE_DEPLOYMENT_SSH_USER=teamlead
521+
REMOTE_DEPLOYMENT_FAILURE_STRATEGY=stop
522+
508523
### 2. ``GIT_IMAGE_LOAD_FROM=registry`` strategy (with Docker Registry)
509524
#### Upload Image (CI/CD Server -> Git)
510525
- 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.

0 commit comments

Comments
 (0)