docs(deployment): match the Coolify quickstart to the panel's actual flow - #274
Merged
Merged
Conversation
…flow Step 3 described a resource type Coolify does not have. Follow what the panel does: Public Git repository, Check repository, Docker Compose as the build pack, Continue, and Deploy from the resource's own Actions once the domain and MEITH_IMAGE are in. Rename the scaffold's compose file to docker-compose.yaml, the path Coolify's Compose file field already carries, so it stays the field nobody has to type — the eject kit, the deploy-kit smoke script, the generated create-board.sh and the docs follow the same name. The template route no longer jumps straight to step 3: its build starts on its own and step 3 needs what that build prints. The package-visibility step now says to check rather than change — a build from a public repository usually publishes a public package already — in the docs, the scaffolded README and the build workflow's own Summary. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TVkvGWYwMi96TwzozqYvmy
The quickstart already recommended :latest without a reason, while the build workflow's Summary told the same operator to prefer the sha — so the one paragraph and the page they copy from disagreed at the moment of pasting. The quickstart now gives the reason: :latest follows main, so installing a plugin later is a push and a Redeploy with nothing on the resource to edit, and the commit-sha value is where to move once the board is settled. The troubleshooting row for a board on a newer version than deployed says the same thing rather than treating it as a fault. The Summary and the scaffolded README still lead with the sha, which their own tests require, but neither instructs against the quickstart any more: both print the two values, what each does, and which one the quickstart takes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TVkvGWYwMi96TwzozqYvmy
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.
Walking the Coolify quickstart against a real panel turned up four places where the page describes something the UI does not do. This fixes those, and renames the scaffold's compose file so the one field the page promises you never have to touch is actually already correct.
Step 3 described a resource type Coolify does not have
New Resource → Docker Compose → Public Repositoryis now the flow the panel really has: New Resource → Public Git repository, paste the URL, press Check repository, then a field table covering Branch, Build pack → Docker Compose (flagged as the one field on that screen you have to change), Base directory and Compose file, then Continue.Deploying is likewise on the resource's own Actions, not a bare "press deploy", and the page now says to leave it until the domain and
MEITH_IMAGEare both in.docker-compose.yml→docker-compose.yamlCoolify's Compose file field is prefilled with
/docker-compose.yaml, so the old name meant editing a field both this page and Self-hosting claimed you never had to. The scaffold now writesdocker-compose.yaml, andboard:eject, the deploy-kit smoke script, the generatedcreate-board.shand the docs follow the same name.The
meith-dev/templaterepository still carries the old name and needs regenerating from the scaffold — it is outside this repo, so it is not in this change.The template route skipped the value step 3 needs
The "Use this template" bullet said to skip straight to step 3, which stepped over the note telling you to collect
MEITH_IMAGEfrom the finished build. It now sends you to the end of step 2 instead, and that note opens by naming the wait: the Actions tab, the Build and push run, and what its Summary prints.Package visibility is a check, not a chore
A build from a public repository usually publishes a public package already, so "make the package public (it starts private)" sent people to change a setting that was often already right. It now says to check it, and to change it only if it says Private. Same correction in the docs, the scaffolded README and the build workflow's own Summary text, so the three agree.
:latestis the quickstart's choice, and now says whyThe page recommended
:latestwith no reason while the build workflow's Summary told the same operator to prefer the sha — the two disagreed at the moment of pasting. The quickstart now gives the reason::latestfollowsmain, so installing a plugin later is a push and a Redeploy with nothing on the resource to edit, and the commit-sha value is where to move once the board is settled and you want upgrades only when you choose. The troubleshooting row for a board on a newer version than deployed says the same rather than treating it as a fault.The Summary and the scaffolded README still lead with the sha, which their own tests require, but neither instructs against the quickstart any more: both print the two values, what each does, and which the quickstart takes.
Validation
pnpm verifypasses. The scaffold tree digests moved forDockerfile,docker-entrypoint.sh,README.mdand.github/workflows/build.yml, andapps/web/public/create-board.shwas regenerated withpnpm board-installer:gen.