Home

ShellyAdmin Wiki

This wiki is the home for operator-side knowledge that grows with experience and isn't tied to a specific code release:

• FAQ — frequently asked questions about deployment, behaviour, and design choices.
• Troubleshooting — symptom-to-fix cookbook for the most common pitfalls.
• Recipes — provisioning template snippets, compliance rule examples, integration patterns.

What lives outside the wiki

The canonical project documentation is in the repo itself and stays code-synchronous via CI:

Topic	Where
Quick start, screenshots, project pitch	README.md (English) / README.de.md (Deutsch)
Architecture, design rationale	docs/ARCHITECTURE.md and the 17 ADRs under docs/adr/
Production deployment, hardening	docs/DEPLOYMENT.md
Local development, tests, release process	docs/DEVELOPMENT.md
Threat model, vulnerability reporting	SECURITY.md and docs/SECURITY.md
Per-release changes	CHANGELOG.md

If you're filing a bug or feature request, use the issue templates — they catch the most common triage gaps. Security vulnerabilities go through private advisories, never via wiki edits or public issues.

Contributing to the wiki

Wiki edits are welcome — especially for FAQ entries that come from real questions and troubleshooting symptoms you've actually hit. Two rules:

1. Don't duplicate content from docs/. Link to it instead. Two sources of truth drift.
2. No security-sensitive content (tokens, internal hostnames, real credentials, screenshots that leak identifying info).