Copied over the relevant parts from the README

Christian Mäder
2019-10-09 12:18:28 +02:00
parent 0baf085d4b
commit 1f565df6b7

8
Custom-Reports.md Normal file

@@ -0,0 +1,8 @@
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.
To re-enable this default report, simply rename `devices.py.example` to `devices.py` and browse to `<your-netbox-url>/extras/reports/`.
You can also add any other report to this 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/