# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-netbox-config-backup
VERSION=		2.2.2
KEYWORDS=		python
VARIANTS=		v13 v14
SDESC[v13]=		NetBox Switch Configuration Backup Plugin (3.13)
SDESC[v14]=		NetBox Switch Configuration Backup Plugin (3.14)
HOMEPAGE=		https://github.com/dansheps/netbox-config-backup
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPIWHL/7e/79/0fd6907db00bc2d3f6d98f21749ebb86495817fec1f875ab2f3c37f5f23d
DISTFILE[1]=		netbox_config_backup-2.2.2-py3-none-any.whl:main
DIST_SUBDIR=		python-src
DF_INDEX=		1
SPKGS[v13]=		single
SPKGS[v14]=		single

OPTIONS_AVAILABLE=	PY313 PY314
OPTIONS_STANDARD=	none
VOPTS[v13]=		PY313=ON PY314=OFF
VOPTS[v14]=		PY313=OFF PY314=ON

DISTNAME=		netbox_config_backup-2.2.2.dist-info

GENERATED=		yes

[PY313].RUN_DEPENDS_ON=			python-netbox-napalm-plugin:single:v13
					python-netmiko:single:v13
					python-napalm:single:v13
					python-uuid:single:v13
					python-dulwich:single:v13
					python-PyDriller:single:v13
					python-deepdiff:single:v13
[PY313].USES_ON=			python:v13,wheel

[PY314].RUN_DEPENDS_ON=			python-netbox-napalm-plugin:single:v14
					python-netmiko:single:v14
					python-napalm:single:v14
					python-uuid:single:v14
					python-dulwich:single:v14
					python-PyDriller:single:v14
					python-deepdiff:single:v14
[PY314].USES_ON=			python:v14,wheel

[FILE:1996:descriptions/desc.single]
# Netbox Configuration Backup

A configuration backup system using netbox and napalm to backup devices
into a git repository

# Features

* Connects to any device that supports napalm and provides both a running
configuration and startup configuration
* Stores backups in a git repository
* Runs as a scheduled task through Django RQ
* Only displays backups with changes
* Provides both configuration download and diffs for point-in-time backups

# Future

* Allow github repositories
* Add job "discovery" based on specific criteria (napalm enabled, device
role switch, has primary ip as an example)
* Add RQ job to ensure all backups are queued
* Allow manual queueing of job
* Add API endpoint to trigger backup
* Add signal(s) to trigger backup

# Installation

1. Install from PyPI (`pip install netbox-config-backup`)
   1. This should install `netbox_napalm_plugin` which is also required
2. Edit netbox configuration:
```pyython
PLUGINS = [
    'netbox_config_backup',
    # Other plugins here
]

PLUGINS_CONFIG = {
    'netbox_config_backup': {
        # Parent folder must exist and be writable by your RQ worker and
readable by the WSGI process
        'repository': '/path/to/git/repository',
        'committer': 'User <email>',
        'author': 'User <email>',
        # Freqency of backups in seconds, can be anywhere 0+ (Recommended
is 1800 (30 minutes) or 3600 (1 hr)
        'frequency': 3600
    }
}
```
3. Migrate: `python3 netbox/manage.py migrate`
4. Create appropriate Napalm configurations for all devices you will be
backing up
5. Create your first device backup

### Cleanup Old Version

If you are coming from an older version, please remove the custom RQ worker
as it is no longer required

## Logging

To enable logging, add the following to your configuration.py under
LOGGING:

```python
        'netbox_config_backup': {
            'handlers': ['enter_your_handlers_here'],
            'level': 'desired_log_level',
            'propagate': True,
        },
```


[FILE:133:distinfo]
b988a5e46cca3bc5e4a99c089f170115d22d205d7bd1e76f01fc9519fc9e5ec0        67043 python-src/netbox_config_backup-2.2.2-py3-none-any.whl