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 topics, 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. Specific software issues are more likely to be addressed through their official support channels and outside Saltbox.
Please avoid posting support requests in other channels.

Do not share sensitive information!

Carefully review any output for personal information (domain names, public IP addresses, credentials...) and sanitize it before sharing.

Always provide detailed context and relevant logs. This can include but is not limited to:

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@docker with the problem app
Output of dig, curl, ping with 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. New incidents requiring user intervention are usually covered there.

Follow the rules¶

Please make sure you're well acquainted with the channel rules and formulate your request accordingly.

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 curl with 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.

The backtick, also known as the grave accent or backquote, is used for code fences.
For short inline content, wrap with a single backtick `: `your inline content`
For longer content, wrap with triple backticks `+`+`:
```
```
your
multi-line
content
```
```
For syntax highlighting, add a language identifier by the opening triple backticks.
YAML example
```
```yaml
your: ["syntax-highlighted", "content"]
```
```