diff --git a/.github/PULL_REQUEST_TEMPLATE/code-pr-template.md b/.github/PULL_REQUEST_TEMPLATE/code-pr-template.md index eafc067c..4a2e18e7 100644 --- a/.github/PULL_REQUEST_TEMPLATE/code-pr-template.md +++ b/.github/PULL_REQUEST_TEMPLATE/code-pr-template.md @@ -40,7 +40,7 @@ Please check the relevant option(s): ## ✅ 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 updated relevant documentation (if applicable) - [ ] I have verified my changes do not break existing behavior diff --git a/.github/PULL_REQUEST_TEMPLATE/docs-pr-template.md b/.github/PULL_REQUEST_TEMPLATE/docs-pr-template.md index 9bc1d509..b7c17b1c 100644 --- a/.github/PULL_REQUEST_TEMPLATE/docs-pr-template.md +++ b/.github/PULL_REQUEST_TEMPLATE/docs-pr-template.md @@ -24,6 +24,7 @@ ## ✅ Checklist - [ ] I followed the formatting/style of existing documentation +- [ ] I have read the [Contribution Guidelines](../../CONTRIBUTING) - [ ] I updated `mkdocs.yml` if necessary - [ ] I verified links and references still work - [ ] I checked that my changes improve clarity, structure, or accuracy diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index cb09efe6..ab9765e6 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -60,7 +60,7 @@ representative at an online or offline event. ## Enforcement 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 . All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the diff --git a/README.md b/README.md index 16e0c8aa..4c14bcb8 100755 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ To further secure your installation: - Use firewalls to restrict access to the web UI - 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 @@ -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. **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?** -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?** -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 diff --git a/docs/SECURITY.md b/docs/SECURITY.md index a5c19597..35612495 100755 --- a/docs/SECURITY.md +++ b/docs/SECURITY.md @@ -49,7 +49,7 @@ By default, NetAlertX does **not** require login. Before exposing the UI in any ```ini SETPWD_enable_password=true SETPWD_password=your_secure_password -``` + ``` 2. Passwords are stored as SHA256 hashes