Contributions are welcome, and they are greatly appreciated! Every little bit +helps, and credit will always be given.
+You can contribute in many ways:
+Report bugs at https://github.com/miaow2/netbox-config-diff/issues.
+If you are reporting a bug, please include:
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help +wanted" is open to whoever wants to implement it.
+Look through the GitHub issues for features. Anything tagged with "enhancement" +and "help wanted" is open to whoever wants to implement it.
+NetBox Config Diff Plugin could always use more documentation, whether as part of the +official NetBox Config Diff Plugin docs, in docstrings, or even on the web in blog posts, +articles, and such.
+The best way to send feedback is to file an issue at https://github.com/miaow2/netbox-config-diff/issues.
+If you are proposing a feature:
+Ready to contribute? Here's how to set up netbox-config-diff for local development.
netbox-config-diff repo on GitHub.Clone your fork locally
+$ git clone git@github.com:your_name_here/netbox-config-diff.git
Install dependencies and start your virtualenv:
+$ poetry install -E test -E doc -E dev
Create a branch for local development:
+$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
+When you're done making changes, check that your changes pass the + tests, including testing other Python versions, with tox:
+$ poetry run tox
Commit your changes and push your branch to GitHub:
+$ git add .
+$ git commit -m "Your detailed description of your changes."
+$ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
+Before you submit a pull request, check that it meets these guidelines:
+A reminder for the maintainers on how to deploy. +Make sure all your changes are committed (including an entry in CHANGELOG.md). +Then run:
+$ poetry run bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+GitHub Actions will then deploy to PyPI if tests pass.
+ + + + + + +With this plugin you can find diff between the rendered configuration for a device to its actual configuration, retrieved from the device itself, or stored in DataSource. +Read about DataSources for further details.
+Device configuration renders natively in NetBox. This feature was introduced in 3.5 version. + NetBox Labs blog post about it.
+Plugin supports a wide list of vendors (Cisco, Juniper, Huawei, MicroTik etc.) with the help of Scrapli. Read Scrapli and scrapli-community documentations to find full list of vendors.
+ + + + +For adding to a NetBox Docker setup see +the general instructions for using netbox-docker with plugins.
+Install with pip:
+pip install netbox-config-diff
+Add to local_requirements.txt:
echo netbox-config-diff >> local_requirements.txt
+Enable the plugin in /opt/netbox/netbox/netbox/configuration.py,
+ or if you use netbox-docker, your /configuration/plugins.py file,
+ and define credentials for devices connection:
PLUGINS = [
+ "netbox_config_diff",
+]
+
+PLUGINS_CONFIG = {
+ "netbox_config_diff": {
+ "USERNAME": "foo",
+ "PASSWORD": "bar",
+ },
+}
+Run database migrations:
+python manage.py migrate
+
+Collect static from the plugin:
+python manage.py collectstatic --noinput
+Restart NetBox service:
+systemctl restart netbox
+Read this doc to find out how to use plugin
+ + + + + + +UqUCtKa)B0fZ9Wr3jtGi`J{CFsBWk@=Ol-)dtqFo#KGSmR|ot=Kf`S{VFUQC60
zL_IA%O)7H9GFTuaarEHMb8p6@zPcs_K(HS1A+A`*e1Uo`$3XX6@yKR|*DDCr6}$4L
z;h^}GnG~OBZX