# NetBox Attachments Plugin
[Netbox](https://github.com/netbox-community/netbox) plugin for attaching files to any model.
## Features
This plugin provide following Models:
- NetBoxAttachment
## Compatibility
| Netbox | Plugin |
| -------- | --------------- |
| >= 3.3.4 | 0.0.0 <-> 0.0.5 |
| >= 3.4.0 | 0.0.6 <-> 1.0.6 |
| >= 3.4.3 | 1.0.7 <-> 1.1.X |
| >= 3.5.0 | 2.0.0 |
| >= 3.6.0 | 3.0.0 |
| >= 3.7.0 | 4.0.0
## Installation
The plugin is available as a Python package in pypi and can be installed with pip
```
pip install netbox-attachments
```
Enable the plugin in `configuration.py`:
```
PLUGINS = ['netbox_attachments']
```
Restart NetBox and add `netbox-attachments` to your local_requirements.txt
See [NetBox Documentation](https://docs.netbox.dev/en/stable/plugins/#installing-plugins) for details
## Configuration
The following options are available:
- `apps`:
- **Type**: List
- **Default**: ['dcim', 'ipam', 'circuits', 'tenancy', 'virtualization', 'wireless']
- **Description**: Display `Attachments` feature on all models definded under the app label. Attachmets are displayed on `right_page` of the detail-view of model.
- `display_default`:
- **Type**: String
- **Default**: "additional_tab"
- **Options**: "left_page", "right_page", "full_width_page", "additional_tab"
- **Description**: Setup default setting of where attachments should be displayed under the models
- `display_setting`:
- **Type**: Dict
- **Default**: {}
- **Options**: {<app_label.model>: <prefeered_display>}
- **Example**: {'dcim.devicerole': 'full_width_page', 'dcim.device': 'left_page', 'ipam.vlan': 'additional_tab'}
- **Description**: Set display setting for concrete model
- **Tip**: Proper `app_label` and `model` names could be found at API `<your_netbox_url>/api/extras/content-types/`
> **Warning**
> `additional_tab` does not work for Plugin models
### Configuration Example:
```
PLUGINS_CONFIG = {
'netbox_attachments': {
'apps': ['dcim', 'ipam', 'circuits', 'tenancy', 'virtualization', 'wireless', 'inventory_monitor'],
'display_default': "right_page",
'display_setting': {'ipam.vlan': "left_page", 'dcim.device': "full_width_page", 'dcim.devicerole': "full_width_page", 'inventory_monitor.probe': "additional_tab"}
}
}
```
## Enable Attachments for custom plugin (models)
- Append your plugin to configuration list
- `apps`: ['<plugin_name>']
- Extend detail templates
- ```
# At the TOP
{% load plugins %}
# Under a comments section
{% plugin_right_page object %}
# add the left_page and full_width for future extension
```
* Example (device - core model):
- [load](https://github.com/netbox-community/netbox/blob/c1b7f09530f0293d0f053b8930539b1d174cd03b/netbox/templates/dcim/device.html#L6)
- [left_page](https://github.com/netbox-community/netbox/blob/c1b7f09530f0293d0f053b8930539b1d174cd03b/netbox/templates/dcim/device.html#L149)
- [right_page](https://github.com/netbox-community/netbox/blob/c1b7f09530f0293d0f053b8930539b1d174cd03b/netbox/templates/dcim/device.html#L288)
- [full_with_page](https://github.com/netbox-community/netbox/blob/c1b7f09530f0293d0f053b8930539b1d174cd03b/netbox/templates/dcim/device.html#L293)
## Screenshots
- Model View
- List View
- Detail View
Raw data
{
"_id": null,
"home_page": "https://github.com/Kani999/netbox-attachments",
"name": "netbox-attachments",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "netbox,netbox-plugin",
"author": "Jan Krupa",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/63/db/c38d3b9cbf2e94ab934be7241ed61324893ea5612bc4235dd3fd4862c0e4/netbox-attachments-4.0.2.tar.gz",
"platform": null,
"description": "# NetBox Attachments Plugin\n\n[Netbox](https://github.com/netbox-community/netbox) plugin for attaching files to any model.\n\n## Features\n\nThis plugin provide following Models:\n\n- NetBoxAttachment\n\n## Compatibility\n\n| Netbox | Plugin |\n| -------- | --------------- |\n| >= 3.3.4 | 0.0.0 <-> 0.0.5 |\n| >= 3.4.0 | 0.0.6 <-> 1.0.6 |\n| >= 3.4.3 | 1.0.7 <-> 1.1.X |\n| >= 3.5.0 | 2.0.0 |\n| >= 3.6.0 | 3.0.0 |\n| >= 3.7.0 | 4.0.0 \n\n## Installation\n\nThe plugin is available as a Python package in pypi and can be installed with pip\n\n```\npip install netbox-attachments\n```\n\nEnable the plugin in `configuration.py`:\n\n```\nPLUGINS = ['netbox_attachments']\n```\n\nRestart NetBox and add `netbox-attachments` to your local_requirements.txt\n\nSee [NetBox Documentation](https://docs.netbox.dev/en/stable/plugins/#installing-plugins) for details\n\n## Configuration\n\nThe following options are available:\n\n- `apps`:\n - **Type**: List\n - **Default**: ['dcim', 'ipam', 'circuits', 'tenancy', 'virtualization', 'wireless']\n - **Description**: Display `Attachments` feature on all models definded under the app label. Attachmets are displayed on `right_page` of the detail-view of model.\n- `display_default`:\n - **Type**: String\n - **Default**: \"additional_tab\"\n - **Options**: \"left_page\", \"right_page\", \"full_width_page\", \"additional_tab\"\n - **Description**: Setup default setting of where attachments should be displayed under the models\n- `display_setting`:\n - **Type**: Dict\n - **Default**: {}\n - **Options**: {<app_label.model>: <prefeered_display>}\n - **Example**: {'dcim.devicerole': 'full_width_page', 'dcim.device': 'left_page', 'ipam.vlan': 'additional_tab'}\n - **Description**: Set display setting for concrete model\n - **Tip**: Proper `app_label` and `model` names could be found at API `<your_netbox_url>/api/extras/content-types/`\n\n> **Warning**\n> `additional_tab` does not work for Plugin models\n\n### Configuration Example:\n\n```\nPLUGINS_CONFIG = {\n 'netbox_attachments': {\n 'apps': ['dcim', 'ipam', 'circuits', 'tenancy', 'virtualization', 'wireless', 'inventory_monitor'],\n 'display_default': \"right_page\",\n 'display_setting': {'ipam.vlan': \"left_page\", 'dcim.device': \"full_width_page\", 'dcim.devicerole': \"full_width_page\", 'inventory_monitor.probe': \"additional_tab\"}\n }\n}\n```\n\n## Enable Attachments for custom plugin (models)\n\n- Append your plugin to configuration list\n - `apps`: ['<plugin_name>']\n- Extend detail templates\n - ```\n # At the TOP\n {% load plugins %}\n # Under a comments section\n {% plugin_right_page object %}\n # add the left_page and full_width for future extension\n ```\n * Example (device - core model):\n - [load](https://github.com/netbox-community/netbox/blob/c1b7f09530f0293d0f053b8930539b1d174cd03b/netbox/templates/dcim/device.html#L6)\n - [left_page](https://github.com/netbox-community/netbox/blob/c1b7f09530f0293d0f053b8930539b1d174cd03b/netbox/templates/dcim/device.html#L149)\n - [right_page](https://github.com/netbox-community/netbox/blob/c1b7f09530f0293d0f053b8930539b1d174cd03b/netbox/templates/dcim/device.html#L288)\n - [full_with_page](https://github.com/netbox-community/netbox/blob/c1b7f09530f0293d0f053b8930539b1d174cd03b/netbox/templates/dcim/device.html#L293)\n\n## Screenshots\n\n- Model View\n \n- List View\n \n- Detail View\n \n",
"bugtrack_url": null,
"license": "",
"summary": "Netbox plugin to manage attachments for any model",
"version": "4.0.2",
"project_urls": {
"Homepage": "https://github.com/Kani999/netbox-attachments"
},
"split_keywords": [
"netbox",
"netbox-plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b66fc52871229953bd0bf15cb5143629c63320212e2280767eabd59526d3094",
"md5": "f08e523769f0ffd5433f369444267b4b",
"sha256": "610d17df61e5b65b62f1c3305292c66c291549c67169d28148a29badff5db308"
},
"downloads": -1,
"filename": "netbox_attachments-4.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f08e523769f0ffd5433f369444267b4b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20100,
"upload_time": "2024-02-19T14:23:26",
"upload_time_iso_8601": "2024-02-19T14:23:26.843555Z",
"url": "https://files.pythonhosted.org/packages/3b/66/fc52871229953bd0bf15cb5143629c63320212e2280767eabd59526d3094/netbox_attachments-4.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "63dbc38d3b9cbf2e94ab934be7241ed61324893ea5612bc4235dd3fd4862c0e4",
"md5": "b9e40290d5b9325937cf6bf94f2cf3a4",
"sha256": "9ec508c238884bc79f88a62f8bad8792384a26fe200e6e3783d1fcf1515d5746"
},
"downloads": -1,
"filename": "netbox-attachments-4.0.2.tar.gz",
"has_sig": false,
"md5_digest": "b9e40290d5b9325937cf6bf94f2cf3a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 13525,
"upload_time": "2024-02-19T14:23:51",
"upload_time_iso_8601": "2024-02-19T14:23:51.896699Z",
"url": "https://files.pythonhosted.org/packages/63/db/c38d3b9cbf2e94ab934be7241ed61324893ea5612bc4235dd3fd4862c0e4/netbox-attachments-4.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-19 14:23:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Kani999",
"github_project": "netbox-attachments",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "netbox-attachments"
}
JSON
