diff --git a/docs/INITIAL_SETUP.md b/docs/INITIAL_SETUP.md new file mode 100755 index 00000000..0308e6c1 --- /dev/null +++ b/docs/INITIAL_SETUP.md @@ -0,0 +1,40 @@ +# โš™ Initial Setup + +## ๐Ÿ“ Configuration Files + +- On first run, the app generates a default `app.conf` and `app.db` if unavailable. +- Preferred method: Use the **Settings UI**. +- If the UI is inaccessible, manually edit [`app.conf`](https://github.com/jokob-sk/NetAlertX/tree/main/back) in `/app/config/`. + +--- + +## ๐Ÿ–ฅ๏ธ Setting Up Scanners + +- Define networks to scan by entering accessible subnets. +- Default plugin: **ARPSCAN** โ†’ Requires at least one valid subnet + interface in `SCAN_SUBNETS`. +- ๐Ÿ“– [Subnet & VLAN setup guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/SUBNETS.md) (for troubleshooting and advanced scenarios). + +### ๐Ÿ”„ PiHole Sync +- If using **PiHole**, devices can be synced automatically. +- ๐Ÿ“– [PiHole configuration guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PIHOLE_GUIDE.md). + +### ๐Ÿ“ฆ Bulk Import +> [!NOTE] +> You can bulk-import devices via the [CSV import method](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEVICES_BULK_EDITING.md). + +--- + +## ๐ŸŒ Community Guides + +- Various community-written configuration guides in **Chinese, Korean, German, French**. +- ๐Ÿ“– [Community Guides](https://github.com/jokob-sk/NetAlertX/blob/main/docs/COMMUNITY_GUIDES.md) + +> โš ๏ธ **Note:** These guides may be outdated. Always refer to the official documentation first. + +--- + +## ๐Ÿ› ๏ธ Common Issues + +Before creating a new issue: +- Check if a similar issue was [already resolved](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed). +- Review [common debugging tips](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md). diff --git a/docs/index.md b/docs/index.md new file mode 100755 index 00000000..34651a1f --- /dev/null +++ b/docs/index.md @@ -0,0 +1,150 @@ +# ๐Ÿ“– 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. + + ![In-app help](/docs/img/GENERAL/in-app-help.png) + +
+ +--- + +## ๐Ÿ“ฅ Installation + +### ๐Ÿณ Docker (Fully Supported) +The recommended installation method is via Docker. +๐Ÿ‘‰ [Follow the official installation guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md). + +### ๐Ÿ’ป Bare-Metal / On-Server (Experimental) +- ๐Ÿงช [(Experimental) On-hardware installation](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) +- Alternative bare-metal forks: + - โœ… [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) (maintained) + - โŒ [pucherot's original code](https://github.com/pucherot/Pi.Alert/) (unmaintained) + +--- + +## ๐Ÿ“š Table of Contents + +### โš™ Initial Setup +- [Getting Started & Configuration](/docs/INITIAL_SETUP.md) +- [Synology Guide](/docs/SYNOLOGY_GUIDE.md) +- [Subnets & VLANs Configuration](/docs/SUBNETS.md) +- [Scanning Remote Networks](/docs/REMOTE_NETWORKS.md) +- [SMTP Server Configuration](/docs/SMTP.md) +- [Custom Icons Setup](/docs/ICONS.md) +- [Notifications Setup](/docs/NOTIFICATIONS.md) +- [Reverse DNS Name Resolution](/docs/REVERSE_DNS.md) +- [Network Treemap Configuration](/docs/NETWORK_TREE.md) +- [Backups & Data Retention](/docs/BACKUPS.md) +- [Plugins Overview](/front/plugins/README.md) + +### ๐Ÿ› Debugging & Troubleshooting +- [General Debugging Tips](/docs/DEBUG_TIPS.md) +- [UI Not Showing Debug](/docs/WEB_UI_PORT_DEBUG.md) +- [Invalid JSON Errors](/docs/DEBUG_INVALID_JSON.md) +- [Plugin Troubleshooting](/docs/DEBUG_PLUGINS.md) +- [File Permissions Issues](/docs/FILE_PERMISSIONS.md) +- [Performance Optimization](/docs/PERFORMANCE.md) + +### ๐Ÿ” Popular & Suggested Guides +- [Home Assistant Integration](/docs/HOME_ASSISTANT.md) +- [Bulk Device Editing](/docs/DEVICES_BULK_EDITING.md) + +### โš™ System Management +- [Device Management (Legacy Docs)](/docs/DEVICE_MANAGEMENT.md) +- [Random MAC & MAC Icon Meaning](/docs/RANDOM_MAC.md) + +### ๐Ÿ”Ž Practical Examples +- [N8N Webhook Integration](/docs/WEBHOOK_N8N.md) + +### ๐Ÿ”„ Miscellaneous +- [Version History (Legacy)](/docs/VERSIONS_HISTORY.md) +- [Reverse Proxy Setup (Nginx, Apache, SWAG)](/docs/REVERSE_PROXY.md) +- [Updating the Application](/docs/UPDATES.md) +- [Authelia Setup (Draft)](/docs/AUTHELIA.md) + +### ๐Ÿ‘ฉโ€๐Ÿ’ป For Developers +- [Developer Environment Setup](/docs/DEV_ENV_SETUP.md) +- [Server Code Structure](/server/README.md) +- [Database Schema & Details](/docs/DATABASE.md) +- [API Endpoints Overview](/docs/API.md) +- [Plugin Development Guide](/docs/PLUGINS_DEV.md) +- [Settings System Details](/docs/SETTINGS_SYSTEM.md) +- [Version Update Notifications](/docs/VERSIONS.md) +- [Frontend Development Notes](/docs/FRONTEND_DEVELOPMENT.md) +- [Webhook Secret Handling](/docs/WEBHOOK_SECRET.md) + +--- + +## ๐Ÿ‘จโ€๐Ÿ’ป Development Priorities + +**Priority Order (Highest to Lowest):** +1. ๐Ÿ”ผ Fixing core bugs that lack workarounds. +2. ๐Ÿ”ต Adding core functionality that unlocks other features (e.g., plugins). +3. ๐Ÿ”ต Refactoring to enable faster development. +4. ๐Ÿ”ฝ 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: + - ๐Ÿ“ง Email + - ๐Ÿ”” 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 `Parameters` DB table and reset on container restart. + +--- + +## ๐Ÿ› Reporting Bugs + +Before opening an issue: +- ๐Ÿ” [Check common issues](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md#common-issues). +- ๐Ÿ“Œ [Look at closed issues](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed). +- โš  **Enable debugging** before reporting: [Debug Guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md). + +โ— **Follow the issue template** for faster resolution. diff --git a/mkdocs.yml b/mkdocs.yml index 8e0104d4..defc6743 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ site_name: NetAlertX Docs site_url: https://jokob-sk.github.io/NetAlertX/ nav: - - Home: README.md + - Home: index.md - API: API.md - Authentication: - Authelia: AUTHELIA.md