Skip to content

docs: add local deployment and upgrade guides#550

Open
Ezio58 wants to merge 3 commits intoC4illin:mainfrom
Ezio58:codex/local-docker-deploy-impl
Open

docs: add local deployment and upgrade guides#550
Ezio58 wants to merge 3 commits intoC4illin:mainfrom
Ezio58:codex/local-docker-deploy-impl

Conversation

@Ezio58
Copy link
Copy Markdown

@Ezio58 Ezio58 commented Mar 27, 2026

Summary

  • add a dedicated local Docker deployment guide and Compose entrypoint
  • pin the local deployment image by digest instead of following a floating tag
  • document a fork plus upstream upgrade workflow to reduce future merge conflicts

Test Plan

  • bun run build
  • bun test
  • docker compose --env-file .env.local -f compose.local.yaml config
  • docker compose --env-file .env.local -f compose.local.yaml up -d
  • curl -fsS http://127.0.0.1:3000/healthcheck

Summary 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.

  • New Features
    • Added compose.local.yaml and .env.local.example for local runs (pulls ghcr.io/c4illin/convertx by default; override via CONVERTX_IMAGE).
    • Added docs/local-deploy.md with quick-start, common commands, and verification steps; linked from README.md.
    • Updated .gitignore to ignore /.worktrees.

Written for commit 49f28bd. Summary will update on new commits.

@github-actions github-actions bot added Docs and removed Docs labels Mar 27, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-ai with guidance or docs links (including llms.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
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Fix with Cubic

@github-actions github-actions bot added Docs and removed Docs labels Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant