docs: add local deployment and upgrade guides#550
Open
Ezio58 wants to merge 3 commits intoC4illin:mainfrom
Open
docs: add local deployment and upgrade guides#550Ezio58 wants to merge 3 commits intoC4illin:mainfrom
Ezio58 wants to merge 3 commits intoC4illin:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
1 issue found across 6 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/local-deploy.md">
<violation number="1" location="docs/local-deploy.md:62">
P2: The docs recommend `docker compose restart` after config changes, which can leave updated env/compose/image settings unapplied because containers are not recreated.</violation>
</file>
Since this is your first cubic review, here's how it works:
- cubic automatically reviews your code and comments on bugs and improvements
- Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
- Add one-off context when rerunning by tagging
@cubic-dev-aiwith guidance or docs links (includingllms.txt) - Ask questions if you need clarification on any suggestion
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| Restart after changing configuration: | ||
|
|
||
| ```bash | ||
| docker compose --env-file .env.local -f compose.local.yaml restart |
Contributor
There was a problem hiding this comment.
P2: The docs recommend docker compose restart after config changes, which can leave updated env/compose/image settings unapplied because containers are not recreated.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/local-deploy.md, line 62:
<comment>The docs recommend `docker compose restart` after config changes, which can leave updated env/compose/image settings unapplied because containers are not recreated.</comment>
<file context>
@@ -0,0 +1,69 @@
+Restart after changing configuration:
+
+```bash
+docker compose --env-file .env.local -f compose.local.yaml restart
+```
+
</file context>
Suggested change
| docker compose --env-file .env.local -f compose.local.yaml restart | |
| docker compose --env-file .env.local -f compose.local.yaml up -d |
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
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.
Summary
Test Plan
bun run buildbun testdocker compose --env-file .env.local -f compose.local.yaml configdocker compose --env-file .env.local -f compose.local.yaml up -dcurl -fsS http://127.0.0.1:3000/healthcheckSummary by cubic
Adds a dedicated local Docker deployment path with a separate Compose file and a focused local deployment guide. Makes local runs simpler and safer using env-based config, a data volume, port mapping, and a healthcheck.
compose.local.yamland.env.local.examplefor local runs (pullsghcr.io/c4illin/convertxby default; override viaCONVERTX_IMAGE).docs/local-deploy.mdwith quick-start, common commands, and verification steps; linked fromREADME.md..gitignoreto ignore/.worktrees.Written for commit 49f28bd. Summary will update on new commits.