Keep run as ignored local checkout
This commit is contained in:
@@ -6,7 +6,7 @@ This repository is the game server management platform workspace. It replaces th
|
||||
- `platform_web/`: management console frontend.
|
||||
- `plugins/`: game management plugin workspace. A plugin defines how to create and manage one server type, and one installed plugin can create many server instances.
|
||||
|
||||
The machine-side executor source lives in the separate `git@git.npc0.com:admin343/run.git` repository. Local debug and Docker workflows can still start it through `RUN_REPO_DIR`.
|
||||
The machine-side executor source lives in the separate `git@git.npc0.com:admin343/run.git` repository. Local debug and Docker workflows can keep it at `./run` as an ignored nested checkout, or use another path through `RUN_REPO_DIR`.
|
||||
|
||||
## Product Scope
|
||||
|
||||
@@ -69,13 +69,13 @@ Run focused checks when working in one root:
|
||||
Run executor checks are owned by the separate run checkout:
|
||||
|
||||
```bash
|
||||
(cd "${RUN_REPO_DIR:-../run}" && go test ./...)
|
||||
(cd "${RUN_REPO_DIR:-./run}" && go test ./...)
|
||||
```
|
||||
|
||||
Run the API-backed local debug workspace when you need platform, run, platform_web, and the dev plugin fixture together:
|
||||
|
||||
```bash
|
||||
git clone git@git.npc0.com:admin343/run.git ../run # once, if the sibling checkout is missing
|
||||
git clone git@git.npc0.com:admin343/run.git run # once, if the ignored local checkout is missing
|
||||
scripts/local-debug-start.sh
|
||||
scripts/local-debug-smoke.sh
|
||||
```
|
||||
@@ -87,7 +87,7 @@ Start local processes:
|
||||
|
||||
```bash
|
||||
(cd platform && go run ./cmd/platform)
|
||||
(cd "${RUN_REPO_DIR:-../run}" && go run ./cmd/run)
|
||||
(cd "${RUN_REPO_DIR:-./run}" && go run ./cmd/run)
|
||||
(cd platform_web && npm run dev)
|
||||
```
|
||||
|
||||
@@ -96,7 +96,7 @@ Start local processes:
|
||||
Use the root compose file for a local all-in-one deployment:
|
||||
|
||||
```bash
|
||||
git clone git@git.npc0.com:admin343/run.git ../run # once, if the sibling checkout is missing
|
||||
git clone git@git.npc0.com:admin343/run.git run # once, if the ignored local checkout is missing
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
@@ -108,7 +108,7 @@ Then open:
|
||||
The compose deployment starts:
|
||||
|
||||
- `platform`: backend on container port `8080`, published as host port `8080`.
|
||||
- `run`: worker mode executor built from `${RUN_REPO_DIR:-../run}` and connected to `http://platform:8080`.
|
||||
- `run`: worker mode executor built from `${RUN_REPO_DIR:-./run}` and connected to `http://platform:8080`.
|
||||
- `platform-web`: built static console served by Nginx on container port `80`, published as host port `5173`.
|
||||
|
||||
Persistent Docker data lives in named volumes:
|
||||
@@ -157,7 +157,7 @@ cp platform/.env.example platform/.env
|
||||
cp platform_web/.env.example platform_web/.env
|
||||
|
||||
(cd platform && set -a && source .env && set +a && go run ./cmd/platform)
|
||||
(cd "${RUN_REPO_DIR:-../run}" && go run ./cmd/run)
|
||||
(cd "${RUN_REPO_DIR:-./run}" && go run ./cmd/run)
|
||||
(cd platform_web && npm run dev)
|
||||
```
|
||||
|
||||
@@ -167,7 +167,7 @@ Most common edits:
|
||||
- Platform file persistence: `PLATFORM_STORAGE_BACKEND=file`, `PLATFORM_METADATA_PATH`, `PLATFORM_LOG_DIR`.
|
||||
- Platform MySQL metadata: `PLATFORM_STORAGE_BACKEND=mysql`, `PLATFORM_MYSQL_DSN=platform:platform@tcp(127.0.0.1:3306)/platform?parseTime=true`.
|
||||
- Log body persistence: `PLATFORM_LOG_BODY_BACKEND=file`, `PLATFORM_LOG_DIR`.
|
||||
- Run source checkout: `RUN_REPO_DIR=../run`.
|
||||
- Run source checkout: `RUN_REPO_DIR=./run` by default; `run/` is ignored by the browser repository.
|
||||
- Run worker mode: `RUN_MODE=worker`.
|
||||
- Run-to-platform URL: `RUN_PLATFORM_URL=http://127.0.0.1:8080` locally, `http://platform:8080` in Docker.
|
||||
- Run local data: `RUN_WORKSPACE_ROOT`, `RUN_SPOOL_ROOT`.
|
||||
|
||||
Reference in New Issue
Block a user