From 1f565df6b705fd616c511ea21dc5259533540ea4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Wed, 9 Oct 2019 12:18:28 +0200 Subject: [PATCH] Copied over the relevant parts from the README --- Custom-Reports.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 Custom-Reports.md diff --git a/Custom-Reports.md b/Custom-Reports.md new file mode 100644 index 0000000..8a8508d --- /dev/null +++ b/Custom-Reports.md @@ -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 `/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/ \ No newline at end of file