From 0bae952410e35a03d2c2b84573ce450318ed2d69 Mon Sep 17 00:00:00 2001 From: Brady Lamprecht Date: Wed, 2 Jan 2019 17:12:46 -0700 Subject: [PATCH] Documenting reporting usage in `README.md` Updated `README.md` on how to use the reporting feature of NetBox within this container. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 7f88500..21c5288 100644 --- a/README.md +++ b/README.md @@ -131,6 +131,15 @@ However, if you don't need this functionality, leave these blank. [napalm-doc]: http://napalm.readthedocs.io/en/latest/index.html [netbox-napalm-doc]: https://netbox.readthedocs.io/en/latest/configuration/optional-settings/#napalm_username +### Customizable Reporting ### + +NetBox includes [customized reporting][netbox-reports-doc] that allows the user to write Python code and determine the validity of the data within NetBox. The `REPORTS_ROOT` variable is setup as a mapped directory within this Docker container to `/reports/` and includes the example directly from the documentation for `devices.py`. However, it has been renamed to `devices.py.example` which prevents NetBox from recognizing it as a valid report. This was done to avoid unnessary issues from being opened when the default does not work for someone's expectations. + +To re-enable this default report, simply rename `devices.py.example` to `devices.py` and browse within the WebUI to `/extras/reports/`. +You can also dynamically add any other report to this same directory and NetBox will be able to see it without restarting the container. + +[netbox-reports-doc]: https://netbox.readthedocs.io/en/stable/additional-features/reports/ + ### Custom Initialization Code (e.g. Automatically Setting Up Custom Fields) When using `docker-compose`, all the python scripts present in `/opt/netbox/startup_scripts` will automatically be executed after the application boots in the context of `./manage.py`.