caddyserver / caddyserver/website

Ideas for a troubleshooting page and getting help

Open
#289 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

discussion documentation
Dominant language
HTML
Stars
227
Forks
213
Avg merge
3h 52m
Merged PRs (30d)
1

Description

Maybe this would be better suited for the wiki since it'll primarily be used by people asking for help on the forums, and the wiki is on the forums; but whether this goes in the wiki or in the docs, we could probably benefit from a page that helps people learn troubleshooting skills.

(At this point, the vast majority of questions about Caddy aren't bugs in Caddy -- well over 75%.)

Top Troubleshooting Tips (?)

Some topic ideas:

  • Ensure your DNS records are properly pointed at your server
  • Ensure your local DNS setup is not interrupting (split horizon; Caddy relies on seeing the same DNS as the rest of the world for the zones it serves)
  • Ensure ports 80 and 443 are open to the outside (specifically, check port forwarding and firewalls)
  • Ensure your user/group and file permissions are correct
  • Ensure SELinux is disabled or configured to allow Caddy
  • Ensure no other servers (apache, nginx, Node, other embedded servers) are running on same ports
  • And probably some guidance on how to identify and fix the problem the fastest (start with minimal config, add one piece at a time, etc.)

@francislavoie was suggesting that we can roll most of the content in our current Help template in the forum into this page, and potentially shorten the Help template significantly.

Any thoughts on the topics for this page?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked forum wiki discussion and the current Help template mentioned in the issue. Define the page scope, troubleshooting topics, and relationship to the forum template; done means the documentation location and content are agreed and the resulting page is ready for users seeking help.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.