caddyserver / caddyserver/website
ENV concepts section should raise awareness of `file` placeholder for secrets
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 227
- Forks
- 213
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 1
Description
Short of using search for the keyword secret this might not be as easily discovered? Caddy could better raise awareness of the feature for a common use-case where secrets often leak.
Since it's a common practice to pass secrets to services via ENV (which isn't ideal given various scenarios that can leak, undocumented advice from @francislavoie would be good to add too for added context with the env placeholder, similar for why one may prefer using a file placeholder to more securely acquire secrets.
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 website's ENV concepts section and review the linked Caddy discussions for the intended guidance. Update the section to explain the env and file placeholders, why secrets passed through environment variables can leak, and when file is preferable; the documentation should make this use case discoverable without searching for “secret”.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100