Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Hey Francis, let me go back to the project.

I managed to stitch together our use case by reading - https://caddy.community/t/https-for-dynamic-subdomains-and-c... - https://caddy.community/t/best-practise-for-multiple-tenant-... and various GitHub issues

Our use case was: "serve SSL certificates on the fly for users hitting :443 AND users hitting *.checklyhq.com, then proxy some content."

The documentation looks visually nice, but is hard to parse as the layout of the config file (and the hierarchy of the items in it) is separate from the explanation of what they do. I was continuously doing a Ctr+F to find words on the page.

Example:

https://caddyserver.com/docs/caddyfile/options

Here the stanzas are clickable.

https://caddyserver.com/docs/caddyfile/directives/tls

Here not.

Last thing. The docs present a lot of config examples in snippets, but seeing how to use them in a full, syntactically correct file was hard. I felt I was missing the big picture.

Sorry to not be more concrete, it was some time ago.



I think if you had found your way to this article in the wiki https://caddy.community/t/serving-tens-of-thousands-of-domai... you would have had an easier time. The On-Demand TLS section in the docs now links to there (as of only a week or two ago) https://caddyserver.com/docs/automatic-https#on-demand-tls

Regarding clickable bits in the docs, those are set up with some JS I wrote which tries to dynamically add links to certain things. I only set it up for Caddyfile directives and for the global options page in particular. Our docs are in markdown so any linking of things needs to be wired up after the fact on page load with some vanilla JS. I'll look into improving that for some more pages.

Thanks for the feedback!


Francis has implemented your suggestions




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: