vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 09:36:05 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

MKDocs

Browse Source
This commit is contained in:
jokob-sk
2025-02-09 12:26:57 +11:00
parent c6adaf99f4
commit b6c6579cb5
3 changed files with 67 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/COMMON_ISSUES.md
View File

@@ -6,6 +6,10 @@ Often if the application is misconfigured the `Loading...` dialog is continuousl
One of the most common issues is not configuring `SCAN_SUBNETS` correctly. If this setting is misconfigured you will only see one or two devices in your devices list after a scan. Please read the [subnets docs](./SUBNETS.md) carefully to resolve this. One of the most common issues is not configuring `SCAN_SUBNETS` correctly. If this setting is misconfigured you will only see one or two devices in your devices list after a scan. Please read the [subnets docs](./SUBNETS.md) carefully to resolve this.
### Duplicate devices and notifications
The app uses the MAC address as an unique identifier for devices. If a new MAC is detected a new device is added to the application and corresponding notifications are triggered. This means that if the MAC of an existing device changes, the device will be logged as a new device. You can usually prevent this from happenning by changing the device configuration (in Android, iOS, or Windows) for your network. See the [Random Macs](./RANDOM_MAC.md) guide for details.
### Permissions ### Permissions
Make sure you [File permissions](./FILE_PERMISSIONS.md) are set correctly. Make sure you [File permissions](./FILE_PERMISSIONS.md) are set correctly.

2
docs/DEBUG_PLUGINS.md
View File

