📝 Show boolean NBZX_ values on the Installation page
Add an example of passing boolean settings as environment variables to
the Docker section, and list the accepted boolean values where the
NBZX_ prefix is introduced.
5891146
📝 Document boolean parsing of NBZX_ environment variables
Since v4.1, NBZX_ variables for settings with a boolean default convert
true/false, 1/0, yes/no and on/off, so NBZX_CLUSTERING=false now
disables clustering. Replace the warning that any value enables a
boolean with a table of accepted values, and explain that other values
are kept as text, which is how usermacro_sync=full and a proxy_cf field
name are set.
Keep the old behavior as a warning for versions before v4.1, and note
that unknown values still enable a boolean and that text settings such
as log_file are never converted.
887a707
📝 Align sidebar with the page titles
c99419c
📝 Update Experimental Features for the v4.1 release
Config context rendering is no longer only on the development branch.
Mark it as added in v4.1, show how to enable it, and explain which part
of config context is rendered, what data is available and what happens
when rendering fails. Clarify the strftime filter default and its time
zone handling, and fix typos.
dcafd72
📝 Document sync lifecycle, filtering, clustering and journals
Add sections for behavior that was not documented anywhere:
- How a sync run handles each object, and what happens when a host name
already exists, a host was deleted in Zabbix, or an object was deleted
in NetBox.
- Device and VM filters, with the examples from config.py.example.
- Clustering of virtual chassis, including the failover takeover added in
v4.1 and extended_virtual_chassis.
- Journal entries.
- That the host description is only set on creation.
- The NETBOX_ID<id> host name used for names with special characters.
6e6d282
📝 Correct outdated and wrong information in Sync Behavior
Corrections:
- VMs use the device_cf custom field (zabbix_hostid), not zabbix_id.
- VMs default to a Zabbix agent interface, not SNMPv2.
- Hostgroup fields: add rack and fixed text, fix traverse_regions and the
dev_location example, and fix vm_hostgroup_format being described as
the device format.
- IPMI, OOB interfaces, DNS names and interface overrides are no longer
"in development": mark them as added in v4.1 and note they are
device-only where applicable.
- Fix invalid JSON in the tags, OOB and advanced interface examples.
- Use lowercase IPMI authtypes and usermacro types, matching what the
code accepts, and document the usermacro description key.
- Inventory example used custom_fields/<field>/name, which only works for
Object custom fields.
- templates_config_context_overrule applies to all config context, not
only device specific context.
- Update the log messages to what the script currently prints.
Additions to existing sections:
- Hostgroups, templates, tags, usermacros and interfaces set by hand in
Zabbix are replaced or removed on the next run.
- Interface type names, default ports, SNMP options and preferred_ip.
- Proxy custom field types, selection order and full_proxy_sync.
- Default usermacro maps are active as soon as usermacro_sync is enabled.
Permissions moved to the Preparation page. Sections are reordered and a
short introduction on config context was added.
2f674d2
📝 Document all settings and logging on the Configuration page
- Add the settings missing from the table: proxy_cf, proxy_group_cf,
oob_sync, extended_ips, prefer_dns, preferred_ip, render_config_context
and the log_* settings. Group the table by feature and link each group
to Sync Behavior.
- Explain the priority of defaults, config.py, NBZX_ variables and flags,
and where config.py is looked up.
- Warn that NBZX_ variables are read as text: any value enables a boolean
(including False), and lists and dicts cannot be set.
- Move the logging documentation here from the README.
d46aff5
📝 Fix VM custom field and add permissions to Preparation
- VMs use the same custom field as devices (device_cf, zabbix_hostid by
default), not zabbix_id.
- Explain when zabbix_template is needed and how to relink a host by
editing zabbix_hostid.
- List the optional proxy and hostgroup custom fields.
- Move NetBox and Zabbix permissions here from Sync Behavior and expand
them, including the Super admin requirement for hostgroup creation.
19341cb
📝 Correct and complete the Installation page
- Replace the pyzabbix dependency with the actual install steps (uv or
requirements.txt); the project uses zabbix-utils and more packages.
- Document the Docker image tags, how to pass flags to the container and
where to mount config.py.
- Document the netbox-zabbix-sync command installed by the package.
- Expand the Python API example with token login, the connect() return
value, start() filters, config merging and logging.
- Add a table of all environment variables, including v2 NetBox tokens.
- Fix the --version flag and list all config override flags.
e469ec8
📝 Update requirements and feature list on Home
The project requires Python 3.12 or later, not 3.9. Expand the feature list
with capabilities added over time (interfaces, proxies, inventory, tags,
usermacros, clustering, journals, Python package) and add an overview of
the wiki pages.
9903ea0
📝 Fix environment variable names in Quick Start
The docker run example used NETBOX_URL, ZABBIX_URL, ZABBIX_USERNAME and
ZABBIX_PASSWORD, none of which are read by the script. Use NETBOX_HOST,
ZABBIX_HOST, ZABBIX_USER and ZABBIX_PASS instead.
Also clarify that only zabbix_hostid is required on devices and VMs, that
zabbix_template belongs on device types, and that the container runs a
single sync.
78a7dc5
Updated Sync Behavior (markdown)
q1x
committed
Oct 5, 2026
b6ee945
Updated Sync Behavior (markdown)
q1x
committed
Oct 5, 2026
a525b3b
Updated Sync Behavior (markdown)
q1x
committed
Oct 5, 2026
c59e0fa
Updated Sync Behavior (markdown)
q1x
committed
Oct 5, 2026
dfb7364
Updated Sync Behavior (markdown)
q1x
committed
Oct 5, 2026
4ed429f
Updated Experimental Features (markdown)
q1x
committed
Apr 9, 2026
5b71aaf
Updated _Sidebar (markdown)
q1x
committed
Apr 8, 2026
693448b
Added first version of Jinja rendering of the config context
q1x
committed
Apr 8, 2026
bfa6845
Added new page on experimental features
q1x
committed
Apr 1, 2026
5606a4e
Adding documentation for new IPMI interface support
q1x
committed
Mar 25, 2026
a231abd
Updated Configuration (markdown)
q1x
committed
Mar 25, 2026
1007cdc
Updated Sync Behavior (markdown)
2a0e091
Added new section for description options
6aa8679
Adds 2 new description configuration parameters
9bbd9b0
Added installation instructions for Python package usage. Added new flags.
21343df
Modified "quick start" to "Getting Started"
2cdaa67
Updated Configuration (markdown)
15a47ff
Updated Configuration (markdown)
1500365
Created _Sidebar (markdown)
cd6fb2f