docs: add Configuration examples section to README - #14
Closed
ryans-posthog wants to merge 1 commit into
Closed
Conversation
Adds runnable Caddyfile, JSON, and admin API examples inline so a first-time reader has something to try without leaving the repo. The existing Quick start section only linked out to caddyserver.com. Generated-By: PostHog Code Task-Id: d48ed982-ccfa-47c4-8293-5558f0793dec
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
## Configuration examplessection toREADME.mdbetween Quick start and Overview.curl.The existing Quick start section only linked out to caddyserver.com — a reader cloning the repo had no runnable example inline. This PR fills that gap without duplicating the upstream reference docs.
Test plan
caddyfile,bash, andjsonhighlightingcaddybinary:caddy file-server --listen :2015caddy reverse-proxy --from :8080 --to :9000caddy runagainst each Caddyfile examplecurl localhost:2019/config/against a running instance