Skip to content

Commit

Permalink
Fixes #89: Documentation bug: Getting Started git clone url incorrect (
Browse files Browse the repository at this point in the history
  • Loading branch information
basictheprogram authored Mar 27, 2023
1 parent 98857fc commit 362056e
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This script will clone a copy of the `netbox-community/devicetype-library` repos
1. This script is written in Python, so lets setup a virtual environment.

```
git clone https://github.com/minitriga/Netbox-Device-Type-Library-Import
git clone https://github.com/netbox-community/Device-Type-Library-Import.git
cd Netbox-Device-Type-Library-Import
python3 -m venv venv
source venv/bin/activate
Expand Down Expand Up @@ -58,17 +58,17 @@ To import only device by APC, for example:
./nb-dt-import.py --vendors apc
```

`--vendors` can also accept a comma separated list of vendors if you want to import multiple.
`--vendors` can also accept a comma separated list of vendors if you want to import multiple.

```
./nb-dt-import.py --vendors apc,juniper
```

## Docker build

It's possible to use this project as a docker container.
It's possible to use this project as a docker container.

To build :
To build :

```
docker build -t netbox-devicetype-import-library .
Expand All @@ -80,15 +80,15 @@ Alternatively you can pull a pre-built image from Github Container Registry (ghc
docker pull ghcr.io/minitriga/netbox-device-type-library-import
```

The container supports the following env var as configuration :
The container supports the following env var as configuration :

- `REPO_URL`, the repo to look for device types (defaults to _https://github.com/netbox-community/devicetype-library.git_)
- `REPO_BRANCH`, the branch to check out if appropriate, defaults to master.
- `NETBOX_URL`, used to access netbox
- `NETBOX_TOKEN`, token for accessing netbox
- `VENDORS`, a comma-separated list of vendors to import (defaults to None)

To run :
To run :

```
docker run -e "NETBOX_URL=http://netbox:8080/" -e "NETBOX_TOKEN=98765434567890" ghcr.io/minitriga/netbox-device-type-library-import
Expand Down

0 comments on commit 362056e

Please sign in to comment.