feat(gensui): add missing docker-compose.yml#15
Open
wstlima wants to merge 1 commit into
Open
Conversation
README.md and both Gensui-Docker-Install.{sh,bat} scripts document
and depend on a docker-compose.yml living in gensui/ (`cd
Shogun/gensui && docker compose up -d`), but no such file exists in
this repository — confirmed absent across the full commit history
(`git log --all --oneline -- '**/docker-compose*'` returns nothing)
and in the only GitHub release (v1.0.0.0, which ships only the
installer scripts, no source).
gensui/.gitignore already has a `docker-compose.yml` entry (line 71),
suggesting this was meant to be provided by each deployer rather than
committed — but that leaves the README's `docker compose up -d`
Quick Start unusable out of the box. Adding a reference compose file
(force-added past .gitignore for this PR) so the documented flow
actually works. Maintainers may prefer to keep it gitignored upstream
and treat this as a template/example instead.
Basic service: builds gensui/Dockerfile from the repo root context
(required by that Dockerfile's `COPY pyproject.toml` — see the
companion PR fixing the Dockerfile's frontend COPY paths), binds only
to 127.0.0.1:8787, persists /app/data and /app/logs in named volumes.
Optional `server` profile adds the nginx reverse proxy the README
describes for TLS (`docker compose --profile server up -d`), reusing
the existing gensui/nginx.conf.
Depends on the Dockerfile fix in
fix/gensui-dockerfile-wrong-frontend — without it this compose file
builds successfully but serves the wrong frontend.
Tested end-to-end:
cd gensui && cp .env.example .env # + set a random JWT secret
docker compose up -d --build
curl http://127.0.0.1:8787/api/gensui/health
# {"status":"ok","service":"gensui","version":"0.1.0"}
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #4
Summary
README.mdand bothGensui-Docker-Install.{sh,bat}scripts document and depend on adocker-compose.ymlliving ingensui/(cd Shogun/gensui && docker compose up -d), but no such file exists in this repository — confirmed absent across the full commit history and in the only GitHub release (v1.0.0.0, which ships only the installer scripts, no source).gensui/.gitignorealready has adocker-compose.ymlentry, suggesting this was meant to be provided by each deployer rather than committed — but that leaves the README's Quick Start unusable out of the box. This PR adds a reference compose file (force-added past.gitignore) so the documented flow actually works. Maintainers may prefer to keep it gitignored upstream and treat this as a template instead.What it does
gensuiservice: buildsgensui/Dockerfilefrom the repo root context, binds only to127.0.0.1:8787, persists/app/dataand/app/logsin named volumesserverprofile adds the nginx reverse proxy the README describes for TLS (docker compose --profile server up -d), reusing the existinggensui/nginx.confDepends on
#14 (Dockerfile frontend fix) — without it this compose file builds successfully but serves the wrong frontend.
Test plan
cd gensui && cp .env.example .env(+ random JWT secret) →docker compose up -d --build→curl http://127.0.0.1:8787/api/gensui/healthreturns{"status":"ok",...}