Repository navigation
docs: make the first install followable and name current settings - #28
Merged
Merged
Conversation
The agent installer stored KEEL_* keys and rejected AVEN_* ones, and join, webhook, and Railpack errors named only the old setting. Docker failures from the server installer now include docker info output and call out a permission denial separately from a stopped daemon. Co-authored-by: 투린 <me@turin.my>
The README now walks through prerequisites, reading the installer, what it writes, how to check it, and the failure modes in the code. The self-hosting guides cover backups, PITR, upgrades, uninstall, and the same limits. The site no longer calls the install a few minutes or the software free of server and domain cost. Co-authored-by: 투린 <me@turin.my>
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.
What and why
A new reader should be able to install Aven from the README without guessing ports, DNS, which files change, or how to undo it. The README and the Korean README now follow the installer. The long backup, upgrade, uninstall, and troubleshooting steps are in the self-hosting guides. A few first-run messages still told people to use Keel setting names.
How
Docs were written from
install-server.sh,internal/api/install-agent.sh, server startup, the proxy container, the SQLite backup path, andaven pitrindocs/cli.md. They do not add a memory or disk minimum: the installer does not check one, so the old "2 vCPU and 4 GB" line is gone.Small code changes, each covered by a test:
AVEN_*andKEEL_*extra settings and writesAVEN_*. It still reads an oldKEEL_*value. The unit stayskeel-agent.serviceand the directories stay/etc/keel-agentand/var/lib/keel-agent, so a re-run still replaces an existing agent.AVEN_PRIVATE_ADDRESSandAVEN_JOIN_TOKEN, and no longer tells the operator to addKEEL_PRIVATE_ADDRESS.docker infofailures include the command's own text. A permission denial is not reported as a stopped daemon.AVEN_*first and still mention theKEEL_*name.Changes
README.mdandREADME.ko.md: prerequisites (OS, what Docker is checked, memory and disk not checked, ports, domain and DNS for on-demand TLS), read-the-script-then-run, files and services a main install and a region install create, how to check that it started, short troubleshooting, and pointers to the manual install and uninstall. Cron and app sleeping in the highlights point at the existing experimental rows. The comparison table and the GIF are unchanged.docs/self-hosting.mdanddocs/self-hosting.ko.md: the same path in full, including backups and restore ofaven.dbplusmaster.key, logical dumps, Postgres WAL and MySQL binlog PITR, upgrade and rollback, uninstall, and troubleshooting for ports in use, DNS or TLS, Docker permissions, firewall or IPv6, and an agent that does not join. Stalekeel.db/docker logs keel-proxycommands for a new install now sayaven.dbandaven-proxy, and say when the old names still apply. The English guide uses the English admin labels.docs/selfhost.mdanddocs/selfhost.ko.md:docker ps --filter label=aven.self, with the oldkeel.selflabel called out for an install that still has it. The swap note namesaven-proxy.website/lang/en/site.phpandwebsite/lang/ko/site.php: the install section no longer says the install finishes in a few minutes, the closing line no longer calls Aven free, cron and sleeping apps are marked experimental, and the dashboard section says the UI has no component or end-to-end tests.home.blade.phpprints that note.Checklist
go test ./...passed locally.cd web && npm run typecheck && npm run i18n:check && npm run buildpassed.i18n:checkstill prints pre-existing untranslated Korean strings and exits 0.AVEN_SERVER_URL/AVEN_JOIN_TOKEN/AVEN_CA_FILEinstead of theKEEL_*spellings. An existingKEEL_*value is still read, and a re-run rewrites the managed keys toAVEN_*. The systemd unit name did not change.What was not verified
sh -nand the Go tests cover the script text. The failure text is from the source, not from a live ACME, firewall, or join attempt.go vetwas run on the packages this change touches, not asgo vet ./....Follow-ups
aven-agent.service,/etc/aven-agent, and/var/lib/aven-agent, and migrate an existingkeel-agentunit. That is a larger change than rewriting the env keys.install-agent.shstill callsdieinside the--envpipeline. Withoutpipefail, a rejected key may not stop the parent shell. That was already true.HTTP 401and drops the API error body (invalid join token/invalid or expired join token).