edgeuno · jaaruizgu · Feb 27, 2023 · Feb 27, 2023 · Mar 1, 2023 · Mar 1, 2023
diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml
@@ -0,0 +1,32 @@
+name: Upload Python Package
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel build
+
+    - name: Build distributable
+      run: |
+        python -m build
+
+    - name: Publish a Python distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/README.md b/README.md
@@ -1,20 +1,32 @@
-<p align="center">
-  <img width="532" src="https://github.com/N-Multifibra/proxbox/blob/main/etc/img/proxbox-full-logo.png" alt="Proxbox logo">
-</p>
+<div align="center">
+	<a href="https://docs.netbox.dev.br/en/netbox/plugins/netbox-proxbox">
+		<img width="532" src="https://github.com/N-Multifibra/proxbox/blob/main/etc/img/proxbox-full-logo.png" alt="Proxbox logo">
+	</a>
+	<br>
+
+<div>
+
+### [New Documentation available!](https://docs.netbox.dev.br/en/netbox/plugins/netbox-proxbox)
+</div>
+<br>
+</div>
 
 
-# proxbox (In Development!)
-**NOTE:** Although the Proxbox plugin is in development, it only use GET requests and there is no risk to harm your Proxmox environment by changing things incorrectly.
 
-Netbox plugin which integrates Proxmox and Netbox using proxmoxer and pynetbox.
 
-It is currently able to get the following information from Proxmox:
+## Netbox Plugin which integrates [Proxmox](https://www.proxmox.com/) and [Netbox](https://netbox.readthedocs.io/)!
 
-- Cluster name
-- Nodes:
+> **NOTE:** Although the Proxbox plugin is in development, it only use **GET requests** and there is **no risk to harm your Proxmox environment** by changing things incorrectly.
+
+<br>
+
+Proxbox is currently able to get the following information from Proxmox:
+
+- **Cluster name**
+- **Nodes:**
   - Status (online / offline)
   - Name
-- Virtual Machines and Containers:
+- **Virtual Machines and Containers:**
   - Status (online / offline)
   - Name
   - ID
@@ -23,22 +35,34 @@ It is currently able to get the following information from Proxmox:
   - Memory
   - Node (Server)
 
+---
+
+<div align="center">
+
 ### Versions
+
+
 The following table shows the Netbox and Proxmox versions compatible (tested) with Proxbox plugin.
 
 | netbox version        | proxmox version          | proxbox version
 | ------------- |-------------|-------------|
