-
-
Notifications
You must be signed in to change notification settings - Fork 219
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
jokob-sk
committed
Feb 8, 2025
1 parent
cd8124a
commit 0fe903e
Showing
41 changed files
with
424 additions
and
271 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| name: Setup help | ||
| description: 'When submitting an issue enable LOG_LEVEL="trace" and re-search first.' | ||
| labels: ['Setup 📥'] | ||
| body: | ||
| - type: checkboxes | ||
| attributes: | ||
| 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/ | ||
| required: true | ||
| - label: I have searched the existing open and closed issues | ||
| required: true | ||
| - label: I confirm my SCAN_SUBNETS is configured and tested as per https://github.com/jokob-sk/NetAlertX/blob/main/docs/SUBNETS.md | ||
| required: true | ||
| - type: checkboxes | ||
| attributes: | ||
| label: The issue occurs in the following browsers. Select at least 2. | ||
| description: This step helps me understand if this is a cache or browser-specific issue. | ||
| options: | ||
| - label: "Firefox" | ||
| - label: "Chrome" | ||
| - label: "Other (unsupported) - PRs welcome" | ||
| - label: "N/A - This is an issue with the backend" | ||
| - type: textarea | ||
| attributes: | ||
| label: What I want to do | ||
| description: Describe what you want to achieve. | ||
| placeholder: | | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| attributes: | ||
| label: Relevant settings you changed | ||
| description: | | ||
| Paste a screenshot or setting values of the settings you changed. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| attributes: | ||
| label: docker-compose.yml | ||
| description: | | ||
| Paste your `docker-compose.yml` | ||
| render: python | ||
| validations: | ||
| required: false | ||
| - type: dropdown | ||
| attributes: | ||
| label: What installation are you running? | ||
| options: | ||
| - Production (netalertx) | ||
| - Dev (netalertx-dev) | ||
| - Home Assistant (addon) | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: app.log | ||
| description: | | ||
| Logs with debug enabled (https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md) ⚠ | ||
| ***Generally speaking, all bug reports should have logs provided.*** | ||
| Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
| Additionally, any additional info? Screenshots? References? Anything that will give us more context about the issue you are encountering! | ||
| You can use `tail -100 /app/log/app.log` in the container if you have trouble getting to the log files. | ||
| validations: | ||
| required: false | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Debug enabled | ||
| description: I confirm I enabled `debug` | ||
| options: | ||
| - label: I have read and followed the steps in the wiki link above and provided the required debug logs and the log section covers the time when the issue occurs. | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| ### Loading... | ||
|
|
||
| Often if the application is misconfigured the `Loading...` dialog is continuously displayed. This is most likely caused by the backed failing to start. The **Maintenance -> Logs** section should give you more details on what's happenning. If there is no exception, check the Portainer log, or start the container in the foreground (without the `-d` parameter) to observe any exceptions. It's advisable to enable `trace` or `debug`. Check the [Debug tips](./DEBUG_TIPS.md) on detailed instructions. | ||
|
|
||
| ### Incorrect SCAN_SUBNETS | ||
|
|
||
| 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. | ||
|
|
||
| ### Permissions | ||
|
|
||
| Make sure you [File permissions](./FILE_PERMISSIONS.md) are set correctly. | ||
|
|
||
| * If facing issues (AJAX errors, can't write to DB, empty screen, etc,) make sure permissions are set correctly, and check the logs under `/app/log`. | ||
| * To solve permission issues you can try setting the owner and group of the `app.db` by executing the following on the host system: `docker exec netalertx chown -R www-data:www-data /app/db/app.db`. | ||
| * If still facing issues, try to map the app.db file (⚠ not folder) to `:/app/db/app.db` (see [docker-compose Examples](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md#-docker-composeyml-examples) for details) | ||
|
|
||
| ### Container restarts / crashes | ||
|
|
||
| * Check the logs for details. Often a required setting for a notification method is missing. | ||
|
|
||
| ### unable to resolve host | ||
|
|
||
| * Check that your `SCAN_SUBNETS` variable is using the correct mask and `--interface`. See the [subnets docs for details](./SUBNETS.md). | ||
|
|
||
| ### Invalid JSON | ||
|
|
||
| Check the [Invalid JSON errors debug help](./DEBUG_INVALID_JSON.md) docs on how to proceed. | ||
|
|
||
| ### sudo execution failing (e.g.: on arpscan) on a Raspberry Pi 4 | ||
|
|
||
| > sudo: unexpected child termination condition: 0 | ||
| Resolution based on [this issue](https://github.com/linuxserver/docker-papermerge/issues/4#issuecomment-1003657581) | ||
|
|
||
| ``` | ||
| wget ftp.us.debian.org/debian/pool/main/libs/libseccomp/libseccomp2_2.5.3-2_armhf.deb | ||
| sudo dpkg -i libseccomp2_2.5.3-2_armhf.deb | ||
| ``` | ||
|
|
||
| The link above will probably break in time too. Go to https://packages.debian.org/sid/armhf/libseccomp2/download to find the new version number and put that in the url. | ||
|
|
||
| ### Only Router and own device show up | ||
|
|
||
| Make sure that the subnet and interface in `SCAN_SUBNETS` are correct. If your device/NAS has multiple ethernet ports, you probably need to change `eth0` to something else. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,14 +2,13 @@ | |
|
|
||
| Please follow tips 1 - 4 to get a more detailed error. | ||
|
|
||
| ## 1. More Logging 📃 | ||
| ## 1. More Logging | ||
|
|
||
| When debugging an issue always set the highest log level: | ||
|
|
||
| `LOG_LEVEL='trace'` | ||
|
|
||
|
|
||
| ## 2. Surfacing errors when container restarts 🔁 | ||
| ## 2. Surfacing errors when container restarts | ||
|
|
||
| Start the container via the **terminal** with a command similar to this one: | ||
|
|
||
|
|
@@ -25,7 +24,7 @@ docker run --rm --network=host \ | |
|
|
||
| > ⚠ Please note, don't use the `-d` parameter so you see the error when the container crashes. Use this error in your issue description. | ||
| ## 3. Check the _dev image and open issues ❓ | ||
| ## 3. Check the _dev image and open issues | ||
|
|
||
| If possible, check if your issue got fixed in the `_dev` image before opening a new issue. The container is: | ||
|
|
||
|
|
@@ -35,7 +34,7 @@ If possible, check if your issue got fixed in the `_dev` image before opening a | |
| Please also search [open issues](https://github.com/jokob-sk/NetAlertX/issues). | ||
|
|
||
| ## 4. Disable restart behavior 🛑 | ||
| ## 4. Disable restart behavior | ||
|
|
||
| To prevent a Docker container from automatically restarting in a Docker Compose file, specify the restart policy as `no`: | ||
|
|
||
|
|
@@ -60,39 +59,6 @@ Sometimes specific log sections are needed to debug issues. The Devices and Curr | |
| 5. Open a new issue and post (redacted) output into the issue description (or send to the [email protected] email if sensitive data present). | ||
| 6. Please set `LOG_LEVEL` to `debug` or lower. | ||
|
|
||
| ## 📃Common issues | ||
|
|
||
| ### Permissions | ||
|
|
||
| * If facing issues (AJAX errors, can't write to DB, empty screen, etc,) make sure permissions are set correctly, and check the logs under `/app/log`. | ||
| * To solve permission issues you can try setting the owner and group of the `app.db` by executing the following on the host system: `docker exec netalertx chown -R www-data:www-data /app/db/app.db`. | ||
| * If still facing issues, try to map the app.db file (⚠ not folder) to `:/app/db/app.db` (see [docker-compose Examples](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md#-docker-composeyml-examples) for details) | ||
|
|
||
| ### Container restarts / crashes | ||
|
|
||
| * Check the logs for details. Often a required setting for a notification method is missing. | ||
|
|
||
| ### unable to resolve host | ||
|
|
||
| * Check that your `SCAN_SUBNETS` variable is using the correct mask and `--interface`. See teh [subnets docs for details](/docs/SUBNETS.md). | ||
|
|
||
| ### Invalid JSON | ||
|
|
||
| Check the [Invalid JSON errors debug help](/docs/DEBUG_INVALID_JSON.md) docs on how to proceed. | ||
|
|
||
| ### sudo execution failing (e.g.: on arpscan) on a Raspberry Pi 4 | ||
|
|
||
| > sudo: unexpected child termination condition: 0 | ||
| Resolution based on [this issue](https://github.com/linuxserver/docker-papermerge/issues/4#issuecomment-1003657581) | ||
|
|
||
| ``` | ||
| wget ftp.us.debian.org/debian/pool/main/libs/libseccomp/libseccomp2_2.5.3-2_armhf.deb | ||
| sudo dpkg -i libseccomp2_2.5.3-2_armhf.deb | ||
| ``` | ||
|
|
||
| The link above will probably break in time too. Go to https://packages.debian.org/sid/armhf/libseccomp2/download to find the new version number and put that in the url. | ||
|
|
||
| ### Only Router and own device show up | ||
| ## Common issues | ||
|
|
||
| Make sure that the subnet and interface in `SCAN_SUBNETS` are correct. If your device/NAS has multiple ethernet ports, you probably need to change `eth0` to something else. | ||
| See [Common issues](./COMMON_ISSUES.md) for details. | ||
Oops, something went wrong.