From 06bcc68f063aeb3d44f8f33ad714a2a434da7a5a Mon Sep 17 00:00:00 2001 From: Sander Steffann Date: Wed, 15 Apr 2020 15:42:15 +0200 Subject: [PATCH] Fix MANIFEST.in --- MANIFEST.in | 1 + README.md | 26 ++++++++++++++++++++++++-- 2 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 MANIFEST.in diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..487de74 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +recursive-include netbox_ddns/templates *.html diff --git a/README.md b/README.md index 37395c1..0fcb459 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,33 @@ # Dynamic DNS Connector for NetBox -This plugin lets you define DNS servers that support [RFC3007 Dynamic DNS Updates](https://tools.ietf.org/html/rfc3007). For each server you specify which domains and reverse DNS domains it is responsible for, and after that NetBox will automatically send DNS Updates to those servers whenever you change the DNS name of an IP Address in NetBox. +This plugin lets you define DNS servers that support [RFC3007 Dynamic DNS Updates](https://tools.ietf.org/html/rfc3007). +For each server you specify which domains and reverse DNS domains it is responsible for, and after that NetBox will +automatically send DNS Updates to those servers whenever you change the DNS name of an IP Address in NetBox. -Updates are sent from the worker process in the background. You can see their progress either by configuring Django logging or by looking at the Background Tasks in the NetBox admin back-end. +Updates are sent from the worker process in the background. You can see their progress either by configuring Django +logging or by looking at the Background Tasks in the NetBox admin back-end. For now all configuration is done in the NetBox admin back-end. A later version will provide a nicer user interface. ## Compatibility This plugin in compatible with [NetBox](https://netbox.readthedocs.org/) 2.8 and later. + +## Installation + +First, add `netbox-ddns` to your `/opt/netbox/local_requirements.txt` file. Create it if it doesn't exist. + +Then enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`, like: + +```python +PLUGINS = [ + 'netbox_ddns', +] +``` + +And finally run `/opt/netbox/upgrade.sh`. This will download and install the plugin and update the database when +necessary. Don't forget to run `sudo systemctl restart netbox netbox-rq` like `upgrade.sh` tells you! + +## Usage + +You can find the