Quick Start

Quick Start

This guide will get the script running in just a few minutes using the minimum required configuration.

---

Netbox and Zabbix

Generate a new token in Netbox.

Do the same for Zabbix or use an username / password combination.

Prepare Netbox for the script

Before running the script, you must create two custom fields in NetBox.
These fields are required for syncing to work correctly.

1. Go to Customization → Custom Fields in NetBox.
2. Create the two required custom fields as described in the NetBox Preparation section of the documentation.
3. Ensure the fields are assigned to:
   • Devices
   • Virtual Machines (if VM syncing is enabled)

---

Run the container

docker run \
  -e NETBOX_URL=https://netbox.example.com \
  -e NETBOX_TOKEN=your_netbox_token \
  -e ZABBIX_URL=https://zabbix.example.com \
  -e ZABBIX_USERNAME=api_user \
  -e ZABBIX_PASSWORD=api_password \
  ghcr.io/thenetworkguy/netbox-zabbix-sync:latest

If you use a Zabbix token then please use the ZABBIX_TOKEN environment variable instead of the ZABBIX_USERNAME and ZABBIX_PASSWORD variables.

Obviously there are many different options to adjust. However most default settings will work fine for now. Do you want more features? Check out the installation section and advanced features.