Updating README.md to describe NAPALM settings.
This commit is contained in:
parent
ce98ce7d7e
commit
f4fc1c8005
10
README.md
10
README.md
|
@ -135,6 +135,16 @@ FROM ninech/netbox:$VERSION
|
||||||
COPY startup_scripts/ /opt/netbox/startup_scripts/
|
COPY startup_scripts/ /opt/netbox/startup_scripts/
|
||||||
COPY initializers/ /opt/netbox/initializers/
|
COPY initializers/ /opt/netbox/initializers/
|
||||||
```
|
```
|
||||||
|
#### NAPALM Settings
|
||||||
|
Since v2.1.0, NAPALM has been tightly integrated into NetBox. To learn more about what NAPALM is and how it works, please see the documentation from the [libary itself](http://napalm.readthedocs.io/en/latest/index.html) or the documentation from [NetBox](https://netbox.readthedocs.io/en/latest/configuration/optional-settings/#napalm_username) on how it is integrated.
|
||||||
|
|
||||||
|
To enable this functionality, simply complete the following lines in `netbox.env` (or appropriate secrets mechanism) :
|
||||||
|
|
||||||
|
* `NAPALM_USERNAME`: A common username that can be utilized for connecting to network devices in your environment.
|
||||||
|
* `NAPALM_PASSWORD`: The password to use in combintation with the username to connect to network devices.
|
||||||
|
* `NAPALM_TIMEOUT`: A value to use for when an attempt to connect to a device will timeout if no response has been recieved.
|
||||||
|
|
||||||
|
However, if you have no need for this functionality, leaving them blank will not hinder the performance of NetBox at all.
|
||||||
|
|
||||||
#### LDAP enabled variant
|
#### LDAP enabled variant
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue