From bcf49dd9bc5bfe843f20e985f8b089fcc219dce9 Mon Sep 17 00:00:00 2001 From: Kaylee Date: Wed, 16 Jul 2025 11:27:36 -0700 Subject: [PATCH] Reorganized and standardized LibreNMS section --- docs/tutorials/.pages | 5 +---- docs/tutorials/librenms/.pages | 5 +++++ .../{ => librenms}/librenms-manager-setup.md | 2 +- docs/tutorials/{ => librenms}/librenms-setup.md | 2 +- docs/tutorials/librenms/librenms.md | 13 +++++++++---- docs/tutorials/{ => librenms}/librenms_kiosk.md | 14 ++++++++++---- docs/tutorials/software.md | 2 +- 7 files changed, 28 insertions(+), 15 deletions(-) create mode 100644 docs/tutorials/librenms/.pages rename docs/tutorials/{ => librenms}/librenms-manager-setup.md (98%) rename docs/tutorials/{ => librenms}/librenms-setup.md (98%) rename docs/tutorials/{ => librenms}/librenms_kiosk.md (80%) diff --git a/docs/tutorials/.pages b/docs/tutorials/.pages index 9919828..2c4b186 100644 --- a/docs/tutorials/.pages +++ b/docs/tutorials/.pages @@ -2,11 +2,8 @@ nav: - hardware.md - software.md - peering.md - - librenms-manager-setup.md - - librenms-setup.md - epc-setup.md - enb-setup.md - proxmox-vaultwarden-deployment.md - grafana-log-dashboard.md - - librenms - - librenms_kiosk.md + - librenms \ No newline at end of file diff --git a/docs/tutorials/librenms/.pages b/docs/tutorials/librenms/.pages new file mode 100644 index 0000000..5ddf40c --- /dev/null +++ b/docs/tutorials/librenms/.pages @@ -0,0 +1,5 @@ +nav: + - librenms.md + - librenms_kiosk.md + - librenms-manager-setup.md + - librenms-setup.md diff --git a/docs/tutorials/librenms-manager-setup.md b/docs/tutorials/librenms/librenms-manager-setup.md similarity index 98% rename from docs/tutorials/librenms-manager-setup.md rename to docs/tutorials/librenms/librenms-manager-setup.md index c59f013..3895318 100644 --- a/docs/tutorials/librenms-manager-setup.md +++ b/docs/tutorials/librenms/librenms-manager-setup.md @@ -1,5 +1,5 @@ --- -title: Network Monitoring 1. LibreNMS Network Manager Configuration +title: LibreNMS Network Manager Configuration --- # LibreNMS Network Manager Configuration diff --git a/docs/tutorials/librenms-setup.md b/docs/tutorials/librenms/librenms-setup.md similarity index 98% rename from docs/tutorials/librenms-setup.md rename to docs/tutorials/librenms/librenms-setup.md index 2878de4..fa79664 100644 --- a/docs/tutorials/librenms-setup.md +++ b/docs/tutorials/librenms/librenms-setup.md @@ -1,5 +1,5 @@ --- -title: Network Monitoring 2. LibreNMS Agent Configuration +title: LibreNMS Agent Configuration --- # LibreNMS Agent Configuration diff --git a/docs/tutorials/librenms/librenms.md b/docs/tutorials/librenms/librenms.md index e1d175c..87aaf51 100644 --- a/docs/tutorials/librenms/librenms.md +++ b/docs/tutorials/librenms/librenms.md @@ -1,8 +1,13 @@ -# Librenms -We have a librenms instance running. If you want to deploy it locally to test it out or fix our infrastructure, here are the instructions: https://github.com/abacef/scn-librenms-deploy-script +--- +title: LibreNMS +--- + +# LibreNMS + +We have a LibreNMS instance running. If you want to deploy it locally to test it out or fix our infrastructure, here are the instructions: https://github.com/abacef/scn-librenms-deploy-script ## Backup -If you want to back up the current install of librenms, you can use this script https://github.com/abacef/scn-librenms-backup-script . You can also use this to get the currently running data from the instance to install a mirror instance either locally on your computer or on a server. +If you want to back up the current install of LibreNMS, you can use this script https://github.com/abacef/scn-librenms-backup-script . You can also use this to get the currently running data from the instance to install a mirror instance either locally on your computer or on a server. ## Updating -If you want to update the current install of librenms, you can use this script https://github.com/abacef/scn-software-updater . There is an ansible script in there just for librenms. +If you want to update the current install of LibreNMS, you can use this script https://github.com/abacef/scn-software-updater . There is an ansible script in there just for LibreNMS. diff --git a/docs/tutorials/librenms_kiosk.md b/docs/tutorials/librenms/librenms_kiosk.md similarity index 80% rename from docs/tutorials/librenms_kiosk.md rename to docs/tutorials/librenms/librenms_kiosk.md index 25cbc80..ecc9131 100644 --- a/docs/tutorials/librenms_kiosk.md +++ b/docs/tutorials/librenms/librenms_kiosk.md @@ -1,10 +1,16 @@ -We have a TV in the scn/hack space and you can use it to show librenms +--- +title: LibreNMS Kiosk +--- -# Usage -Turn on the TV with the roku remote, It may be automatically set up to display the HDMI port. Make sure the RPI is plugged into the TV and the HDMI port of the RPI. Also make sure the RPI is plugged into power. If the RPI was rebooted, it will go into the terminal. Log into the RPI using the username and password in vaultwarden. Once into the terminal, run the command `startx`. It will open up librenms (backed by a chromium browser). Log in using preferably a readonly user like `librenms_viewer` the password is in vaultwarden. You can now simply turn off the computer and when you turn it on again it will come up. +#LibreNMS Kiosk +We have a TV in the scn/hack space and you can use it to show LibreNMS -# How it was developed +## Usage +Turn on the TV with the roku remote, It may be automatically set up to display the HDMI port. Make sure the RPI is plugged into the TV and the HDMI port of the RPI. Also make sure the RPI is plugged into power. If the RPI was rebooted, it will go into the terminal. Log into the RPI using the username and password in vaultwarden. Once into the terminal, run the command `startx`. It will open up LibreNMS (backed by a chromium browser). Log in using preferably a readonly user like `librenms_viewer` the password is in vaultwarden. You can now simply turn off the computer and when you turn it on again it will come up. + + +## How it was developed Flash a minimal version of raspbian on an rpi, install xinit and chromium. create an .xinitrc file and put the following in it ``` diff --git a/docs/tutorials/software.md b/docs/tutorials/software.md index fac850d..fb7f171 100644 --- a/docs/tutorials/software.md +++ b/docs/tutorials/software.md @@ -17,7 +17,7 @@ We have a partnership with [Google SAS](https://www.google.com/get/spectrumdatab Learn more about our SAS setup [here](enb-setup.md). ### Network Monitoring and Alerting -We use [LibreNMS](https://www.librenms.org) and SNMPd to monitor our nodes and provide alerting. Our Baicells-specific Network Manager setup is documented [here](librenms-manager-setup.md), and our instructions for configuring a new node can be found [here](librenms-setup.md). +We use [LibreNMS](https://www.librenms.org) and SNMPd to monitor our nodes and provide alerting. Our Baicells-specific Network Manager setup is documented [here](librenms/librenms-manager-setup.md), and our instructions for configuring a new node can be found [here](librenms/librenms-setup.md). ## Field Measurement