vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 09:36:05 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

MKDocs

Browse Source
This commit is contained in:
jokob-sk
2025-02-09 12:01:02 +11:00
parent f793dec6c5
commit c6adaf99f4
14 changed files with 104 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
docs/index.md
View File

@@ -1,31 +1,80 @@
# NetAlertX documentation
# NetAlertX Documentation
## ℹ️ In-App Help
Welcome to the official NetAlertX documentation! NetAlertX is a powerful tool designed to simplify the management and monitoring of your network. Below, you will find guides and resources to help you set up, configure, and troubleshoot your NetAlertX instance.
- Hover over settings, fields, or labels.
- Click the blue ❔ (question-mark) icons.
- Access the in-app **Help / FAQ** section for frequently asked questions.
## In-App Help
NetAlertX provides contextual help within the application:
- **Hover over settings, fields, or labels** to see additional tooltips and guidance.
- **Click the blue ❔ (question-mark) icons** next to various elements to view detailed information.
- Access the in-app **Help / FAQ** section for frequently asked questions and quick answers.
---
## Installation
## Installation Guides
### Docker (Fully Supported)
- [Follow the official installation guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md).
NetAlertX is fully supported in Docker environments, allowing for easy setup and configuration. Follow the official guide to get started:
### Bare-Metal
- [Docker Installation Guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md)
- 🧪 [(Experimental) On-hardware installation](./HW_INSTALL.md) (looking for maintainers)
This guide will take you through the process of setting up NetAlertX using Docker Compose or standalone Docker commands.
### Bare-Metal Installation (Experimental)
If you prefer to run NetAlertX on your own hardware, you can try the experimental bare-metal installation. Please note that this method is still under development, and we're looking for maintainers to help improve it.
- [Bare-Metal Installation Guide](./HW_INSTALL.md)
---
## Help and Support
Before opening an issue:
If you need help or run into issues, here are some resources to guide you:
- 🔍 [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).
**Before opening an issue, please:**
❗ **Follow the issue template** for faster resolution.
- [Check common issues](./DEBUG_TIPS.md#common-issues) to see if your problem has already been reported.
- [Look at closed issues](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed) for possible solutions to past problems.
- **Enable debugging** to gather more information: [Debug Guide](./DEBUG_TIPS.md).
**Need more help?** Join the community discussions or submit a support request:
- Visit the [GitHub Discussions](https://github.com/jokob-sk/NetAlertX/discussions) for community support.
- If you are experiencing issues that require immediate attention, consider opening an issue on our [GitHub Issues page](https://github.com/jokob-sk/NetAlertX/issues).
---
## Contributing
NetAlertX is open-source and welcomes contributions from the community! If you'd like to help improve the software, please follow the guidelines below:
- **Fork the repository** and make your changes.
- **Submit a pull request** with a detailed description of what you’ve changed and why.
For more information on contributing, check out our [Dev Guide](./DEV_ENV_SETUP.md).
---
## Stay Updated
To keep up with the latest changes and updates to NetAlertX, please refer to the following resources:
- [Releases](https://github.com/jokob-sk/NetAlertX/releases)
Make sure to follow the project on GitHub to get notifications for new releases and important updates.
---
## Additional Resources
- **Configuration Tips**: Learn how to optimize NetAlertX for your network setup.
- **Advanced Features**: Explore advanced functionalities like plugin development and custom configurations.
- **Documentation Index**: Check out the full [documentation index](https://github.com/jokob-sk/NetAlertX/tree/main/docs) for all the guides available.
We hope you find this documentation helpful. If you have any suggestions or improvements, please don’t hesitate to contribute!
---
NetAlertX is actively maintained. You can find the source code, report bugs, or request new features on our [GitHub page](https://github.com/jokob-sk/NetAlertX).