idaholab#530, documentation for netbox plugin installation

docs/README.md

@@ -88,10 +88,11 @@ Malcolm can also easily be deployed locally on an ordinary consumer workstation
         + [Email Sender Accounts](alerting.md#AlertingEmail)
 * [Search Queries in Arkime and OpenSearch Dashboards](queries-cheat-sheet.md#SearchCheatSheet)
 * Other Malcolm features
-    - [Custom Rules and Scripts](custom-rules.md#CustomRulesAndScripts)
+    - [Custom Rules, Scripts and Plugins](custom-rules.md#CustomRulesAndScripts)
         + [Suricata](custom-rules.md#Suricata)
         + [Zeek](custom-rules.md#Zeek)
         + [YARA](custom-rules.md#YARA)
+        + [NetBox Plugins](custom-rules.md#NetBox)
         + [Other Customizations](custom-rules.md#Other)
     - [Automatic file extraction and scanning](file-scanning.md#ZeekFileExtraction)
         + [User interface](file-scanning.md#ZeekFileExtractionUI)

docs/custom-rules.md

@@ -3,7 +3,7 @@
 * [Suricata](#Suricata)
 * [Zeek](#Zeek)
 * [YARA](#YARA)
-* [NetBox](#NetBox)
+* [NetBox Plugins](#NetBox)
 * [Other Customizations](#Other)
 
 Much of Malcolm's behavior can be adjusted through [environment variable files](malcolm-config.md#MalcolmConfigEnvVars). However, some components allow further customization through the use of custom scripts, configuration files, and rules.
@@ -74,9 +74,11 @@ docker compose exec file-monitor supervisorctl restart yara
 
 If the `EXTRACTED_FILE_YARA_CUSTOM_ONLY` [environment variable](malcolm-config.md#MalcolmConfigEnvVars) is set to `true`, Malcolm will bypass the default Yara rulesets ([Neo23x0/signature-base](https://github.com/Neo23x0/signature-base), [reversinglabs/reversinglabs-yara-rules](https://github.com/reversinglabs/reversinglabs-yara-rules), and [bartblaze/Yara-rules](https://github.com/bartblaze/Yara-rules)) and use only user-defined rules in `./yara/rules`.
 
-## <a name="NetBox"></a>NetBox
+## <a name="NetBox"></a>NetBox Plugins
 
-TODO documentation
+NetBox's functionality can be extended with plugins that can provide "[new data models, integrations, and more](https://netboxlabs.com/netbox-plugins/)" (see also the [NetBox Wiki](https://github.com/netbox-community/netbox/wiki/Plugins)).
+
+When Malcolm's NetBox container [starts up]({{ site.github.repository_url }}/blob/{{ site.github.build_revision }}/netbox/scripts/netbox_install_plugins.py), it installs (using [pip](https://packaging.python.org/en/latest/guides/tool-recommendations/#installing-packages)) any NetBox plugins that have [cloned](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) or [downloaded and extracted](https://docs.github.com/en/repositories/working-with-files/using-files/downloading-source-code-archives) into subdirectories in `./netbox/custom-plugins/` in the Malcolm installation directory. In instances where Malcolm is being run in an offline/airgapped configuration, the plugins' additional dependencies must also be present under `./netbox/custom-plugins/requirements/`, where they will be automatically installed first.
 
 ## <a name="Other"></a>Other Customizations