From 1bac80aa6bfcfafe8e1e7488c3fae448d5f8859a Mon Sep 17 00:00:00 2001 From: sspencerwire Date: Wed, 16 Aug 2023 08:35:46 -0500 Subject: [PATCH] # more suggested changes to recently changed files (#1418) --- .../network/librenms_monitoring_server.md | 18 +++++++++--------- .../package_management/package_debranding.md | 2 +- docs/guides/proxies/haproxy_apache_lxd.md | 12 ++++++------ 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/guides/network/librenms_monitoring_server.md b/docs/guides/network/librenms_monitoring_server.md index d1373e9ec3..3f2df2155c 100644 --- a/docs/guides/network/librenms_monitoring_server.md +++ b/docs/guides/network/librenms_monitoring_server.md @@ -20,7 +20,7 @@ While the installation will closely follow the [official install instructions fo ## Prerequisites, Assumptions and Conventions -* A server or container (yes, LibreNMS will run in a container, however, if you a great deal to monitor, your best bet would be to install on its own hardware) running Rocky Linux. All commands assume a fresh install of Rocky Linux. +* A server or container (yes, LibreNMS will run in a container, however, if you a great deal to monitor, your best bet would be to install on stand-alone hardware) running Rocky Linux. All commands assume a fresh install of Rocky Linux. * Assumption: that you can run commands as root or can _sudo_ to do so * Working knowledge of command-line tools, including text editors such as _vi_ * We are assuming the use of SNMP v2. If you want to use SNMP v3, it is supported by LibreNMS and will work. You will need to switch up the SNMP configuration and options on your devices to match up to v3. @@ -112,11 +112,11 @@ exit ### Failure Of PHP Dependency Install Workaround -LibreNMS documentation says that the above procedrue may fail when you are behind a proxy server. I have found that it can fail for other reasons also. For this reason, I have added a procedure for installing Composer later. +LibreNMS documentation says that the above procedure may fail when you are behind a proxy server. I have found that it can fail for other reasons also. For this reason, I have added a procedure for installing Composer later. ## Set Timezone -We need to ensure the correct setting for the system and for PHP. You can find a list of [valid timezone settings for PHP here](https://php.net/manual/en/timezones.php). For instance, for the Central timezone, a common entry would be "America/Chicago". Let's start by editing the php.ini file: +We need to ensure the correct setting for the system and PHP. You can find a list of [valid timezone settings for PHP here](https://php.net/manual/en/timezones.php). For instance, for the Central timezone, a common entry would be "America/Chicago". Let's start by editing the php.ini file: ``` vi /etc/opt/remi/php81/php.ini @@ -450,7 +450,7 @@ Once you click that, you can click the "Build Database" button if it comes back Once that is complete, the "Create Admin User" button will be active, so click this. You will be prompted for an admin user name. In our lab we are simply going to use "admin", and a password for that user. -Emsure the password is secure and, again, log it somewhere safe, such as a password manager. You'll also need to fill in the email address for the administrative user. Once all of that is completed, simply click the "Add User" button. +Ensure the password is secure and log it somewhere safe, such as a password manager. You'll also need to fill in the email address for the administrative user. Once all of that is completed, simply click the "Add User" button. ![LibreNMS Administrative User](../images/librenms_administrative_user.png) @@ -586,7 +586,7 @@ Again, we assumed the "trusted" zone here, but you may want something else, even ## Adding The Devices In Librenms -Now that our sample devices are configured to accept SNMP traffic from our LibreNMS server, the next step is adding those devices to LibreNMS. We are assuming that you have the web interface for LibreNMS open, and if so, it will show you that you have no devices added and ask you to add one. +Now that our sample devices are configured to accept SNMP traffic from our LibreNMS server, the next step is adding those devices to LibreNMS. We assume you have a web interface for LibreNMS open, and that it shows you no devices and ask you to add one. So go ahead and do that. Once you click to add a device, you'll be faced with this screen: @@ -602,15 +602,15 @@ If you run into a "failure to add" error, review the SNMP setup for the workstat As we said from the start, this document will only get you started with LibreNMS. There are a large number of additional configuration items, an extensive API (Application Programming Interface), an alerts system that provides a huge number of options for delivery, called "Transports", and much more. -We will not create any alert rules. Instead we will edit the built-in alert rule "Device Down! Due to no ICMP response" that is pre-configured out of the box. For "Transports" we are going to stick with "Mail", which is just email. Just know that you are not limited. +We will not create any alert rules. Instead we will edit the built-in alert rule "Device Down! Due to no ICMP response" that is pre-configured out of the box. For "Transports" we will stick with "Mail", which is just email. Just know that you are not limited. -Mail must be working to use email for our transport. To get this going, use this [Postfix Procedure](../email/postfix_reporting.md). +Mail must be working to use email for our transport. Use this [Postfix Procedure](../email/postfix_reporting.md) to get this going. Run through that procedure to configure postfix so that it will properly identify where the messages are coming from, but you can stop after the configuration process and come back here. ### Transports -We need a way to send out our alerts. As noted earlier, LibreNMS supports a huge number of transports. We will do our email alert, which is defined as the "Mail" transport. To set up the transport: +We need a way to send out our alerts. As noted earlier, LibreNMS supports a huge number of transports. We will do our email alert defined as "Mail" transport. To set up the transport: 1. Go to the dashboard 2. Let your mouse hover over "Alerts" @@ -638,7 +638,7 @@ Keep in mind that our example is also redundant, as there is an "All Devices" gr ### Setting Up The Alert Rules -Now that we have set up the transport and device group, configure the alert rule. By default, LibreNMS has several alert rules already created for you: +Configure the alert rule next. By default, LibreNMS has several alert rules already created for you: 1. Go to the dashboard 2. Let your mouse hover over "Alerts" diff --git a/docs/guides/package_management/package_debranding.md b/docs/guides/package_management/package_debranding.md index 6159fd7789..81d1be3fe9 100644 --- a/docs/guides/package_management/package_debranding.md +++ b/docs/guides/package_management/package_debranding.md @@ -11,7 +11,7 @@ General Instructions First, identify the files in the package that need to be changed. They could be text files, image files, or others. You can identify the file(s) by digging into git.centos.org/rpms/PACKAGE/ -Develop replacements for these files, but with Rocky branding placed instead. Diff/patch files may also be needed for certain types of text, depends on the content being replaced. +Develop replacements for these files, but with Rocky branding placed instead. Depending on the content being replaced, diff/patch files may be needed for certain types of text. Replacement files go under https://git.rockylinux.org/patch/PACKAGE/ROCKY/_supporting/ Config file (specifying how to apply the patches) goes in https://git.rockylinux.org/patch/PACKAGE/ROCKY/CFG/*.cfg diff --git a/docs/guides/proxies/haproxy_apache_lxd.md b/docs/guides/proxies/haproxy_apache_lxd.md index 3292f7f9df..c4d36687b8 100644 --- a/docs/guides/proxies/haproxy_apache_lxd.md +++ b/docs/guides/proxies/haproxy_apache_lxd.md @@ -61,7 +61,7 @@ Ensure that your editor is set to your preferred editor, in this case `vim`: `export EDITOR=/usr/bin/vim` -Next you need to change the `macvlan` profile. But before you do, you need to know what interface the host uses for our LAN. Run `ip addr` and look for the interface with the LAN IP assignment: +Next, change the `macvlan` profile. Before you do, you need to know what interface the host uses for our LAN. Run `ip addr` and look for the interface with the LAN IP assignment: ``` 2: eno1: mtu 1500 qdisc fq_codel state UP group default qlen 1000 @@ -70,7 +70,7 @@ Next you need to change the `macvlan` profile. But before you do, you need to kn ``` !!! Note - In this case, the interface you are looking for is "eno1" but this could be completely different on your system. Use **your** interface information! + In this case, the interface you are looking for is "eno1", which could be completely different on your system. Use **your** interface information! Now that you know the LAN interface, you can change our `macvlan` profile. To do this, at the command line enter: @@ -90,7 +90,7 @@ devices: name: macvlan ``` -When creating the `macvlan` profile, the system copies the `default` profile. Changing the `default` profile is not possible. +When creating the `macvlan` profile, the system copies the `default` profile. Changing the `default` profile is impossible. Now that the `macvlan` profile exists, you need to apply it to our three containers: @@ -144,9 +144,9 @@ Our environment is ready. Next, install Apache (`httpd`) on each web container. lxc exec web1 dnf install httpd lxc exec web2 dnf install httpd ``` -You will need a whole lot more than Apache for any modern web server, but this is enough to run some tests. +You will need more than Apache for any modern web server, but this is enough to run some tests. -Next, enable `httpd`, start it, and change the default welcome screen. In this way, you know the server that is responding when attempting to access by way of the proxy. +Next, enable `httpd`, start it, and change the default welcome screen. This way, you know the server is responding when attempting to access by proxy. Enable and start `httpd`: @@ -157,7 +157,7 @@ lxc exec web2 systemctl enable httpd lxc exec web2 systemctl start httpd ``` -With `httpd` running, change the welcome screen. This screen comes up when no website configured, essentially a default page that loads. In Rocky Linux, this page is here `/usr/share/httpd/noindex/index.html`. Changing that file requires no direct access to the container. Just do the following: +Change the welcome screen. This screen comes up when no website configured, essentially a default page that loads. In Rocky Linux, this page is here `/usr/share/httpd/noindex/index.html`. Changing that file requires no direct access to the container. Just do the following: `lxc exec web1 vi /usr/share/httpd/noindex/index.html`