-| >= 2.10.9 | >= v6.2.0 | v0.0.3
+| >= v3.2.0 | >= v6.2.0 | =v0.0.4
+| >= v3.0.0 < v3.2| >= v6.2.0 | =v0.0.3
+
+
+</div>
 
 ---
 
 ### Summary
 [1. Installation](#1-installation)
 - [1.1. Install package](#11-install-package)
-  - [1.1.1. Using pip (production use)](#111-using-pip-production-use)
+  - [1.1.1. Using pip (production use)](#111-using-pip-production-use---not-working-yet)
   - [1.1.2. Using git (development use)](#112-using-git-development-use)
 - [1.2. Enable the Plugin](#12-enable-the-plugin)
 - [1.3. Configure Plugin](#13-configure-plugin)
+  - [1.3.1. Change Netbox 'configuration.py' to add PLUGIN parameters](#131-change-netbox-configurationpy-to-add-plugin-parameters)
+  - [1.3.2. Change Netbox 'settings.py' to include Proxbox Template directory](#132-change-netbox-settingspy-to-include-proxbox-template-directory)
 - [1.4. Run Database Migrations](#14-run-database-migrations)
 - [1.5 Restart WSGI Service](#15-restart-wsgi-service)
 
@@ -66,7 +90,7 @@ The plugin is available as a Python package in pypi and can be installed with pi
 
 ### 1.1. Install package
 
-#### 1.1.1. Using pip (production use - not working yet!)
+#### 1.1.1. Using pip (production use)
 
 Enter Netbox's virtual environment.
 ```
@@ -88,7 +112,7 @@ cd /opt/netbox/netbox
 
 Clone netbox-proxbox repository
 ```
-git clone https://github.com/N-Multifibra/netbox-proxbox.git
+git clone https://github.com/netdevopsbr/netbox-proxbox.git
 ```
 
 Install netbox-proxbox
@@ -98,6 +122,7 @@ source /opt/netbox/venv/bin/activate
 python3 setup.py develop
 ```
 
+---
 
 ### 1.2. Enable the Plugin
 
@@ -106,8 +131,11 @@ Enable the plugin in **/opt/netbox/netbox/netbox/configuration.py**:
 PLUGINS = ['netbox_proxbox']
 ```
 
+---
+
 ### 1.3. Configure Plugin
 
+#### 1.3.1. Change Netbox '**[configuration.py](https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/configuration.example.py)**' to add PLUGIN parameters
 The plugin's configuration is also located in **/opt/netbox/netbox/netbox/configuration.py**:
 
 Replace the values with your own following the [Configuration Parameters](#configuration-parameters) section.
@@ -119,8 +147,8 @@ PLUGINS_CONFIG = {
         'proxmox': {
             'domain': 'proxbox.example.com',    # May also be IP address
             'http_port': 8006,
-            'user': 'root@pam',
-            'password': 'Strong@P4ssword',
+            'user': 'root@pam',   # always required
+            'password': 'Strong@P4ssword', # only required, if you don't want to use token based authentication
             'token': {
                 'name': 'tokenID',	# Only type the token name and not the 'user@pam:tokenID' format
                 'value': '039az154-23b2-4be0-8d20-b66abc8c4686'
@@ -141,13 +169,97 @@ PLUGINS_CONFIG = {
     }
 ```
 
+<br>
+
+#### 1.3.2. Change Netbox '**[settings.py](https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/settings.py)**' to include Proxbox Template directory
+
+> Probably on the next release of Netbox, it will not be necessary to make the configuration below! As the [Pull Request #8733](https://github.com/netbox-community/netbox/pull/8734) got merged to develop branch
+
+Edit **/opt/netbox/netbox/netbox** and find TEMPLATE_DIR section
+
+<div align=center>
+
+### How it is configured by default (Netbox >= v3.2.0):
+</div>
+
+```python
+TEMPLATES_DIR = BASE_DIR + '/templates'
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [TEMPLATES_DIR],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'builtins': [
+                'utilities.templatetags.builtins.filters',
+                'utilities.templatetags.builtins.tags',
+            ],
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.template.context_processors.media',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+                'netbox.context_processors.settings_and_registry',
+            ],
+        },
+    },
+]
+```
+
+<br>
+
+<div align=center>
+
+### How it MUST be configured to Proxbox work:
+</div>
+
+```python
+TEMPLATES_DIR = BASE_DIR + '/templates'
+
+# PROXBOX CUSTOM TEMPLATE
+PROXBOX_TEMPLATE_DIR = BASE_DIR + '/netbox-proxbox/netbox_proxbox/templates/netbox_proxbox'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [TEMPLATES_DIR, PROXBOX_TEMPLATE_DIR],  # <--- IMPORTANT
+	# The Parameters below is equal to default Netbox config						       
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'builtins': [
+                'utilities.templatetags.builtins.filters',
+                'utilities.templatetags.builtins.tags',
+            ],
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.template.context_processors.media',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+                'netbox.context_processors.settings_and_registry',
+            ],
+        },
+    },
+]
+```
+
+### Example of error if not configuring the code above on `settings.py`
+![image](https://user-images.githubusercontent.com/24397251/167919319-00c67a81-0679-4114-a66d-3e294b3ae28c.png)
+
+I did it because I had to change the **base/layout.html** from Netbox, since there is no **Jinja2 block** to fill with custom information into the **footer HTML tag**
+
+---
+
 ### 1.4. Run Database Migrations
 
 ```
 (venv) $ cd /opt/netbox/netbox/
 (venv) $ python3 manage.py migrate
 ```
 
+---
+
 ### 1.5. Restart WSGI Service
 
 Restart the WSGI service to load the new plugin:
@@ -190,7 +302,7 @@ The following options are available:
 To get Proxmox ID, Node and Type information, is necessary to configure Custom Fields.
 Below the parameters needed to make it work:
 
----
+<br>
 
 ### 3.1. Custom Field Configuration
 
@@ -206,7 +318,7 @@ Optional values (may be different)
 - [Custom Field] **Label:** [Proxmox] ID
 - [Custom Field] **Description:** Proxmox VM/CT ID
 
----
+<br>
 
 #### 3.1.2. Proxmox Node
 
@@ -219,7 +331,7 @@ Optional values (may be different)
 - [Custom Field] **Label:** [Proxmox] Node
 - [Custom Field] **Description:** Proxmox Node (Server)
 
----
+<br>
 
 #### 3.1.3. Proxmox Type (qemu or lxc)
 
@@ -233,7 +345,7 @@ Optional values (may be different)
 - [Custom Field] **Label:** [Proxmox] Type
 - [Custom Field] **Description:** Proxmox type (VM or CT)
 
----
+<br>
 
 ### 3.2. Custom Field Example
 
@@ -258,9 +370,11 @@ Developing tools for this project based on [ntc-netbox-plugin-onboarding](https:
 
 Issues and pull requests are welcomed.
 
+---
+
 ## 6. Roadmap
 - Start using custom models to optimize the use of the Plugin and stop using 'Custom Fields'
-- Automatically remove Nodes on Netbox when removed on Promox (as it already happens with Virutal Machines and Containers)
+- Automatically remove Nodes on Netbox when removed on Promox (as it already happens with Virtual Machines and Containers)
 - Add individual update of VM/CT's and Nodes (currently is only possible to update all at once)
 - Add periodic update of the whole environment so that the user does not need to manually click the update button.
 - Create virtual machines and containers directly on Netbox, having no need to access Proxmox.

diff --git a/netbox_proxbox/__init__.py b/netbox_proxbox/__init__.py
@@ -5,7 +5,7 @@ class ProxboxConfig(PluginConfig):
     name = "netbox_proxbox"
     verbose_name = "Proxbox"
     description = "Integrates Proxmox and Netbox"
-    version = "0.0.3"
+    version = "0.0.5-beta1"
     author = "Emerson Felipe (@emersonfelipesp)"
     author_email = "[email protected]"
     base_url = "proxbox"

diff --git a/netbox_proxbox/navigation.py b/netbox_proxbox/navigation.py
@@ -3,20 +3,23 @@
 
 menu_items = (
     PluginMenuItem(
-        link="plugins:netbox_proxbox:proxmoxvm_list",
-        link_text="Proxmox VM/CT",
-        buttons=(
-            PluginMenuButton(
-                # match the names of the path for create view defined in ./urls.py
-                link="plugins:netbox_proxbox:proxmoxvm_add",
-                # text that appears when hovering the ubtton
-                title="Add",
-                # font-awesome icon to use
-                icon_class="mdi mdi-plus-thick", # 'fa fa-plus' didn't work
-                # defines color button to green
-                color=ButtonColorChoices.GREEN,
-                permissions=["netbox_proxbox.add_proxmoxvm"],
-            ),
-        ),
+        link="plugins:netbox_proxbox:home",
+        link_text="Home",
     ),
 )
+
+'''
+buttons=(
+    PluginMenuButton(
+        # match the names of the path for create view defined in ./urls.py
+        link="plugins:netbox_proxbox:proxmoxvm_add",
+        # text that appears when hovering the ubtton
+        title="Add",
+        # font-awesome icon to use
+        icon_class="mdi mdi-plus-thick", # 'fa fa-plus' didn't work
+        # defines color button to green
+        color=ButtonColorChoices.GREEN,
+        permissions=["netbox_proxbox.add_proxmoxvm"],
+    ),
+),
+'''