Skip to content

Commit 600902e

Browse files
authored
Merge pull request #2 from netboxlabs/chore/improve-readme
chore: improve README
2 parents c312e5b + 760b4eb commit 600902e

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,36 @@
11
# Diode NetBox Plugin
22

3+
Diode NetBox plugin is a [NetBox](https://netboxlabs.com/oss/netbox/) plugin for the Diode ingestion service.
4+
5+
Diode is a new NetBox ingestion service that greatly simplifies and enhances the
6+
process to add and update network data
7+
in NetBox, ensuring your network source of truth is always accurate and can be trusted to power your network automation
8+
pipelines.
9+
10+
More information about Diode can be found
11+
at [https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/](https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/).
12+
313
## Installation
414

515
```bash
616
pip install netboxlabs-diode-netbox-plugin
717
```
818

9-
In your `configuration.py` file, add `netbox_diode_plugin` to the `PLUGINS` list.
19+
In your NetBox `configuration.py` file, add `netbox_diode_plugin` to the `PLUGINS` list.
1020

1121
```python
1222
PLUGINS = [
1323
"netbox_diode_plugin",
1424
]
1525
```
1626

17-
Ensure following environment variables are set:
27+
Set following environment variables for your NetBox:
1828

19-
```
20-
DIODE_TO_NETBOX_API_KEY=<API_KEY_1>
21-
NETBOX_TO_DIODE_API_KEY=<API_KEY_2>
22-
INGESTION_API_KEY=<API_KEY_3>
23-
```
29+
* `DIODE_TO_NETBOX_API_KEY=<API_KEY_1>` - API key for the Diode service to interact with NetBox
30+
* `NETBOX_TO_DIODE_API_KEY=<API_KEY_2>` - API key for the NetBox service to interact with Diode
31+
* `INGESTION_API_KEY=<API_KEY_3>` - API key for Diode SDKs to ingest data into Diode
2432

25-
Values of these environment variables should be 40 character long alphanumeric strings.
33+
Note: values of these environment variables should be 40 character long alphanumeric strings.
2634

2735
Configure the plugin by running the following command in your NetBox instance:
2836

0 commit comments

Comments
 (0)