vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-06 17:15:38 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Improvements

Browse Source 
Fixes a few things here and there
This commit is contained in:
Ashtin
2025-06-25 06:40:10 -04:00
parent 23a0a98b4f
commit 5a3782c9f1
5 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/PULL_REQUEST_TEMPLATE/code-pr-template.md vendored
View File

@@ -40,7 +40,7 @@ Please check the relevant option(s):
## ✅ Checklist ## ✅ Checklist
- [ ] I have read the [Contribution Guidelines](https://github.com/jokob-sk/NetAlertX/blob/main/docs/CONTRIBUTING.md) - [ ] I have read the [Contribution Guidelines](../../CONTRIBUTING)
- [ ] I have tested my changes locally - [ ] I have tested my changes locally
- [ ] I have updated relevant documentation (if applicable) - [ ] I have updated relevant documentation (if applicable)
- [ ] I have verified my changes do not break existing behavior - [ ] I have verified my changes do not break existing behavior

1
.github/PULL_REQUEST_TEMPLATE/docs-pr-template.md vendored
View File

@@ -24,6 +24,7 @@
## ✅ Checklist ## ✅ Checklist
- [ ] I followed the formatting/style of existing documentation - [ ] I followed the formatting/style of existing documentation
- [ ] I have read the [Contribution Guidelines](../../CONTRIBUTING)
- [ ] I updated `mkdocs.yml` if necessary - [ ] I updated `mkdocs.yml` if necessary
- [ ] I verified links and references still work - [ ] I verified links and references still work
- [ ] I checked that my changes improve clarity, structure, or accuracy - [ ] I checked that my changes improve clarity, structure, or accuracy

2
CODE_OF_CONDUCT.md
View File

@@ -60,7 +60,7 @@ representative at an online or offline event.
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at jokob@duck.com. reported to the community leaders responsible for enforcement at <jokob@duck.com>.
All complaints will be reviewed and investigated promptly and fairly. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the All community leaders are obligated to respect the privacy and security of the

8
README.md
View File

@@ -102,7 +102,7 @@ To further secure your installation:
- Use firewalls to restrict access to the web UI - Use firewalls to restrict access to the web UI
- Regularly update to the latest version for security patches - Regularly update to the latest version for security patches
See [Security Best Practices](https://github.com/jokob-sk/NetAlertX/wiki/Security) for more details. See [Security Best Practices](https://github.com/jokob-sk/NetAlertX/security) for more details.
## ❓ FAQ ## ❓ FAQ
@@ -114,13 +114,13 @@ A: Ensure the container has proper network access (e.g., use `--network host` on
A: Yes, but some scanners (e.g. ARP) work best on Ethernet. For Wi-Fi, try SNMP, DHCP, or Pi-hole import. A: Yes, but some scanners (e.g. ARP) work best on Ethernet. For Wi-Fi, try SNMP, DHCP, or Pi-hole import.
**Q: Will this send any data to the internet?** **Q: Will this send any data to the internet?**
A: No. All scans and data remain local unless you set up cloud-based notifications. A: No. All scans and data remain local, unless you set up cloud-based notifications.
**Q: Can I use this without Docker?** **Q: Can I use this without Docker?**
A: Yes! You can install it bare-metal. See the [bare metal install 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. Backup this folder regularly. A: In the `/config` volume, mapped in Docker. Back up this folder regularly.
## 🐞 Known Issues ## 🐞 Known Issues

2
docs/SECURITY.md
View File

@@ -49,7 +49,7 @@ By default, NetAlertX does **not** require login. Before exposing the UI in any
```ini ```ini
SETPWD_enable_password=true SETPWD_enable_password=true
SETPWD_password=your_secure_password SETPWD_password=your_secure_password
``` ```
2. Passwords are stored as SHA256 hashes 2. Passwords are stored as SHA256 hashes