@@ -9,7 +9,7 @@ For a more in-depth overview on how plugins work check the [Plugins development
### Prerequisites ### Prerequisites
- Make sure you read and followed the specific plugin setup instructions. - Make sure you read and followed the specific plugin setup instructions.
- Ensure you have [debug enabled (see More Logging)](./DEBUG_TIPS.md#1-more-logging-) - Ensure you have [debug enabled (see More Logging)](./DEBUG_TIPS.md)
### Potential issues ### Potential issues

101
mkdocs.yml
View File

@@ -3,6 +3,8 @@ site_url: https://jokob-sk.github.io/NetAlertX/
repo_url: https://github.com/jokob-sk/NetAlertX/ repo_url: https://github.com/jokob-sk/NetAlertX/
edit_uri: blob/main/docs/ edit_uri: blob/main/docs/
docs_dir: docs docs_dir: docs
site_description: >-
The main documentation resource for NetAlertX - a network scanner and presence detector
# static_dir: docs/img # static_dir: docs/img
nav: nav:
- Home: index.md - Home: index.md
@@ -10,61 +12,82 @@ nav:
- Installation: - Installation:
- Installation options: INSTALLATION.md - Installation options: INSTALLATION.md
- Quick setup: INITIAL_SETUP.md - Quick setup: INITIAL_SETUP.md
- Docker Guide: https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md - Docker:
- Docker Compose: DOCKER_COMPOSE.md - Docker Guide: https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md
- Docker File Permissions: FILE_PERMISSIONS.md - Docker Compose: DOCKER_COMPOSE.md
- Synology Guide: SYNOLOGY_GUIDE.md - Docker File Permissions: FILE_PERMISSIONS.md
- Community Guides: COMMUNITY_GUIDES.md - Docker Updates: UPDATES.md
- Bare-metal (Experimental): HW_INSTALL.md - Other:
- Migration Guide: MIGRATION.md - Synology Guide: SYNOLOGY_GUIDE.md
- Common issues: COMMON_ISSUES.md - Community Guides: COMMUNITY_GUIDES.md
- Docker Updates: UPDATES.md - Bare-metal (Experimental): HW_INSTALL.md
- Migration Guide: MIGRATION.md
- Help:
- Common issues: COMMON_ISSUES.md
- Setup: - Setup:
- Subnets: SUBNETS.md - Getting started:
- Enable Plugins: https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md - Subnets: SUBNETS.md
- Common issues: COMMON_ISSUES.md - Enable Plugins: https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md
- Remote Networks: REMOTE_NETWORKS.md - Pi-hole Guide: PIHOLE_GUIDE.md
- Notifications Guide: NOTIFICATIONS.md - Home Assistant: HOME_ASSISTANT.md
- Emails: SMTP.md - Emails: SMTP.md
- Authelia: AUTHELIA.md - Backups: BACKUPS.md
- Backups: BACKUPS.md - Advanced guides:
- Performance: PERFORMANCE.md - Remote Networks: REMOTE_NETWORKS.md
- Home Assistant: HOME_ASSISTANT.md - Notifications Guide: NOTIFICATIONS.md
- Reverse DNS: REVERSE_DNS.md - Authelia: AUTHELIA.md
- Pi-hole Guide: PIHOLE_GUIDE.md - Performance: PERFORMANCE.md
- Reverse Proxy: REVERSE_PROXY.md - Reverse DNS: REVERSE_DNS.md
- Webhooks (n8n): WEBHOOK_N8N.md - Reverse Proxy: REVERSE_PROXY.md
- Webhooks (n8n): WEBHOOK_N8N.md
- Help:
- Common issues: COMMON_ISSUES.md
- Random MAC: RANDOM_MAC.md
- Device guides: - Device guides:
- Management: DEVICE_MANAGEMENT.md - Editing Devices:
- Bulk Editing: DEVICES_BULK_EDITING.md - Management: DEVICE_MANAGEMENT.md
- Random MAC: RANDOM_MAC.md - Bulk Editing: DEVICES_BULK_EDITING.md
- Custom Properties: CUSTOM_PROPERTIES.md - Custom Properties: CUSTOM_PROPERTIES.md
- Device Display Settings: DEVICE_DISPLAY_SETTINGS.md - Device Display Settings: DEVICE_DISPLAY_SETTINGS.md
- Session Info: SESSION_INFO.md - Session Info: SESSION_INFO.md
- Icons: ICONS.md - Icons and Topology:
- Network Topology: NETWORK_TREE.md - Icons: ICONS.md
- Network Topology: NETWORK_TREE.md
- Troubleshooting: - Troubleshooting:
- Debugging Tips: DEBUG_TIPS.md - Debugging Tips: DEBUG_TIPS.md
- Debugging Invalid JSON: DEBUG_INVALID_JSON.md - Debugging Invalid JSON: DEBUG_INVALID_JSON.md
- Debugging Plugins: DEBUG_PLUGINS.md - Debugging Plugins: DEBUG_PLUGINS.md
- Debugging Web UI Port: WEB_UI_PORT_DEBUG.md - Debugging Web UI Port: WEB_UI_PORT_DEBUG.md
- Development: - Development:
- Environment Setup: DEV_ENV_SETUP.md - Plugin and app development:
- Custom Plugins: PLUGINS_DEV.md - Environment Setup: DEV_ENV_SETUP.md
- Frontend Development: FRONTEND_DEVELOPMENT.md - Custom Plugins: PLUGINS_DEV.md
- Webhook Secret: WEBHOOK_SECRET.md - Frontend Development: FRONTEND_DEVELOPMENT.md
- API: API.md - Database: DATABASE.md
- Database: DATABASE.md - Settings: SETTINGS_SYSTEM.md
- Settings: SETTINGS_SYSTEM.md - Versions: VERSIONS.md
- Versions: VERSIONS.md - Integrations:
- Webhook Secret: WEBHOOK_SECRET.md
- API: API.md
theme: theme:
name: material name: material
logo: img/NetAlertX_logo.png # Reference the favicon here logo: img/NetAlertX_logo.png # Reference the favicon here
favicon: img/NetAlertX_logo.png favicon: img/NetAlertX_logo.png
metadata:
description: "NetAlertX Documentation - The go-to resource for all things related to NetAlertX."
image: "https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/front/img/NetAlertX_logo.png"
extra: extra:
home_hide_sidebar: true home_hide_sidebar: true
social:
- icon: fontawesome/brands/github
link: https://github.com/jokob-sk
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/jokobsk/netalertx/
- icon: fontawesome/brands/x-twitter
link: https://x.com/NetAlertX
features: features:
- announce.dismiss - announce.dismiss
- content.action.edit - content.action.edit