5.3 KiB
Executable File
📖 Documentation Overview
ℹ️ In-App Help
🔍 How to access in-app help
- Hover over settings, fields, or labels.
- Click the blue ❔ (question-mark) icons.
- Access the in-app Help / FAQ section for frequently asked questions.
📥 Installation
🐳 Docker (Fully Supported)
The recommended installation method is via Docker.
👉 Follow the official installation guide.
💻 Bare-Metal / On-Server (Experimental)
- 🧪 (Experimental) On-hardware installation
- Alternative bare-metal forks:
- ✅ leiweibau's fork (maintained)
- ❌ pucherot's original code (unmaintained)
📚 Table of Contents
⚙ Initial Setup
- Getting Started & Configuration
- Synology Guide
- Subnets & VLANs Configuration
- Scanning Remote Networks
- SMTP Server Configuration
- Custom Icons Setup
- Notifications Setup
- Reverse DNS Name Resolution
- Network Treemap Configuration
- Backups & Data Retention
- Plugins Overview
🐛 Debugging & Troubleshooting
- General Debugging Tips
- UI Not Showing Debug
- Invalid JSON Errors
- Plugin Troubleshooting
- File Permissions Issues
- Performance Optimization
🔝 Popular & Suggested Guides
⚙ System Management
🔎 Practical Examples
🔄 Miscellaneous
- Version History (Legacy)
- Reverse Proxy Setup (Nginx, Apache, SWAG)
- Updating the Application
- Authelia Setup (Draft)
👩💻 For Developers
- Developer Environment Setup
- Server Code Structure
- Database Schema & Details
- API Endpoints Overview
- Plugin Development Guide
- Settings System Details
- Version Update Notifications
- Frontend Development Notes
- Webhook Secret Handling
👨💻 Development Priorities
Priority Order (Highest to Lowest):
- 🔼 Fixing core bugs that lack workarounds.
- 🔵 Adding core functionality that unlocks other features (e.g., plugins).
- 🔵 Refactoring to enable faster development.
- 🔽 UI improvements (PRs welcome).
💡 Design Philosophy:
Focus on core functionality and integrate with existing tools rather than reinventing the wheel.
Examples:
- Using Apprise for notifications instead of implementing multiple separate gateways.
- Implementing regex-based validation instead of one-off validation for each setting.
📌 Note on UI requests:
UI changes have lower priority due to framework limitations and mobile support constraints.
PRs are welcome, but keep them small & focused.
🙏 Feature Requests
Please include:
- The goal (e.g., "I want to do X so that Y...").
- Workarounds you've tried.
- Why a built-in feature is the better solution.
Example format:
I want to be able to do XYZ so that ZYX. I considered these approaches XYZ, but they have these limitations...
➕ Contributing & Pull Requests
Before submitting a PR, please ensure:
✔ Changes are backward-compatible with existing installs.
✔ No unnecessary changes are made.
✔ New features are reusable, not narrowly scoped.
✔ Features are implemented via plugins if possible.
✅ Suggested Test Cases
- Fresh install (no DB/config).
- Existing DB/config compatibility.
- Notification testing:
- 🔔 Apprise (e.g., Telegram)
- 🌐 Webhook (e.g., Discord)
- 📡 MQTT (e.g., Home Assistant)
- Settings persistence.
- Plugin functionality.
- Error log inspection.
🔎 Important Notes:
- Persistent settings are stored in
app.conf. - Session-based settings are stored in the
ParametersDB table and reset on container restart.
🐛 Reporting Bugs
Before opening an issue:
- 🔍 Check common issues.
- 📌 Look at closed issues.
- ⚠ Enable debugging before reporting: Debug Guide.
❗ Follow the issue template for faster resolution.