Fix documentation typos, fix Procurve/Aruba command quotes (librenms#18682)

andrewimeson · web-flow · commit 43740c58e01e · 2025-12-19T11:27:22.000-06:00
* docs: Fix typos

Found with 'typos' tool, false positives skipped

* docs(syslog): Fix curly quotes around Procurve/Aruba commands
diff --git a/doc/Alerting/Scheduled-Maintenances.md b/doc/Alerting/Scheduled-Maintenances.md
@@ -15,7 +15,7 @@ are not created, and existing alerts will not recover. This is the default behav
 transport like mail is suppressed. This is useful if you just want "silence" for a period of time for whatever
 reason but don't want to lose sight of what is happening to your devices.
 - Run alerts: This is basically just a cosmetic maintenance. You will see that a device is in maintenance, but this
-setting will not supress alerts.
+setting will not suppress alerts.
 
 ## Managing Maintenances
 
diff --git a/doc/Alerting/Transports/Jira.md b/doc/Alerting/Transports/Jira.md
@@ -42,4 +42,4 @@ The config fields that need to set for webhooks are: Jira Open URL, Jira Close U
 | Jira Password | myjirapass |
 | Enable webhook | ON/OFF |
 | Webhook ID | alert_id |
-| Custom Fileds | {"components":[{"id":"00001"}], "source": "LibrenNMS"} |
+| Custom Fields | {"components":[{"id":"00001"}], "source": "LibrenNMS"} |
diff --git a/doc/Alerting/Transports/Messagebird-Voice.md b/doc/Alerting/Transports/Messagebird-Voice.md
@@ -6,7 +6,7 @@ LibreNMS can send messages through Messagebird voice Rest API transport (text to
 | ------ | ------- |
 | Api Key | Api rest key given in the messagebird dashboard |
 | Originator | E.164 formatted originator |
-| Recipient | E.164 formatted recipient for multi recipents comma separated |
+| Recipient | E.164 formatted recipient for multi recipients comma separated |
 | Language | Select box for options  |
 | Spoken voice | Female or Male  |
 | Repeat | X times the message is repeated  |
diff --git a/doc/Alerting/Transports/Messagebird.md b/doc/Alerting/Transports/Messagebird.md
@@ -6,5 +6,5 @@ LibreNMS can send text messages through Messagebird Rest API transport.
 | ------ | ------- |
 | Api Key | Api rest key given in the messagebird dashboard |
 | Originator | E.164 formatted originator |
-| Recipient | E.164 formatted recipient for multi recipents comma separated |
+| Recipient | E.164 formatted recipient for multi recipients comma separated |
 | Character limit | Range 1..480 (max 3 split messages)  |
diff --git a/doc/Alerting/Transports/PagerDuty.md b/doc/Alerting/Transports/PagerDuty.md
@@ -1,7 +1,7 @@
 ## PagerDuty
 
 LibreNMS can make use of PagerDuty, this is done by utilizing an API
-key and Integraton Key.
+key and Integration Key.
 
 API Keys can be found under 'API Access' in the PagerDuty portal.
 
diff --git a/doc/Alerting/Transports/SMS-mode.md b/doc/Alerting/Transports/SMS-mode.md
@@ -1,7 +1,7 @@
 ## SMSmode
 
 SMSmode is a SMS provider that can be configured by using the generic API Transport.
-You need a token you can find on your personnal space.
+You need a token you can find on your personal space.
 
 [SMSmode docs](https://www.smsmode.com/pdf/fiche-api-http.pdf)
 
diff --git a/doc/Alerting/Transports/Signal-CLI.md b/doc/Alerting/Transports/Signal-CLI.md
@@ -1,6 +1,6 @@
 ## Signal CLI
 
-Use the Signal Mesenger for Alerts. Run the Signal CLI with the D-Bus option.
+Use the Signal Messenger for Alerts. Run the Signal CLI with the D-Bus option.
 
 [GitHub Project](https://github.com/AsamK/signal-cli)
 
diff --git a/doc/Alerting/Transports/Weechatbot.md b/doc/Alerting/Transports/Weechatbot.md
@@ -4,7 +4,7 @@ The Weechat BOT transport can be used to send alerts to an IRC channel via Weech
 
 Documentation on how to enable UDP listener can be on [the project site](https://github.com/sndrsmnk/weechatbot#udp-listener)
 
-This transport should also be compatible with Gozerbot. Gozerbot does not have the consept of IRC server, so just leave this field empty for Gozerbot compatibility.
+This transport should also be compatible with Gozerbot. Gozerbot does not have the concept of IRC server, so just leave this field empty for Gozerbot compatibility.
 
 **Example:**
 | Config | Example |
diff --git a/doc/Alerting/Transports/Wled.md b/doc/Alerting/Transports/Wled.md
@@ -8,7 +8,7 @@ the WLED web interface.
 
 Leaving warning, critical, or recovery blank, will mean that severity/state is ignored.
 
-Using warning, critical, and recovery together can lead to unpredicatble
+Using warning, critical, and recovery together can lead to unpredictable
 results. Similarly best to only use this for very specific alerts/hosts given this
 transport can only communicate limited info.
 
diff --git a/doc/Alerting/Transports/aspSMS.md b/doc/Alerting/Transports/aspSMS.md
@@ -1,7 +1,7 @@
 ## aspSMS
 
 aspSMS is a SMS provider that can be configured by using the generic API Transport.
-You need a token you can find on your personnal space.
+You need a token you can find on your personal space.
 
 [aspSMS docs](https://www.aspsms.com/en/documentation/)
 
diff --git a/doc/Developing/Application-Notes.md b/doc/Developing/Application-Notes.md
@@ -75,7 +75,7 @@ When you call update_application() the `$app` model will be saved along with
 any changes to the data field.
 
 ```
-// set the varaible data to $foo
+// set the variable data to $foo
 $app->data = [
     'item_A' => 123,
     'item_B' => 4.5,
diff --git a/doc/Developing/Creating-Documentation.md b/doc/Developing/Creating-Documentation.md
@@ -89,7 +89,7 @@ pip install \
  mkdocs-minify-plugin \
  mkdocs-redirects
 ```
-If you encounter permissions issues, these might be reoslved by using the
+If you encounter permissions issues, these might be resolved by using the
 user option, with whatever user you are building as, e.g. `-u librenms`
 
 2. A configuration file for building LibreNMS docs is already included in the
diff --git a/doc/Developing/Using-SnmpQuery.md b/doc/Developing/Using-SnmpQuery.md
@@ -209,7 +209,7 @@ the index cannot be detected.
 Fetch an index to key array of the data.  You can specify an oid to get
 one column out of an SNMP table.
 
-##### Exmples
+##### Examples
 
 In this example, the table IF-MIB::ifTable is indexed by ifIndex, so when we walk the ifName column
 and call pluck, we get a nice mapping of ifIndex to ifName
diff --git a/doc/Developing/os/Health-Information.md b/doc/Developing/os/Health-Information.md
@@ -470,12 +470,12 @@ names Ethernet 1-1-1-1, 1-1-1-2, etc, and they are indexed as oid.1.1.1.1, oid.1
 the mib.
 
 Next the program checks which table the port exists in and that the connector type is 'fiber'. There
-are other port tables in the full code that were ommitted from the example for brevity. Copper
+are other port tables in the full code that were omitted from the example for brevity. Copper
 media won't have optical readings, so if the media type isn't fiber we skip discovery for that port.
 
 The next two lines build the OIDs for getting the optical receive and transmit values using the
 `$index` for the port. Using the OIDs the program gets the current receive and transmit values
-($currentRx and $currentTx repectively) to verify the values are not 0. Not all SFPs collect digital
+($currentRx and $currentTx respectively) to verify the values are not 0. Not all SFPs collect digital
 optical monitoring (DOM) data, in the case of Adva the value of both transmit and receive will be
 0 if DOM is not available. While 0 is a valid value for optical power, its extremely unlikely that
 both will be 0 if DOM is present. If DOM is not available, then the program stops discovery for
diff --git a/doc/Extensions/Applications/HTTP Access Log Combined.md b/doc/Extensions/Applications/HTTP Access Log Combined.md
@@ -26,7 +26,7 @@
         apt-get install libfile-slurp-perl libmime-base64-perl libjson-perl libstatistics-lite-perl libfile-readbackwards-perl
         ```
 
-4. Configure it if neeeded. Uses
+4. Configure it if needed. Uses
    `/usr/local/etc/http_access_log_combined_extend.json`, unless
    specified via `-c`. See further below for configuration
    information.
diff --git a/doc/Extensions/Applications/I2PD.md b/doc/Extensions/Applications/I2PD.md
@@ -4,7 +4,7 @@ This is simple Python3-based SNMP extend script for monitoring I2PD routing daem
 
 Script communicates with I2PD via I2PControl protocol. Enable and configure that first.
 
-## Enabing I2PControl
+## Enabling I2PControl
 
 1. Edit i2pd.conf (usually at `/etc/i2pd/i2pd.conf`) and find `[i2pcontrol]` section
 
diff --git a/doc/Extensions/Applications/Logsize.md b/doc/Extensions/Applications/Logsize.md
@@ -41,7 +41,7 @@ logsize is a small shell script that reports the size of log files.
 3. Configure the config at `/usr/local/etc/logsize.conf`. You can find the documentation for the config file in the extend. Below is a small example.
 
     ```conf
-    # monitor log sizes of logs directly udner /var/log
+    # monitor log sizes of logs directly under /var/log
     [sets.var_log]
     dir="/var/log/"
 
@@ -122,7 +122,7 @@ script and make it executable.
 3. Configure the config at `/usr/local/etc/logsize.conf`. You can find the documentation for the config file in the extend. Below is a small example.
 
     ```conf
-    # monitor log sizes of logs directly udner /var/log
+    # monitor log sizes of logs directly under /var/log
     [sets.var_log]
     dir="/var/log/"
 
diff --git a/doc/Extensions/Applications/OS Level Virtualization Monitoring.md b/doc/Extensions/Applications/OS Level Virtualization Monitoring.md
@@ -101,7 +101,7 @@ By Defaults the backends are as below.
 | `totals_$stat`          | A stat representing a total for all stats across all OSLVMs. |
 
 Something is considered not running if it has been seen. How long
-something is considred to have been seen is controlled by
+something is considered to have been seen is controlled by
 `apps.oslv_monitor.seen_age`, which is the number of seconds ago it
 would of have to be seen. The default is `604800` which is seven days
 in seconds.
diff --git a/doc/Extensions/Applications/Portactivity.md b/doc/Extensions/Applications/Portactivity.md
@@ -28,7 +28,7 @@
     ```
 
 !!! note "portactivity"
-    Will monitor HTTP, LDAP, and IMAP. The `-p` switch specifies what ports to use. This is a comma seperated list.
+    Will monitor HTTP, LDAP, and IMAP. The `-p` switch specifies what ports to use. This is a comma separated list.
     
     These must be found in '/etc/services' or where ever NSS is set to fetch it from. If not, it will throw an error.
     
diff --git a/doc/Extensions/Applications/Poudriere.md b/doc/Extensions/Applications/Poudriere.md
@@ -1,6 +1,6 @@
 # Poudriere
 
-## Intall prerequisites
+## Install prerequisites
 
 === "FreeBSD"
 
diff --git a/doc/Extensions/Applications/Privoxy.md b/doc/Extensions/Applications/Privoxy.md
@@ -56,7 +56,7 @@ enable it manually.
 
 ## Cron
 
-If you are having timeouts or there is privelege seperation issues,
+If you are having timeouts or there is privilege separation issues,
 then it can be ran via cron like below. `-w` can be used to write it
 out and `-o` can be used to control where it is written to. See
 `--help` for more information.
diff --git a/doc/Extensions/Applications/Redis.md b/doc/Extensions/Applications/Redis.md
@@ -26,7 +26,7 @@ Script to monitor your Redis Server
 
     ### SELINUX
 
-    (Optional) If you have SELinux in Enforcing mode, you must add a module so the script can get redis informations and write them:
+    (Optional) If you have SELinux in Enforcing mode, you must add a module so the script can get redis information and write them:
 
     ```
     cat << EOF > snmpd_redis.te
diff --git a/doc/Extensions/Applications/SDFS info.md b/doc/Extensions/Applications/SDFS info.md
@@ -1,7 +1,7 @@
 
 # SDFS info
 
-A small shell script that exportfs SDFS volume info.
+A small shell script that exports SDFS volume info.
 
 ## SNMP Extend
 
diff --git a/doc/Extensions/Applications/Sneck.md b/doc/Extensions/Applications/Sneck.md
@@ -24,7 +24,7 @@ metrics below are provided.
 | critical            | Total CRITICAL checks                                                                                                 |
 | unknown             | Total UNKNOWN checks                                                                                                  |
 | errored             | Total checks that errored                                                                                             |
-| time_to_polling     | Differnce in seconds between when polling data was generated and when polled                                          |
+| time_to_polling     | Difference in seconds between when polling data was generated and when polled                                         |
 | time_to_polling_abs | The absolute value of time_to_polling.                                                                                |
 | check_$CHECK        | Exit status of a specific check `$CHECK` is equal to the name of the check in question. So `foo` would be `check_foo` |
 
diff --git a/doc/Extensions/Applications/UPS-apcups.md b/doc/Extensions/Applications/UPS-apcups.md
@@ -23,7 +23,7 @@ A small shell script that exports apcacess ups status.
     extend ups-apcups /etc/snmp/ups-apcups
     ```
 
-    If 'apcaccess' is not in the PATH enviromental variable snmpd is using, you may need to do something like below.
+    If 'apcaccess' is not in the PATH environmental variable snmpd is using, you may need to do something like below.
 
     ```bash
     extend ups-apcups/usr/bin/env PATH=/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin /etc/snmp/ups-apcups
diff --git a/doc/Extensions/Auto-Discovery.md b/doc/Extensions/Auto-Discovery.md
@@ -204,7 +204,7 @@ positional arguments:
 optional arguments:
   -h, --help       show this help message and exit
   -t THREADS       How many IPs to scan at a time.  More will increase the scan speed, but could overload your system. Default: 32
-  -g GROUP         The poller group all scanned devices will be added to. Default: The first group listed in 'distributed_poller_group', or 0 if not specificed
+  -g GROUP         The poller group all scanned devices will be added to. Default: The first group listed in 'distributed_poller_group', or 0 if not specified
   -l, --legend     Print the legend.
   -v, --verbose    Show debug output. Specifying multiple times increases the verbosity.
   --ping-fallback  Add the device as an ICMP only device if it replies to ping but not SNMP.
diff --git a/doc/Extensions/Availability-Map.md b/doc/Extensions/Availability-Map.md
@@ -22,6 +22,6 @@ lnms config:set webui.availability_map_box_size 165
 # Sort by status instead of hostname
 lnms config:set webui.availability_map_sort_status false
 
-# Show the device group drop-down on the availabiltiy map page
+# Show the device group drop-down on the availability map page
 lnms config:set webui.availability_map_use_device_groups true
 ```
diff --git a/doc/Extensions/Galera-Cluster.md b/doc/Extensions/Galera-Cluster.md
@@ -61,7 +61,7 @@ Change the following values for your environment.
 ### Edit LibreNMS .env
 
 LibreNMS supports up to 9 galera nodes, you define these nodes in the .env file. For each node we have the ability to define if this librenms installation/poller is able to write, read or both to that node.
-The galera nodes you define here can be the same or differnt for each librenms poller. If you have a poller you only want to write/read to one galera node, you would simply add one DB_HOST, and omit all the rest. This allows you to precisely control what galera nodes a librenms poller is reading and or writing too.
+The galera nodes you define here can be the same or different for each librenms poller. If you have a poller you only want to write/read to one galera node, you would simply add one DB_HOST, and omit all the rest. This allows you to precisely control what galera nodes a librenms poller is reading and or writing too.
 
 * DB_HOST is always set to read/write.
 * DB_HOST must be set, however, it does not have to be the same on each poller, it can be different as long as it's part of the same galera cluster.
diff --git a/doc/Extensions/Interface-Description-Parsing.md b/doc/Extensions/Interface-Description-Parsing.md
@@ -117,7 +117,7 @@ to support the parsing of interface information.
   to the Server and make it executable `chmod +x /path/to/ifAlias`
 - Add to `snmpd.conf` something like:
     ``pass .1.3.6.1.2.1.31.1.1.1.18 /path/to/ifAlias``
-- Add aliasses with
+- Add aliases with
   - `iproute2` package like:
     ``ip link set eth0.427 alias 'Cust: CustomerA'``
   - in `/etc/network/interfaces` or `/etc/network/interfaces.d/*` with a comment like:
diff --git a/doc/Extensions/OAuth-SAML.md b/doc/Extensions/OAuth-SAML.md
@@ -292,7 +292,7 @@ the default User Role for Authorized users.   Appropriate care should be taken.
 
 ###  Claims / Access Scopes
 
-Socialite can specifiy scopes that should be included with in the authentication request.
+Socialite can specify scopes that should be included with in the authentication request.
 (see [Larvel docs](https://laravel.com/docs/10.x/socialite#access-scopes) )
 
 For example, if Okta is configured to expose group information it is possible to use these group
@@ -348,7 +348,7 @@ It is up the IdP to provide the relevant details that you will need for configur
 
     ACS URL = https://*your-librenms-url*/auth/saml2/callback
     Entity ID = https://*your-librenms-url*/auth/saml2
-    Name ID format = PERSISTANT
+    Name ID format = PERSISTENT
     Name ID = Basic Information > Primary email
 
     ![socialite-saml-google-4](../img/socialite-saml-google-4.png)
@@ -399,7 +399,7 @@ It is up the IdP to provide the relevant details that you will need for configur
 #### Using an Identity Provider metadata URL
 
 !!! note
-    This is the prefered and easiest way, if your IdP supports it!
+    This is the preferred and easiest way, if your IdP supports it!
 
 !!! setting "settings/auth/socialite"
     ```bash
diff --git a/doc/Extensions/Plugin-System.md b/doc/Extensions/Plugin-System.md
@@ -13,9 +13,9 @@ LibreNMS.
 
 There are two ways to create a plugin.
 
- 1. Local plugin: Within LibreNMS under the app/Plugins directory. This is approriate for plugins that are
+ 1. Local plugin: Within LibreNMS under the app/Plugins directory. This is appropriate for plugins that are
     intended to run only on your instance. A local plugin may ONLY use plugin hooks to augment LibreNMS.
- 3. Plugin package: A php package that can be distributed via composer/packagist.org.  This is approriate
+ 3. Plugin package: A php package that can be distributed via composer/packagist.org.  This is appropriate
     for plugins that are intended to be installed by many people. A plugin package can publish multiple
     routes, views, database migrations and more in addition to using hooks to augment specific parts of LibreNMS.
 
@@ -26,7 +26,7 @@ To tie in to specific parts of LibreNMS such as the Menu, Device Overview or a P
 
 You can see an example plugin here: [example plugin repository](https://github.com/murrant/librenms-example-plugin).
 
-> Please come to discord and share any expriences and update this documentation!
+> Please come to discord and share any experiences and update this documentation!
 
 ## Local plugin
 
diff --git a/doc/Extensions/RRDCached.md b/doc/Extensions/RRDCached.md
@@ -21,7 +21,7 @@ or newer, in addition to your rrdcached version.
 
 ## High-Availability
 
-It's adviced to only run one active instance of RRDCached and have a failover instance ready to take over in case of failure.
+It's advised to only run one active instance of RRDCached and have a failover instance ready to take over in case of failure.
 A recommended setup is to use a network socket for RRDCached and have a load balancer in front of it such as Nginx.
 See [Securing RRDCached](#securing-rrcached) for more information.
 
diff --git a/doc/Extensions/Smokeping.md b/doc/Extensions/Smokeping.md
@@ -21,7 +21,7 @@ smokeping setup, you'll need to adapt these steps somewhat.
 ### Install and integrate Smokeping Backend - RHEL, CentOS and alike
 
 Smokeping is available via EPEL, which if you're running LibreNMS, you probably
-already have. If you want to do something like run Smokeping on a seperate host
+already have. If you want to do something like run Smokeping on a separate host
 and ship data via RRCached though, here's the install command:
 
 ```bash
diff --git a/doc/Extensions/Syslog.md b/doc/Extensions/Syslog.md
@@ -364,7 +364,7 @@ log host source <eth0>
 configure
 logging severity warning
 logging facility local6
-logging librenms.ip control-descr “LibreNMS”
+logging librenms.ip control-descr "LibreNMS"
 logging notify running-config-change
 write memory
 ```
diff --git a/doc/Extensions/Two-Factor-Auth.md b/doc/Extensions/Two-Factor-Auth.md
@@ -63,7 +63,7 @@ Set throttle-time (in seconds):
 
 `./lnms config:set twofactor_lock 300`
 
-## User Administation
+## User Administration
 
 If Two-Factor is enabled, the Settings -> Manage Users grid will show a '2FA' column 
 containing a green tick for users with active 2FA.
diff --git a/doc/Extensions/World-Map.md b/doc/Extensions/World-Map.md
@@ -13,7 +13,7 @@ Location resolution happens as follows
 
 1. If `device['location']` contains `[lat, lng]` (note the square
    brackets), that is used
-1. If there is a location overide for the device in the WebUI and it
+1. If there is a location override for the device in the WebUI and it
    contains `[lat, lng]` (note the square brackets), that is used.
 1. Attempt to resolve lat, lng using `lnms config:set geoloc.engine`
 1. Properly formatted addresses in sysLocation or sysLocation
@@ -53,7 +53,7 @@ Example Settings:
 
 ### Device Overview World Map Settings
 
-If a device has a location with a valid latitude and logitude, the
+If a device has a location with a valid latitude and longitude, the
 device overview page will have a panel showing the device on a world
 map.  The following settings affect this map:
 
diff --git a/doc/General/Releases.md b/doc/General/Releases.md
@@ -9,7 +9,7 @@ We have two branches available for you to use. The default is the `master` branc
 
 ## Development branch
 
-Our `master` branch is our dev branch, this is actively commited to
+Our `master` branch is our dev branch, this is actively committed to
 and it's not uncommon for multiple commits to be merged in daily. As
 such sometimes changes will be introduced which will cause unintended
 issues. If this happens we are usually quick to fix or revert those changes.
diff --git a/doc/Support/Configuration.md b/doc/Support/Configuration.md
@@ -726,7 +726,7 @@ pings enabled and also requires the following configuration setting to enable th
 To disable the MTU test, set the packet size to null (the default).
 
 The MTU check does not ensure packets can traverse the network without being fragmented.  The test makes
-sure that 2 way communication can occure even if packets need to be fragmented at any poing along the way.
+sure that 2 way communication can occure even if packets need to be fragmented at any point along the way.
 
 ## Auto discovery settings
 
diff --git a/doc/Support/FAQ.md b/doc/Support/FAQ.md
diff --git a/doc/Support/SNMP-Configuration-Examples.md b/doc/Support/SNMP-Configuration-Examples.md
