Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ideas for a troubleshooting page and getting help #289

Open
mholt opened this issue Jan 11, 2023 · 0 comments
Open

Ideas for a troubleshooting page and getting help #289

mholt opened this issue Jan 11, 2023 · 0 comments
Labels
discussion Let's talk about it documentation Improvements or additions to documentation

Comments

@mholt
Copy link
Member

mholt commented Jan 11, 2023

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?

@mholt mholt added documentation Improvements or additions to documentation discussion Let's talk about it labels Jan 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Let's talk about it documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant