Skip to content

Commit 8bba18f

Browse files
committed
Add additional notes to README
1 parent 67659dc commit 8bba18f

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

custom-objects-quickstart/README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
# NetBox Custom Objects - Quickstart
22

3-
This simple repo is intended to get you up and running with NetBox Custom Objects quickly, using NetBox Docker.
3+
This simple guide is intended to get you up and running with NetBox Custom Objects quickly, using NetBox Docker.
44

5-
## Quick Setup
5+
## Useful Links
66

7-
## Prerequisites
7+
- NetBox Custom Objects repo with documentation: https://github.com/netboxlabs/netbox-custom-objects
8+
- If you experience any issues, please first check if there is an existing discussion or issue on the repo and add to that, otherwise start a new one
9+
- Discussions: https://github.com/netboxlabs/netbox-custom-objects/discussions
10+
- Issues: https://github.com/netboxlabs/netbox-custom-objects/issues
11+
- Join the conversation in the #netbox channel on the NetDev Slack: https://netdev.chat/
12+
13+
## Setup
14+
15+
### Prerequisites
816
- Docker
917
- Python 3.8 or higher
1018

@@ -38,7 +46,7 @@ source 1_set_envvars.sh
3846
./2_start_netbox.sh
3947
```
4048

41-
### Notes
49+
### Additional Notes
4250

4351
- Environment variables are written into `environment`. To start from fresh:
4452

@@ -55,5 +63,5 @@ rm -fr netbox-docker
5563
# Then go to step 2
5664
```
5765

58-
- The time taken for NetBox to start up depends greatly on the available hardware. The timeout is set to 600 seconds. You can change this in `2_start_netbox.sh`.
66+
- The time taken for NetBox to start depends greatly on the available hardware. The timeout is set to 600 seconds. You can change this in `2_start_netbox.sh`.
5967
- The latest available version of NetBox Custom Objects will be used. You can edit `2_start_netbox.sh` to change this behaviour.

0 commit comments

Comments
 (0)