Skip to content

Commit a45733e

Browse files
authored
Merge pull request #121 from netboxlabs/built_in_plugins
NBE built in plugins instructions
2 parents 3d916a0 + 3cc5b18 commit a45733e

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Built-in Plugins in NetBox Enterprise
2+
3+
NetBox Enterprise ships with a curated set of built-in plugins that extend the platform's core capabilities—offering enhanced features without the complexity of manual setup. These plugins are pre-integrated and supported within the platform, ensuring streamlined deployment and reliable performance.
4+
5+
## Available Plugins
6+
7+
Built-in plugins are regularly added to NetBox Enterprise as new releases become available. For the most current list of built-in plugins, refer to the [NetBox Enterprise Release Notes](https://docs.netboxlabs.com/netbox-enterprise/nbe-release-notes/).
8+
9+
## Plugin Management and Deployment
10+
11+
The following steps will guide you through installation of built-in plugins:
12+
13+
1. Navigate to the `Config` tab in the admin console.
14+
2. Enable `Advanced Settings` by clicking the 'Show Advanced Settings' checkbox:
15+
![Screenshot: advanced settings](../images/netbox-enterprise/advanced_settings.png){ style="max-width: 75%" }
16+
3. In the **NetBox Python Configuration Overrides** field, define your plugin list:
17+
```
18+
PLUGINS = ['netbox_topology_views', 'netbox_bgp']
19+
```
20+
4. Additional plugin options can be configured in the override as well. Below is an example for NetBox Topology Views:
21+
```
22+
PLUGINS_CONFIG = {
23+
'netbox_topology_views': {
24+
'allow_coordinates_saving': True,
25+
'always_save_coordinates': True
26+
}
27+
}
28+
```
29+
*Be sure to consult the plugin’s GitHub repository for specific configuration details.*
30+
5. Save the configuration at the bottom of the page. When prompted, click **Go to updated version**, then select **Deploy** to apply the configuration changes.
31+
32+
Once your NetBox Enterprise is back in a `Ready` state, log in to your instance and your plugins will be available.
33+
34+
35+
36+

mkdocs.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,9 @@ nav:
104104
- RHEL: "netbox-enterprise/nbe-ec-requirements-rhel.md"
105105
- Linux System Changes: "netbox-enterprise/nbe-ec-linux-changes.md"
106106
- Installation: "netbox-enterprise/nbe-ec-installation.md"
107-
- Custom Plugin Installation: "netbox-enterprise/nbe-ec-custom-plugins.md"
108107
- Migrating: "netbox-enterprise/nbe-migrating.md"
108+
- Built-in Plugin Installation: "netbox-enterprise/nbe-ec-built-in-plugins.md"
109+
- Custom Plugin Installation: "netbox-enterprise/nbe-ec-custom-plugins.md"
109110
#- KOTS:
110111
# - Requirements: "netbox-enterprise/nbe-kots-requirements.md"
111112
# - Installation: "netbox-enterprise/nbe-kots-installation.md"

0 commit comments

Comments
 (0)