# Netbox GED
A plugin designed to faciliate the storage of documents within [NetBox](https://github.com/netbox-community/netbox)
Re-written from the original [Netbox Documents](https://github.com/jasonyates/netbox-documents/)
## WARNING
THIS PLUGIN IS NOT COMPATIBLE WITH _NETBOX DOCUMENTS_
We 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.1.0 |
## 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` :
```no-highlight
# 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`:
```python
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
Raw data
{
"_id": null,
"home_page": "https://github.com/pelt10/netbox-ged",
"name": "netbox-ged",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "netbox,netbox-plugin,plugin",
"author": "LE THIEC Pierre-Emmanuel",
"author_email": "contact@lethoiec.me",
"download_url": "https://files.pythonhosted.org/packages/c0/79/7ff5042becc8670178a16b50a6a977d8b707550bcae3888909a99e985e4d/netbox_ged-0.1.1.tar.gz",
"platform": null,
"description": "# Netbox GED\n\nA plugin designed to faciliate the storage of documents within [NetBox](https://github.com/netbox-community/netbox) \nRe-written from the original [Netbox Documents](https://github.com/jasonyates/netbox-documents/)\n\n## WARNING\nTHIS PLUGIN IS NOT COMPATIBLE WITH _NETBOX DOCUMENTS_ \nWe don't want to break your existing documents, so please don't install this plugin if you have documents stored in the original plugin.\n\nA migration script will, perhaps one day, made available, but for now you will need to manually migrate your documents.\n\n\n## Features\n\n* Store documents against all NetBox models\n* Sort documents with tags and customisable types\n* Supports a wide array of common file types\n\n\n## Compatibility\n\n| NetBox Version | Plugin Version |\n|----------------|----------------|\n| 3.2+ | 0.1.0 |\n\n\n## Installation\n\nA working installation of Netbox 3.2+ is required. 3.4+ is recommended.\n\n#### Package Installation from PyPi\n\nActivate your virtual env and install via pip:\n\n```\n$ source /opt/netbox/venv/bin/activate\n(venv) $ pip install netbox-ged\n```\n\nTo ensure the Netbox Documents plugin is automatically re-installed during future upgrades, add the package to your `local_requirements.txt` :\n\n```no-highlight\n# echo netbox-ged >> local_requirements.txt\n```\n\n#### Enable the Plugin\n\nIn the Netbox `configuration.py` configuration file add or update the PLUGINS parameter, adding `netbox_documents`:\n\n```python\nPLUGINS = [\n 'netbox_ged',\n]\n```\n\n#### Apply Database Migrations\n\nApply database migrations with Netbox `manage.py`:\n\n```\n(venv) $ python manage.py migrate\n```\n\n#### Restart Netbox\n\nRestart the Netbox service to apply changes:\n\n```\nsudo systemctl restart netbox\n```\n\n### Screenshots\n\nComing soon\n",
"bugtrack_url": null,
"license": "",
"summary": "Manage documents in Netbox",
"version": "0.1.1",
"split_keywords": [
"netbox",
"netbox-plugin",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a8aa8e0b42842c43f53093197bbe2feb85ee89d650f2c62f65ec3bf4c301294e",
"md5": "e707dcaeca74bafbb048aa040f41a054",
"sha256": "dd24124ede7d1f9aa12ebb24f534e0c44c3b134d78f22404777c6dd08f96aa60"
},
"downloads": -1,
"filename": "netbox_ged-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e707dcaeca74bafbb048aa040f41a054",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23874,
"upload_time": "2023-02-08T12:53:58",
"upload_time_iso_8601": "2023-02-08T12:53:58.987243Z",
"url": "https://files.pythonhosted.org/packages/a8/aa/8e0b42842c43f53093197bbe2feb85ee89d650f2c62f65ec3bf4c301294e/netbox_ged-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c0797ff5042becc8670178a16b50a6a977d8b707550bcae3888909a99e985e4d",
"md5": "1eaece507d57c49aa267955f6171e9d1",
"sha256": "35e49568b74edda817936fcfd768947f764b383f461458574b6b1f5e84c2448d"
},
"downloads": -1,
"filename": "netbox_ged-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "1eaece507d57c49aa267955f6171e9d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21463,
"upload_time": "2023-02-08T12:55:14",
"upload_time_iso_8601": "2023-02-08T12:55:14.602145Z",
"url": "https://files.pythonhosted.org/packages/c0/79/7ff5042becc8670178a16b50a6a977d8b707550bcae3888909a99e985e4d/netbox_ged-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-08 12:55:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "pelt10",
"github_project": "netbox-ged",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "netbox-ged"
}
JSON
