From 92baa22db2f57b004f4d8721e4877adabfc42b2b Mon Sep 17 00:00:00 2001 From: Jochem Date: Fri, 5 Jul 2024 16:32:28 +0200 Subject: [PATCH] Add README --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index e69de29..a28ed9e 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,31 @@ +# LibreNMS Helm Charts + +Welcome to the repository for the Helm charts of the LibreNMS community. This repository holds all the Helm charts you need to deploy LibreNMS and related components using Kubernetes. + +## Main Chart + +The primary chart in this repository is located at `charts/librenms`. This chart allows you to deploy LibreNMS, an open-source network monitoring system, on your Kubernetes cluster. + +## Documentation + +Each chart within this repository comes with its own set of documentation. To get started with a specific chart, please refer to the README.md file located in the respective chart's directory. + +## Getting Started + +To install a chart from this repository, you can use the following Helm commands: + +```sh +helm repo add librenms https://www.librenms.org/helm-charts +helm repo update +helm install my-release librenms/ +``` + +Replace `` with the name of the chart you wish to install (e.g., `librenms`). + +## Contributing + +We welcome contributions from the community. If you have improvements or fixes, please submit a pull request. Make sure to follow our contribution guidelines. + +--- + +Thank you for using LibreNMS Helm charts! For any issues or questions, please refer to the documentation of the respective chart or open an issue in this repository. \ No newline at end of file