docs + auto lables on GH issues
Some checks failed
Code checks / check-url-paths (push) Has been cancelled
docker / docker_dev (push) Has been cancelled
Deploy MkDocs / deploy (push) Has been cancelled

This commit is contained in:
jokob-sk
2025-04-06 10:48:27 +10:00
parent 426dd48540
commit e6962e0393
6 changed files with 78 additions and 9 deletions

View File

@@ -59,6 +59,7 @@ body:
validations: validations:
required: false required: false
- type: dropdown - type: dropdown
id: installation_type
attributes: attributes:
label: What installation are you running? label: What installation are you running?
options: options:

View File

@@ -44,6 +44,7 @@ body:
validations: validations:
required: false required: false
- type: dropdown - type: dropdown
id: installation_type
attributes: attributes:
label: What installation are you running? label: What installation are you running?
options: options:

43
.github/workflows/label-issues.yml vendored Executable file
View File

@@ -0,0 +1,43 @@
name: Label Issues by Installation Type
on:
issues:
types: [opened]
permissions:
issues: write
jobs:
add-label:
runs-on: ubuntu-latest
steps:
- name: Get issue content
uses: actions/github-script@v7
with:
script: |
const body = context.payload.issue.body;
const lowerBody = body.toLowerCase();
let labelsToAdd = [];
if (lowerBody.includes('bare-metal')) {
labelsToAdd.push('bare-metal ❗');
}
if (lowerBody.includes('home assistant')) {
labelsToAdd.push('Home Assistant 🏠');
}
if (lowerBody.includes('production (netalertx)') || lowerBody.includes('dev (netalertx-dev)')) {
labelsToAdd.push('Docker 🐋');
}
if (labelsToAdd.length > 0) {
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
labels: labelsToAdd
});
}

View File

@@ -8,7 +8,7 @@ NetAlertX supports additional plugins to extend its functionality, each with its
## ⚡ Quick start ## ⚡ Quick start
> [!TIP] > [!TIP]
> You can load additional Plugins via the General -> `LOADED_PLUGINS` setting. You need to save the settings for the new plugins to load (cahce/page relaod may be necessary). > You can load additional Plugins via the General -> `LOADED_PLUGINS` setting. You need to save the settings for the new plugins to load (cache/page reload may be necessary).
> ![Loaded plugins settings](./img/PLUGINS/loaded_plugins_setting.png) > ![Loaded plugins settings](./img/PLUGINS/loaded_plugins_setting.png)
1. Pick your `🔍 dev scanner` plugin (e.g. `ARPSCAN` or `NMAPDEV`), or import devices into the application with an `📥 importer` plugin. (See **Enabling plugins** below) 1. Pick your `🔍 dev scanner` plugin (e.g. `ARPSCAN` or `NMAPDEV`), or import devices into the application with an `📥 importer` plugin. (See **Enabling plugins** below)

View File

@@ -1,6 +1,27 @@
# Debugging inaccessible UI # Debugging inaccessible UI
## 1. Port conflicts The application uses the following default ports:
- **Web UI**: `20211`
- **GraphQL API**: `20212`
The **Web UI** is served by an **nginx** server, while the **API backend** runs on a **Flask (Python)** server.
## Changing Ports
- To change the **Web UI** port, update the `PORT` environment variable in the `docker-compose.yml` file.
- To change the **GraphQL API** port, use the `GRAPHQL_PORT` setting, either directly or via Docker:
```yaml
APP_CONF_OVERRIDE={"GRAPHQL_PORT":"20212"}
```
For more information, check the [Docker installation guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md).
## Possible issues and troubleshooting
Follow all of the below in order to disqualify potential causes of issues and to troubleshoot these problems faster.
### 1. Port conflicts
When opening an issue or debugging: When opening an issue or debugging:
@@ -15,27 +36,27 @@ When opening an issue or debugging:
![lsof ports](./img/WEB_UI_PORT_DEBUG/container_port.png) ![lsof ports](./img/WEB_UI_PORT_DEBUG/container_port.png)
## 2. JavaScript issues ### 2. JavaScript issues
Check for browser console (F12 browser dev console) errors + check different browsers. Check for browser console (F12 browser dev console) errors + check different browsers.
## 3. Clear the app cache and cached JavaScript files ### 3. Clear the app cache and cached JavaScript files
Refresh the browser cache (usually shoft + refresh), try a private window, or different browsers. Please also refresh the app cache by clicking the 🔃 (reload) button in the header of the application. Refresh the browser cache (usually shoft + refresh), try a private window, or different browsers. Please also refresh the app cache by clicking the 🔃 (reload) button in the header of the application.
## 4. Disable proxies ### 4. Disable proxies
If you have any reverse proxy or similar, try disabling it. If you have any reverse proxy or similar, try disabling it.
## 5. Disable your firewall ### 5. Disable your firewall
If you are using a firewall, try to temporarily disabling it. If you are using a firewall, try to temporarily disabling it.
## 6. Post your docker start details ### 6. Post your docker start details
If you haven't, post your docker compose/run command. If you haven't, post your docker compose/run command.
## 7. Check for errors in your PHP/NGINX error logs ### 7. Check for errors in your PHP/NGINX error logs
In the container execute and investigate: In the container execute and investigate:
@@ -43,7 +64,7 @@ In the container execute and investigate:
`cat /app/log/app.php_errors.log` `cat /app/log/app.php_errors.log`
## 8. Make sure permissions are correct ### 8. Make sure permissions are correct
> [!TIP] > [!TIP]
> You can try to start the container without mapping the `/app/config` and `/app/db` dirs and if the UI shows up then the issue is most likely related to your file system permissions or file ownership. > You can try to start the container without mapping the `/app/config` and `/app/db` dirs and if the UI shows up then the issue is most likely related to your file system permissions or file ownership.

View File

@@ -19,6 +19,9 @@ Below are a few examples that demonstrate how this module can be used to simplif
Triggers define the event that activates a workflow. They monitor changes to objects within the system, such as updates to devices or the insertion of new entries. When the specified event occurs, the workflow is executed. Triggers define the event that activates a workflow. They monitor changes to objects within the system, such as updates to devices or the insertion of new entries. When the specified event occurs, the workflow is executed.
> [!TIP]
> Workflows not running? Check the [Workflows debugging](./WORKFLOWS_DEBUGGING.md) guide how to troubleshoot triggers and conditions.
#### Example Trigger: #### Example Trigger:
- **Object Type**: `Devices` - **Object Type**: `Devices`
- **Event Type**: `update` - **Event Type**: `update`