docs: fix and modernize dev_running_from_source.markdown#309
Merged
Conversation
tuxmea
approved these changes
Jun 7, 2026
miharp
force-pushed
the
docs/issue-165-docker-agent
branch
from
055213f to
c20bafd
Compare
Rewrite the Docker agent section to the actual working flow and apply related corrections found while testing the guide end-to-end against a from-source server. - Docker agent: connect via `--add-host puppet:host-gateway` (default `--server puppet`), persist a named SSL volume, autosign by default, and document the manual `puppetserver-ca` path and its requirement that the server name resolve on the host. - Quick Start: rename from "Step 0"; replace the no-op `rm -rf ~/.puppetserver` with a recoverable timestamped `mv` backup; run the source agent through Bundler; point to the Step 1 prerequisites. - Prerequisites: add Ruby 3.1+; reword the stale Leiningen version. - Step 3: enable autosign with `puppet config set ... --section server`; update deprecated `jruby-puppet.master-*` settings to `server-*`. - OpenVoxDB section: `[master]` -> `[server]`, routes `master:` -> `server:`, grammar fix. - Structure/conventions: nest the Step 4c gotchas as `###`; "puppet master" -> "Puppet Server"; convert terminal `bash` fences to `console` per CONTRIBUTING. Signed-off-by: Michael Harp <mike@mikeharp.com> Assisted-by: Claude Opus 4.8 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
miharp
force-pushed
the
docs/issue-165-docker-agent
branch
from
c20bafd to
4541afd
Compare
tuxmea
approved these changes
Jun 8, 2026
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
2 participants
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
Fixes and modernizes
dev_running_from_source.markdown. Started as a fix for the broken Docker agent section and expanded into related corrections found while testing the guide end-to-end against a from-source server.Changes
Docker agent section (the original issue)
--add-host puppet:host-gatewaywith the default--server puppet, instead of the Docker host IP (which fails TLS hostname validation).puppetserver-ca signpath and its requirement that the server name resolve on the host.Quick Start (was "Step 0")
rm -rf ~/.puppetserverwith a recoverable, timestampedmvbackup.RUBYLIB/PATHapproach double-loads and breaks when apuppet/openvoxgem is installed).Prerequisites (Step 1)
Step 3 / OpenVoxDB / conventions
puppet config set autosign true --section server.jruby-puppet.master-*→server-*;[master]→[server]; routesmaster:→server:.###; "puppet master" → "Puppet Server"; convert terminalbashfences toconsoleper CONTRIBUTING.Testing
Verified end-to-end against a from-source server: the Docker agent (autosign +
docker startre-run), the full Quick Start sequence, both server start methods (REPL(go)andlein run -c), and the installed/source host agents all apply a catalog. Passes markdownlint,jekyll build, and the internal link check.Not exercised end-to-end: the Running OpenVoxDB section (requires an OpenVoxDB source checkout) and the manual
puppetserver-ca signpath (requires the server name to resolve on the host, which the doc now notes).Closes #165