This commit is contained in:
jokob-sk
2025-06-26 14:25:20 +10:00
parent e8e48a2cc4
commit 443b10a990
24 changed files with 12 additions and 8 deletions

0
.github/ISSUE_TEMPLATE/documentation-feedback.yml vendored Normal file → Executable file
View File

0
.github/ISSUE_TEMPLATE/enhancement-request.yml vendored Normal file → Executable file
View File

0
.github/ISSUE_TEMPLATE/refactor-codequality-request.yml vendored Normal file → Executable file
View File

0
.github/ISSUE_TEMPLATE/security-report.yml vendored Normal file → Executable file
View File

0
.github/ISSUE_TEMPLATE/translation-request.yml vendored Normal file → Executable file
View File

0
.github/PULL_REQUEST_TEMPLATE/code-pr-template.md vendored Normal file → Executable file
View File

0
.github/PULL_REQUEST_TEMPLATE/docs-pr-template.md vendored Normal file → Executable file
View File

0
CODE_OF_CONDUCT.md Normal file → Executable file
View File

View File

@@ -28,11 +28,14 @@ Get visibility of what's going on on your WIFI/LAN network and enable presence d
Start NetAlertX in seconds with Docker: Start NetAlertX in seconds with Docker:
```bash ```bash
docker run -d \ docker run -d --rm --network=host \
--name=netalertx \ -v local_path/config:/app/config \
-p 20211:20211 \ -v local_path/db:/app/db \
-v /your/config/path:/config \ --mount type=tmpfs,target=/app/api \
jokobsk/netalertx -e PUID=200 -e PGID=300 \
-e TZ=Europe/Berlin \
-e PORT=20211 \
ghcr.io/jokob-sk/netalertx:latest
``` ```
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://jokob-sk.github.io/NetAlertX/).
@@ -92,6 +95,7 @@ Supported browsers: Chrome, Firefox
- [[Development] API docs](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md) - [[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) - [[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/).
## 🔐 Security & Privacy ## 🔐 Security & Privacy
@@ -120,17 +124,17 @@ A: No. All scans and data remain local, unless you set up cloud-based notificati
A: Yes! You can install it bare-metal. See the [bare metal installation guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md). A: Yes! You can install it bare-metal. See the [bare metal installation guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md).
**Q: Where is the data stored?** **Q: Where is the data stored?**
A: In the `/config` volume, mapped in Docker. Back up this folder regularly. A: In the `/config` and `/db` folders, mapped in Docker. Back up these folders regularly.
## 🐞 Known Issues ## 🐞 Known Issues
- Some scanners (e.g. ARP) may not detect devices on different subnets. - Some scanners (e.g. ARP) may not detect devices on different subnets. See the [Remote networks guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/REMOTE_NETWORKS.md) for workarounds.
- Wi-Fi-only networks may require alternate scanners for accurate detection. - Wi-Fi-only networks may require alternate scanners for accurate detection.
- Notification throttling may be needed for large networks to prevent spam. - 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. - 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. 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/).
## 📃 Everything else ## 📃 Everything else
<!--- --------------------------------------------------------------------- ---> <!--- --------------------------------------------------------------------- --->

0
front/php/templates/language/ar_ar.json Normal file → Executable file
View File

0
front/php/templates/language/ca_ca.json Normal file → Executable file
View File

0
front/php/templates/language/cs_cz.json Normal file → Executable file
View File

0
front/php/templates/language/de_de.json Normal file → Executable file
View File

0
front/php/templates/language/en_us.json Normal file → Executable file
View File

0
front/php/templates/language/es_es.json Normal file → Executable file
View File

0
front/php/templates/language/fr_fr.json Normal file → Executable file
View File

0
front/php/templates/language/it_it.json Normal file → Executable file
View File

0
front/php/templates/language/nb_no.json Normal file → Executable file
View File

0
front/php/templates/language/pl_pl.json Normal file → Executable file
View File

0
front/php/templates/language/pt_br.json Normal file → Executable file
View File

0
front/php/templates/language/ru_ru.json Normal file → Executable file
View File

0
front/php/templates/language/tr_tr.json Normal file → Executable file
View File

0
front/php/templates/language/uk_ua.json Normal file → Executable file
View File

0
front/php/templates/language/zh_cn.json Normal file → Executable file
View File