mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2025-12-07 09:36:05 -08:00
32 lines
843 B
Markdown
Executable File
32 lines
843 B
Markdown
Executable File
# NetAlertX documentation
|
||
|
||
## ℹ️ In-App Help
|
||
|
||
- Hover over settings, fields, or labels.
|
||
- Click the blue ❔ (question-mark) icons.
|
||
- Access the in-app **Help / FAQ** section for frequently asked questions.
|
||
|
||
---
|
||
|
||
## Installation
|
||
|
||
### Docker (Fully Supported)
|
||
|
||
- [Follow the official installation guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md).
|
||
|
||
### Bare-Metal
|
||
|
||
- 🧪 [(Experimental) On-hardware installation](./HW_INSTALL.md) (looking for maintainers)
|
||
|
||
---
|
||
|
||
## Help and Support
|
||
|
||
Before opening an issue:
|
||
|
||
- 🔍 [Check common issues](./DEBUG_TIPS.md#common-issues).
|
||
- 📌 [Look at closed issues](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed).
|
||
- ⚠ **Enable debugging** before reporting: [Debug Guide](./DEBUG_TIPS.md).
|
||
|
||
❗ **Follow the issue template** for faster resolution.
|