Getting Help
Community Resources
- GitHub Issues: Report bugs, request features
- GitHub Discussions: Ask questions, share setups
- Issue Templates: Use the appropriate template (bug report, feature request, question, security, documentation, config help)
Before Opening an Issue
- Check the FAQ: Your question may already be answered in the FAQ
- Check existing issues: Someone may have already reported the same problem
- Check the audit logs: Many issues leave a clear trace in the audit log
- Check container logs:
docker compose logs <service>often has the answer - Run the health check:
bash scripts/health-check.sh
Information to Include
When reporting a bug, include:
# System information
docker --version
docker compose version
uname -a
# Container status
docker compose ps
# Relevant logs (sanitized — remove credentials)
docker compose logs <failing-service> --tail 50
# Config (sanitized)
cat configs/<server>.yaml
# Steps to reproduce
# 1. What you did
# 2. What you expected
# 3. What actually happened
Security Issues
If you discover a security vulnerability, please do not open a public issue. Use the security issue template or contact the maintainer directly.