caddyserver / caddyserver/website
Missing document on prefer_wildcard for auto_https
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 227
- Forks
- 213
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 1
Description
Currently auto_https prefer_wildcard option is not documented on the site https://caddyserver.com/docs/caddyfile/options#auto-https
it seems like the PR for it has been merged https://github.com/caddyserver/caddy/pull/6146
it would be helpful to document it, took me a long trail of searching through closed issue to discover this
If using the Caddyfile, Caddy takes site names literally with regards to the certificate subject names.
If you need different behavior, the JSON config gives you more precise control over certificate subjects and site names ("host matchers").
section about wildcard certificates should also be amended to reference the new feature
https://caddyserver.com/docs/automatic-https#wildcard-certificates
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the auto_https options page and the wildcard certificates section linked in the issue, and review PR 6146 for the behavior being documented. Document the prefer_wildcard option and add a reference to it in the wildcard-certificate guidance; the two linked sections should explain the feature clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100