diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 792f50cb..8ee485c3 100755 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -5,7 +5,7 @@ body: - type: checkboxes attributes: label: Is there an existing issue for this? - description: Please search to see if an open or closed issue already exists for the feature you are requesting. + description: Please search to see if an open or closed issue already exists for the feature you are requesting. options: - label: I have searched the existing open and closed issues required: true @@ -32,21 +32,21 @@ body: label: Anything else? description: | Links? References? Mockups? Anything that will give us more context about the feature you are encountering! - + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. validations: required: true - type: checkboxes attributes: label: Am I willing to test this? 🧪 - description: I rely on the community to test unreleased features. If you are requesting a feature, please be willing to test it within 48h of test request. Otherwise, the feature might be pulled from the code base. + description: I rely on the community to test unreleased features. If you are requesting a feature, please be willing to test it within 48h of test request. Otherwise, the feature might be pulled from the code base. options: - label: I will do my best to test this feature on the `netlertx-dev` image when requested within 48h and report bugs to help deliver a great user experience for everyone and not to break existing installations. required: true - type: checkboxes attributes: - label: Can I help implement this? 👩💻👨💻 - description: The maintainer will provide guidance and help. The implementer will read the PR guidelines https://jokob-sk.github.io/NetAlertX/DEV_ENV_SETUP/ + label: Can I help implement this? 👩💻👨💻 + description: The maintainer will provide guidance and help. The implementer will read the PR guidelines https://docs.netalertx.com/DEV_ENV_SETUP/ options: - label: "Yes" - label: "No" diff --git a/.github/ISSUE_TEMPLATE/i-have-an-issue.yml b/.github/ISSUE_TEMPLATE/i-have-an-issue.yml index 62eb3821..5ff609c8 100755 --- a/.github/ISSUE_TEMPLATE/i-have-an-issue.yml +++ b/.github/ISSUE_TEMPLATE/i-have-an-issue.yml @@ -21,7 +21,7 @@ body: label: Is there an existing issue for this? description: Please search to see if an open or closed issue already exists for the bug you encountered. options: - - label: I have searched the existing open and closed issues and I checked the docs https://jokob-sk.github.io/NetAlertX/ + - label: I have searched the existing open and closed issues and I checked the docs https://docs.netalertx.com/ required: true - type: checkboxes attributes: diff --git a/.github/ISSUE_TEMPLATE/setup-help.yml b/.github/ISSUE_TEMPLATE/setup-help.yml index d1b54e20..ba96981c 100755 --- a/.github/ISSUE_TEMPLATE/setup-help.yml +++ b/.github/ISSUE_TEMPLATE/setup-help.yml @@ -21,7 +21,7 @@ body: label: Did I research? description: Please confirm you checked the usual places before opening a setup support request. options: - - label: I have searched the docs https://jokob-sk.github.io/NetAlertX/ + - label: I have searched the docs https://docs.netalertx.com/ required: true - label: I have searched the existing open and closed issues required: true diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 78488237..04a75ad6 100755 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -80,7 +80,6 @@ Backend loop phases (see `server/__main__.py` and `server/plugin.py`): `once`, ` - Logs: All logs are under `/tmp/log/`. Plugin logs are very shortly under `/tmp/log/plugins/` until picked up by the server. - plugin logs: `/tmp/log/plugins/*.log` - backend logs: `/tmp/log/stdout.log` and `/tmp/log/stderr.log` - - frontend commands logs: `/tmp/log/app_front.log` - php errors: `/tmp/log/app.php_errors.log` - nginx logs: `/tmp/log/nginx-access.log` and `/tmp/log/nginx-error.log` diff --git a/README.md b/README.md index e8798548..54c0e8dc 100755 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Get visibility of what's going on on your WIFI/LAN network and enable presence d ## 🚀 Quick Start > [!WARNING] -> ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://jokob-sk.github.io/NetAlertX/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions. +> ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://docs.netalertx.com/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions. Start NetAlertX in seconds with Docker: @@ -60,14 +60,14 @@ docker compose up --force-recreate --build # To customize: edit docker-compose.yaml and run that last command again ``` -Need help configuring it? Check the [usage guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/README.md) or [full documentation](https://jokob-sk.github.io/NetAlertX/). +Need help configuring it? Check the [usage guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/README.md) or [full documentation](https://docs.netalertx.com/). For Home Assistant users: [Click here to add NetAlertX](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons) For other install methods, check the [installation docs](#-documentation) -| [📑 Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_INSTALLATION.md) | [🚀 Releases](https://github.com/jokob-sk/NetAlertX/releases) | [📚 Docs](https://jokob-sk.github.io/NetAlertX/) | [🔌 Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md) | [🤖 Ask AI](https://gurubase.io/g/netalertx) +| [📑 Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_INSTALLATION.md) | [🚀 Releases](https://github.com/jokob-sk/NetAlertX/releases) | [📚 Docs](https://docs.netalertx.com/) | [🔌 Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md) | [🤖 Ask AI](https://gurubase.io/g/netalertx) |----------------------| ----------------------| ----------------------| ----------------------| ----------------------| ![showcase][showcase] @@ -117,7 +117,7 @@ Supported browsers: Chrome, Firefox - [[Development] API docs](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md) - [[Development] Custom Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS_DEV.md) -...or explore all the [documentation here](https://jokob-sk.github.io/NetAlertX/). +...or explore all the [documentation here](https://docs.netalertx.com/). ## 🔐 Security & Privacy @@ -156,7 +156,7 @@ A: In the `/data/config` and `/data/db` folders. Back up these folders regularly - Notification throttling may be needed for large networks to prevent spam. - On some systems, elevated permissions (like `CAP_NET_RAW`) may be needed for low-level scanning. -Check the [GitHub Issues](https://github.com/jokob-sk/NetAlertX/issues) for the latest bug reports and solutions and consult [the official documentation](https://jokob-sk.github.io/NetAlertX/). +Check the [GitHub Issues](https://github.com/jokob-sk/NetAlertX/issues) for the latest bug reports and solutions and consult [the official documentation](https://docs.netalertx.com/). ## 📃 Everything else diff --git a/docs/API_LOGS.md b/docs/API_LOGS.md index 8907069d..81f85503 100644 --- a/docs/API_LOGS.md +++ b/docs/API_LOGS.md @@ -18,7 +18,6 @@ Only specific, pre-approved log files can be purged for security and stability r ``` app.log -app_front.log IP_changes.log stdout.log stderr.log diff --git a/docs/DOCKER_COMPOSE.md b/docs/DOCKER_COMPOSE.md index 0d0277fe..396bc912 100755 --- a/docs/DOCKER_COMPOSE.md +++ b/docs/DOCKER_COMPOSE.md @@ -1,7 +1,7 @@ # NetAlertX and Docker Compose > [!WARNING] -> ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://jokob-sk.github.io/NetAlertX/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions. +> ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://docs.netalertx.com/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions. Great care is taken to ensure NetAlertX meets the needs of everyone while being flexible enough for anyone. This document outlines how you can configure your docker-compose. There are many settings, so we recommend using the Baseline Docker Compose as-is, or modifying it for your system.Good care is taken to ensure NetAlertX meets the needs of everyone while being flexible enough for anyone. This document outlines how you can configure your docker-compose. There are many settings, so we recommend using the Baseline Docker Compose as-is, or modifying it for your system. diff --git a/docs/DOCKER_INSTALLATION.md b/docs/DOCKER_INSTALLATION.md index 4d9e5d61..79eb0000 100644 --- a/docs/DOCKER_INSTALLATION.md +++ b/docs/DOCKER_INSTALLATION.md @@ -6,7 +6,7 @@ # NetAlertX - Network scanner & notification framework -| [📑 Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_INSTALLATION.md) | [🚀 Releases](https://github.com/jokob-sk/NetAlertX/releases) | [📚 Docs](https://jokob-sk.github.io/NetAlertX/) | [🔌 Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md) | [🤖 Ask AI](https://gurubase.io/g/netalertx) +| [📑 Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_INSTALLATION.md) | [🚀 Releases](https://github.com/jokob-sk/NetAlertX/releases) | [📚 Docs](https://docs.netalertx.com/) | [🔌 Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md) | [🤖 Ask AI](https://gurubase.io/g/netalertx) |----------------------| ----------------------| ----------------------| ----------------------| ----------------------| diff --git a/docs/DOCKER_MAINTENANCE.md b/docs/DOCKER_MAINTENANCE.md index 89e35afd..e38b3af6 100644 --- a/docs/DOCKER_MAINTENANCE.md +++ b/docs/DOCKER_MAINTENANCE.md @@ -1,7 +1,7 @@ # The NetAlertX Container Operator's Guide > [!WARNING] -> ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://jokob-sk.github.io/NetAlertX/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions. +> ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://docs.netalertx.com/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions. This guide assumes you are starting with the official `docker-compose.yml` file provided with the project. We strongly recommend you start with or migrate to this file as your baseline and modify it to suit your specific needs (e.g., changing file paths). While there are many ways to configure NetAlertX, the default file is designed to meet the mandatory security baseline with layer-2 networking capabilities while operating securely and without startup warnings. diff --git a/docs/FILE_PERMISSIONS.md b/docs/FILE_PERMISSIONS.md index 8b1a79cd..b6a25896 100755 --- a/docs/FILE_PERMISSIONS.md +++ b/docs/FILE_PERMISSIONS.md @@ -38,6 +38,8 @@ NetAlertX requires certain paths to be writable at runtime. These paths should b > All these paths will have **UID 20211 / GID 20211** inside the container. Files on the host will appear owned by `20211:20211`. +## Eunning as `root` + You can change the default PUID and GUID with env variables: ```yaml diff --git a/docs/MIGRATION.md b/docs/MIGRATION.md index 24aaad04..9e39e5ba 100755 --- a/docs/MIGRATION.md +++ b/docs/MIGRATION.md @@ -297,5 +297,5 @@ sudo chmod -R a+rwx /local_data_dir ``` 8. Start the container and verify everything works as expeexpected. -9. Check the [Permissions -> Writable-paths](https://jokob-sk.github.io/NetAlertX/FILE_PERMISSIONS/#writable-paths) what directories to mount if you'd like to access the API or log files. - +9. Check the [Permissions -> Writable-paths](https://docs.netalertx.com/FILE_PERMISSIONS/#writable-paths) what directories to mount if you'd like to access the API or log files. + diff --git a/front/php/templates/footer.php b/front/php/templates/footer.php index 45e95689..763859da 100755 --- a/front/php/templates/footer.php +++ b/front/php/templates/footer.php @@ -12,7 +12,7 @@ #---------------------------------------------------------------------------------# --> - NetAlertx - - + +