Skip to content

Documentation Updates #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 18, 2020
Merged

Documentation Updates #82

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09764a0
Merge pull request #81 from networktocode/develop
jvanderaa Aug 3, 2020
c438b82
Adds doc to restart NB svcs, Adds doc for install in venv
Aug 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,20 @@ The goal of this plugin is not to import everything about a device into NetBox b

## Installation

The plugin is available as a Python package in pypi and can be installed with pip
If using the installation pattern from the NetBox Documentation, you will need to activate the
virtual environment before installing so that you install the package into the virtual environment.

```shell
cd /opt/netbox
source venv/bin/activate
```

The plugin is available as a Python package in pypi and can be installed with pip. Once the
installation is completed, then NetBox and the NetBox worker must be restarted.

```shell
pip install ntc-netbox-plugin-onboarding
systemctl restart netbox netbox-rq
```

> The plugin is compatible with NetBox 2.8.1 and higher
Expand Down