diff --git a/docs/DEV_ENV_SETUP.md b/docs/DEV_ENV_SETUP.md index abbd9c55..ee84a232 100755 --- a/docs/DEV_ENV_SETUP.md +++ b/docs/DEV_ENV_SETUP.md @@ -3,6 +3,24 @@ >[!NOTE] > Replace `/development` with the path where your code files will be stored. The default container name is `netalertx` so there might be a conflict with your running containers. +### Development Guidelines + +**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**. + ## 1. Download the code: - `mkdir /development` @@ -67,4 +85,24 @@ Most code changes can be tetsed without rebuilding the container. When working o 3. If none of the above work, restart the docker image. This is usually the last resort as sometimes the Docker engine becomes unresponsive and the whole engine needs to be restarted. +## โž• 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. +- Updating a Device +- Plugin functionality. +- Error log inspection. diff --git a/docs/index.md b/docs/index.md index 34651a1f..b3d1843d 100755 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,16 @@ -# ๐Ÿ“– Documentation Overview +# NetAlertX documentation ## โ„น๏ธ 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. - - 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) +## ๐Ÿ“š Table of Contents -
+{% include "_toc.md" %} --- @@ -21,126 +20,17 @@ 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) +### ๐Ÿ’ป Bare-Metal / On-Server (Experimental - looking ofr maintainers) - ๐Ÿงช [(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 +## Help and Support Before opening an issue: - ๐Ÿ” [Check common issues](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md#common-issues). diff --git a/front/php/templates/language/fr_fr.json b/front/php/templates/language/fr_fr.json old mode 100644 new mode 100755 diff --git a/front/php/templates/language/it_it.json b/front/php/templates/language/it_it.json old mode 100644 new mode 100755 diff --git a/front/php/templates/language/pl_pl.json b/front/php/templates/language/pl_pl.json old mode 100644 new mode 100755 diff --git a/front/php/templates/language/pt_br.json b/front/php/templates/language/pt_br.json old mode 100644 new mode 100755 diff --git a/front/php/templates/language/uk_ua.json b/front/php/templates/language/uk_ua.json old mode 100644 new mode 100755 diff --git a/mkdocs.yml b/mkdocs.yml index defc6743..96a4974b 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,58 +2,47 @@ site_name: NetAlertX Docs site_url: https://jokob-sk.github.io/NetAlertX/ nav: - Home: index.md - - API: API.md - - Authentication: + - Installation: + - Installation: HW_INSTALL.md + - Migration Guide: MIGRATION.md + - Docker Compose: DOCKER_COMPOSE.md + - Docker File Permissions: FILE_PERMISSIONS.md + - Synology Guide: SYNOLOGY_GUIDE.md + - Community Guides: COMMUNITY_GUIDES.md + - Setup: + - Subnets: SUBNETS.md + - Remote Networks: REMOTE_NETWORKS.md + - Notifications Guide: NOTIFICATIONS.md + - Emails: SMTP.md - Authelia: AUTHELIA.md - - Backups: BACKUPS.md - - Community Guides: COMMUNITY_GUIDES.md - - Customization: - - Custom Properties: CUSTOM_PROPERTIES.md - - Device Display Settings: DEVICE_DISPLAY_SETTINGS.md - - Database: - - Overview: DATABASE.md + - Backups: BACKUPS.md - Performance: PERFORMANCE.md - - Debugging: - - Debugging Invalid JSON: DEBUG_INVALID_JSON.md - - Debugging Plugins: DEBUG_PLUGINS.md - - Debugging Tips: DEBUG_TIPS.md - - Development: - - Setup: DEV_ENV_SETUP.md - - Frontend Development: FRONTEND_DEVELOPMENT.md - - Devices: + - Home Assistant: HOME_ASSISTANT.md + - Reverse DNS: REVERSE_DNS.md + - Pi-hole Guide: PIHOLE_GUIDE.md + - Reverse Proxy: REVERSE_PROXY.md + - Webhooks (n8n): WEBHOOK_N8N.md + - Device guides: - Management: DEVICE_MANAGEMENT.md - Bulk Editing: DEVICES_BULK_EDITING.md - Random MAC: RANDOM_MAC.md - - Docker: - - Docker Compose: DOCKER_COMPOSE.md - - File Permissions: FILE_PERMISSIONS.md - - Home Assistant: HOME_ASSISTANT.md - - Hardware: - - Installation: HW_INSTALL.md - - Icons: ICONS.md - - Migration Guide: MIGRATION.md - - Network: - - Tree: NETWORK_TREE.md - - Remote Networks: REMOTE_NETWORKS.md - - Subnets: SUBNETS.md - - Reverse DNS: REVERSE_DNS.md - - Notifications: - - Overview: NOTIFICATIONS.md - - SMTP: SMTP.md - - Performance: PERFORMANCE.md - - Pi-hole Guide: PIHOLE_GUIDE.md - - Plugins: + - Custom Properties: CUSTOM_PROPERTIES.md + - Device Display Settings: DEVICE_DISPLAY_SETTINGS.md + - Session Info: SESSION_INFO.md + - Icons: ICONS.md + - Network Topology: NETWORK_TREE.md + - Troubleshooting: + - Debugging Tips: DEBUG_TIPS.md + - Debugging Invalid JSON: DEBUG_INVALID_JSON.md + - Debugging Plugins: DEBUG_PLUGINS.md + - Debugging Web UI Port: WEB_UI_PORT_DEBUG.md + - Development: + - Environment Setup: DEV_ENV_SETUP.md + - Frontend Development: FRONTEND_DEVELOPMENT.md - Development: PLUGINS_DEV.md - - Webhook (n8n): WEBHOOK_N8N.md - Webhook Secret: WEBHOOK_SECRET.md - - Proxy & Reverse DNS: - - Reverse Proxy: REVERSE_PROXY.md - - Session Info: SESSION_INFO.md - - Settings: - - System Settings: SETTINGS_SYSTEM.md - - Synology Guide: SYNOLOGY_GUIDE.md - - Updates & Versions: + - API: API.md + - Database: DATABASE.md + - Settings: SETTINGS_SYSTEM.md - Updates: UPDATES.md - - Versions: VERSIONS.md - - Web UI: - - Debugging Web UI Port: WEB_UI_PORT_DEBUG.md \ No newline at end of file + - Versions: VERSIONS.md \ No newline at end of file