From a517ae2aa6d33a2752c7ac4e30bfec787cc060a5 Mon Sep 17 00:00:00 2001 From: "J.I. /podhead" <117015142+ji-podhead@users.noreply.github.com> Date: Wed, 13 Nov 2024 10:26:22 +0100 Subject: [PATCH 1/5] Create static.yml --- .github/workflows/static.yml | 44 ++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .github/workflows/static.yml diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml new file mode 100644 index 0000000..fbf2c36 --- /dev/null +++ b/.github/workflows/static.yml @@ -0,0 +1,44 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy static content to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: '.docs/build/html' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 + From 8e29ca6fb563677507a19324c60c664e5e080324 Mon Sep 17 00:00:00 2001 From: "J.I. /podhead" <117015142+ji-podhead@users.noreply.github.com> Date: Wed, 13 Nov 2024 10:28:06 +0100 Subject: [PATCH 2/5] Update static.yml --- .github/workflows/static.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml index fbf2c36..c9cf45e 100644 --- a/.github/workflows/static.yml +++ b/.github/workflows/static.yml @@ -37,7 +37,7 @@ jobs: uses: actions/upload-pages-artifact@v3 with: # Upload entire repository - path: '.docs/build/html' + path: '.' - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4 From 6e78bfd9bd569ec395fcfe612db7fafd4a751ec1 Mon Sep 17 00:00:00 2001 From: "J.I. /podhead" <117015142+ji-podhead@users.noreply.github.com> Date: Wed, 13 Nov 2024 10:56:46 +0100 Subject: [PATCH 3/5] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index b94167c..0a9b4c9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # opnsense-helper + +| ![Static Badge](https://img.shields.io/badge/Api%20Docs-%F0%9F%93%9A-blue?link=https%3A%2F%2Fji-podhead.github.io%2Fopnsense-helper%2F.docs%2F_build%2Fhtml%2Findex.html) | ![PyPI - Version](https://img.shields.io/pypi/v/opnsense-helper?logo=https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fthumb%2Fc%2Fc3%2FPython-logo-notext.svg%2F1869px-Python-logo-notext.svg.png&link=https%3A%2F%2Fpypi.org%2Fproject%2Fopnsense-helper%2F) |![Static Badge](https://img.shields.io/badge/Ansible%20Collection-%F0%9F%9A%A7-red) | + - create, assign and enable lan / phy interfaces and all the other stuff that is ***Not enabled*** in the opnsense api - use the config_manager to apply all your configs in runtime at once - uses the opnsense backend via shh From e05fa6f2f88a1ac0f0f249257802b4a785134ae0 Mon Sep 17 00:00:00 2001 From: "J.I. /podhead" <117015142+ji-podhead@users.noreply.github.com> Date: Wed, 13 Nov 2024 11:24:51 +0100 Subject: [PATCH 4/5] Update README.md --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0a9b4c9..1c6721d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ # opnsense-helper - -| ![Static Badge](https://img.shields.io/badge/Api%20Docs-%F0%9F%93%9A-blue?link=https%3A%2F%2Fji-podhead.github.io%2Fopnsense-helper%2F.docs%2F_build%2Fhtml%2Findex.html) | ![PyPI - Version](https://img.shields.io/pypi/v/opnsense-helper?logo=https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fthumb%2Fc%2Fc3%2FPython-logo-notext.svg%2F1869px-Python-logo-notext.svg.png&link=https%3A%2F%2Fpypi.org%2Fproject%2Fopnsense-helper%2F) |![Static Badge](https://img.shields.io/badge/Ansible%20Collection-%F0%9F%9A%A7-red) | - + + + + + + +
+ +Static Badge + + PyPI - Version + + + Static Badge +
+ - create, assign and enable lan / phy interfaces and all the other stuff that is ***Not enabled*** in the opnsense api - use the config_manager to apply all your configs in runtime at once - uses the opnsense backend via shh @@ -9,6 +22,7 @@ - around 80 opnsense scripts you can call - automatically configures your Vlan and Phy Interfaces after applying configuration + ## install ## pip ```bash @@ -16,6 +30,7 @@ pip install opnsense-helper ``` ## usage > you can run the provided snippets directly by pulling the [example file](https://github.com/the-pod-shop/opnsense-helper/blob/main/python/examples/add_vlans.py) +> Please se the [Api Docs](https://ji-podhead.github.io/opnsense-helper/.docs/_build/html/index.html), the corresponding [pip package](https://pypi.org/project/opnsense-helper/) site and soon also the Ansible collection. ### required variables * import the package and define the needed variables for the main class From 756ca87761d52455b6de04d58e247c8f08cf7003 Mon Sep 17 00:00:00 2001 From: "J.I. /podhead" <117015142+ji-podhead@users.noreply.github.com> Date: Wed, 13 Nov 2024 11:28:40 +0100 Subject: [PATCH 5/5] Update README.md --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1c6721d..ce374dd 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ @@ -29,8 +29,11 @@ pip install opnsense-helper ``` ## usage -> you can run the provided snippets directly by pulling the [example file](https://github.com/the-pod-shop/opnsense-helper/blob/main/python/examples/add_vlans.py) -> Please se the [Api Docs](https://ji-podhead.github.io/opnsense-helper/.docs/_build/html/index.html), the corresponding [pip package](https://pypi.org/project/opnsense-helper/) site and soon also the Ansible collection. +> - you can run the provided snippets directly by pulling the [example file](https://github.com/the-pod-shop/opnsense-helper/blob/main/python/examples/add_vlans.py) +> - Please also have a look at: +> - the [Api Docs](https://ji-podhead.github.io/opnsense-helper/.docs/_build/html/index.html) +> - the corresponding [pip package](https://pypi.org/project/opnsense-helper/) +> - and soon also the Ansible collection. ### required variables * import the package and define the needed variables for the main class
- + Static Badge - + PyPI - Version