Skip to main content

Manage documents in Netbox

Project description

Netbox GED

A plugin designed to faciliate the storage of documents within NetBox
Re-written from the original Netbox Documents

WARNING

THIS PLUGIN IS NOT COMPATIBLE WITH NETBOX DOCUMENTS
I don't want to break your existing documents, so please don't install this plugin if you have documents stored in the original plugin.

A migration script will, perhaps one day, made available, but for now you will need to manually migrate your documents.

Features

  • Store documents against all NetBox models
  • Sort documents with tags and customisable types
  • Supports a wide array of common file types

Compatibility

NetBox Version Plugin Version
3.2+ 0.2.1

Installation

A working installation of Netbox 3.2+ is required. 3.4+ is recommended.

Package Installation from PyPi

Activate your virtual env and install via pip:

$ source /opt/netbox/venv/bin/activate
(venv) $ pip install netbox-ged

To ensure the Netbox Documents plugin is automatically re-installed during future upgrades, add the package to your local_requirements.txt :

# echo netbox-ged >> local_requirements.txt

Enable the Plugin

In the Netbox configuration.py configuration file add or update the PLUGINS parameter, adding netbox_documents:

PLUGINS = [
    'netbox_ged',
]

Apply Database Migrations

Apply database migrations with Netbox manage.py:

(venv) $ python manage.py migrate

Restart Netbox

Restart the Netbox service to apply changes:

sudo systemctl restart netbox

Screenshots

Coming soon

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox_ged-0.2.1.tar.gz (22.8 kB view hashes)

Uploaded Source

Built Distribution

netbox_ged-0.2.1-py3-none-any.whl (26.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page