Skip to content

Commit 3ce62ab

Browse files
authored
Added a short explanation how to run devcontainer (#76)
* Added a short explanation how to run devcontainer
1 parent 0708d15 commit 3ce62ab

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,20 @@ PLUGINS_CONFIG = {
6262
}
6363
```
6464

65+
## Developing
66+
67+
### VSCode + Docker + Dev Containers
68+
69+
To develop this plugin further one can use the included .devcontainer configuration. This configuration creates a docker container which includes a fully working netbox installation. Currently it should work when using WSL 2. For this to work make sure you have Docker Desktop installed and the WSL 2 integrations activated.
70+
71+
1. In the WSL terminal, enter `code` to run Visual studio code.
72+
1. Install the devcontainer extension "ms-vscode-remote.remote-containers"
73+
1. Press Ctrl+Shift+P and use the "Dev Container: Clone Repository in Container Volume" function to clone this repository. This will take a while depending on your computer
74+
1. If you'd like the netbox instance to be prepopulated run `make Makefile example_initializers` and `make Makefile load_initializers`
75+
1. Start the netbox instance using `make Makefile all`
76+
77+
Your netbox instance will be served under 0.0.0.0:8000 so it should now be available under localhost:8000.
78+
6579
## Screenshots
6680

6781
Access List - List View

0 commit comments

Comments
 (0)