Support¶
| Description / name | Input element |
|---|---|
| Name of the role |
Saltbox support is provided exclusively via our Discord server.
Where to Post¶
- For officially supported Saltbox matters, create a thread in #support-saltbox.
-
For topics not directly related to Saltbox, create a thread in #support-non-saltbox.
Hardware and home networking considerations typically go here. For specific software issues, you are more likely to receive efficient help by contacting the software's support team through their official platform (Discord, forums, GitHub, etc.)
-
Please avoid posting support requests in other channels.
Sharing Information¶
Always provide detailed context and relevant logs. This can include but is not limited to:
Do not share sensitive information!
Carefully review any output for personal information (such as domain names, IPs, or credentials) and sanitize it before sharing.
-
Your hosting specifics:
- Location: on-site (home?) or off-site (Hetzner? OVH?)
- Environment: bare-metal or VM (Proxmox? Unraid?)
- Media storage: direct-attached (internal drive? USB?) or remote (Rclone? CIFS?)
-
What you have tried:
sb update,sb install ...,docker restart ..., etc. - Saltbox logs in
/srv/git/Saltbox/, Traefik logs in/opt/traefik - Output of
sb docker ps,sb docker logs,docker inspect ...,sb logs - Your Inventory content, output of
sb diag - Output of
curl http://traefik:8080/api/http/routers/sonarr@dockerwith the problem app - Output of
dig,curl,pingwith the problem FQDN - Output of
lsblk,lspci,free -h,df -h,sudo lshw,uname -a,history | tail -100
Please do not cherry-pick snippets that you believe are more relevant than others. We require the complete picture.
Note: If your text exceeds the Discord character limit, use PrivateBin or attach a text file.
Best Practices¶
- Check Announcements: Always review #announcements for recent developments. Broad issues requiring user intervention are usually covered there.
- Threads: Always create a dedicated thread for your support request to keep discussions organized.
- Beware the XY problem: Present the core problem and mention everything you tried to overcome it, but leave out the self-diagnosis.
- No Screenshots of Text: Please do not use screenshots for terminal output—copy and paste the text instead, inside a code fence if appropriate.
- Error Screens: For issues like HTTP errors (404, 500, SSL certificate...), please avoid posting a screenshot of your web browser. Instead, paste the output of a command-line HTTP client such as
curlwith the problem URL. Screenshots in general are not welcome in support requests.
Code Fences¶
When sharing a command, log, or error message, use a code fence to escape native Discord formatting.
-
Syntax: The backtick is used for code fences.
-
Single-line: For short inline content, wrap with a single backtick `:
`your inline content` -
Multi-line: For longer content, wrap with triple backticks `+`+`:
``` your multi-line content ``` -
Language: For syntax highlighting, add a language identifier by the opening triple backticks.
YAML example```yaml your: ["syntax-highlighted", "content"] ```