NeoAnd/netbox-zabbix-sync
1
0
Fork 0
mirror of https://github.com/TheNetworkGuy/netbox-zabbix-sync.git synced 2025-07-16 12:12:57 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Revised with references to the docker-compose.yml file in the repo.
This commit is contained in:
Kage1 2024-06-13 09:27:27 -05:00 committed by GitHub
parent 7b49f62dc8
commit 06af73ee5e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -29,31 +29,19 @@ to override with your own config file if needed (see [config file](#config-file)
``` ```
docker run -d -t -i -v $(pwd)/config.py:/opt/netbox-zabbix/config.py ... docker run -d -t -i -v $(pwd)/config.py:/opt/netbox-zabbix/config.py ...
``` ```
### Docker Compose Example ### Running via Docker Compose
For users wanting to use docker compose for running the sync the example below can be used as a starting point. For users wanting to use docker compose for running the sync, utilize the docker-compose.yml file in the main repo as a starting point.
* Verify volume map matches your location * Verify volume map matches your actual location of the config file
* Update the environment variables to match your install * Update the environment variables to match your install
* Note: Do not wrap the vars in quotes * Note: Do not wrap the vars in quotes
Once the compose file has been filled out run a one-time sync with:
``` ```
# example docker compose file for netbox to zabbix sync docker compose up
#
services:
nbx-zbx-sync:
container_name: netbox-zabbix-sync
restart: no
image: ghcr.io/thenetworkguy/netbox-zabbix-sync:main
volumes:
- /etc/netbox-zabbix-sync/config.py:/opt/netbox-zabbix/config.py
environment:
- ZABBIX_HOST=https://zabbix.local
- ZABBIX_TOKEN=<othersecrettoken>
- NETBOX_HOST=https://netbox.local
- NETBOX_TOKEN=<secrettoken>
``` ```
The script, by design, runs on demand so it will need to be scheduled to run by the users prefered method.
Successful completion of the script is noted by: ```exited with code 0```
## Installation from Source ## Installation from Source