mirror of
https://github.com/TheNetworkGuy/netbox-zabbix-sync.git
synced 2025-07-16 12:12:57 -06:00
Update README.md
Revised with references to the docker-compose.yml file in the repo.
This commit is contained in:
parent
7b49f62dc8
commit
06af73ee5e
26
README.md
26
README.md
@ -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 Compose Example
|
||||
For users wanting to use docker compose for running the sync the example below can be used as a starting point.
|
||||
### Running via Docker Compose
|
||||
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
|
||||
* 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
|
||||
#
|
||||
|
||||
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>
|
||||
docker compose up
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user