Merge pull request #108 from anarion80/pull_upstream

🔀 Pull upstream

.github/workflows/ci.yml

@@ -35,6 +35,6 @@ jobs:
         run: yamllint .
 
       - name: Lint docs
-        uses: articulate/actions-markdownlint@v1.1.0
+        uses: articulate/actions-markdownlint@v1
         with:
           version: 0.32.2

.github/workflows/docs-deploy.yml

@@ -13,7 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Lint docs
-        uses: articulate/actions-markdownlint@v1.1.0
+        uses: articulate/actions-markdownlint@v1
         with:
           version: 0.32.2
 

.github/workflows/docs-test.yml

@@ -13,7 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Lint docs
-        uses: articulate/actions-markdownlint@v1.1.0
+        uses: articulate/actions-markdownlint@v1
         with:
           version: 0.32.2
 

.gitignore

@@ -8,6 +8,8 @@ inventories
 roles/bertvv.samba
 roles/geerlingguy.docker
 roles/geerlingguy.nfs
+website/.docusaurus
+website/node_modules
 
 # Vim
 [._]sw[a-p]

CONTRIBUTING.md

@@ -4,7 +4,7 @@ Contributing to Ansible-NAS is easy! Add your functionality, then raise a pull r
 
 ## Development Environment
 
-* Development of Ansible-NAS is carried out in [Visual Studio Code](https://code.visualstudio.com/) on Linux - you'll get some nice recommended extensions and task setups if you do the same.
+* Development of Ansible-NAS is carried out in [JetBrains PyCharm](https://www.jetbrains.com/?from=Ansible-NAS) on Linux - you'll get some nice recommended extensions and task setups if you do the same.
 * You'll need a working Python 3 environment, Docker (to run tests) and [pre-commit](https://pre-commit.com) installed - `pip install -r requirements-dev.txt`.
 
 ## General Stuff

roles/activepieces/docs/activepieces.md

@@ -1,11 +1,11 @@
 # Activepieces
 
-Homepage: <https://www.activepieces.com/>
+Homepage: [https://www.activepieces.com/](https://www.activepieces.com/)
 
 Your friendliest open source all-in-one automation tool ✨ Workflow automation tool 100+ integration / Enterprise automation tool / ChatBot / Zapier Alternative
 
 ## Usage
 
-Set `activepieces_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `activepieces_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-activepieces web interface can be found at <http://ansible_nas_host_or_ip:8129>.
+activepieces web interface can be found at [http://ansible_nas_host_or_ip:8129](http://ansible_nas_host_or_ip:8129).

roles/admidio/docs/admidio.md

@@ -1,11 +1,11 @@
 # Admidio
 
-Homepage: <https://www.admidio.org/>
+Homepage: [https://www.admidio.org/](https://www.admidio.org/)
 
 Admidio is a free open source user management system for websites of organizations and groups. The system has a flexible role model so that it’s possible to reflect the structure and permissions of your organization.
 
 ## Usage
 
-Set `admidio_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `admidio_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-admidio web interface can be found at <http://ansible_nas_host_or_ip:8120>.
+admidio web interface can be found at [http://ansible_nas_host_or_ip:8120](http://ansible_nas_host_or_ip:8120).

roles/authelia/docs/authelia.md

@@ -1,16 +1,16 @@
 # Authelia
 
-Homepage: <https://www.authelia.com/>
+Homepage: [https://www.authelia.com/](https://www.authelia.com/)
 
 Authelia is an open-source authentication and authorization server and portal fulfilling the identity and access management (IAM) role of information security in providing multi-factor authentication and single sign-on (SSO) for your applications via a web portal. It acts as a companion for common reverse proxies.
 
 ## Usage
 
-Set `authelia_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `authelia_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
 Set all `authelia_*` variables in `inventories/<your_inventory>/group_vars/all.yml`.
 
-The authelia web interface can be found at <http://ansible_nas_host_or_ip:9093>.
+The authelia web interface can be found at [http://ansible_nas_host_or_ip:9093](http://ansible_nas_host_or_ip:9093).
 
 ## Specific Configuration
 

roles/authentik/docs/authentik.md

@@ -1,19 +1,19 @@
 # Authentik
 
-Homepage: <https://goauthentik.io>
+Homepage: [https://goauthentik.io](https://goauthentik.io)
 
 authentik is an open-source Identity Provider focused on flexibility and versatility. You can use authentik in an existing environment to add support for new protocols, implement sign-up/recovery/etc. in your application so you don't have to deal with it, and many other things.
 
 ## Usage
 
-Set `authentik_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `authentik_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
 Set all `authentik_*` variables in `inventories/<your_inventory>/group_vars/all.yml`.
 
-The Authentik web interface can be found at <http://ansible_nas_host_or_ip:9001>.
+The Authentik web interface can be found at [http://ansible_nas_host_or_ip:9001](http://ansible_nas_host_or_ip:9001).
 
-To start the initial setup, navigate to <http://ansible_nas_host_or_ip:9001/if/flow/initial-setup/>. There you will be prompted to set a password for the akadmin user.
+To start the initial setup, navigate to [http://ansible_nas_host_or_ip:9001/if/flow/initial-setup/](http://ansible_nas_host_or_ip:9001/if/flow/initial-setup/). There you will be prompted to set a password for the akadmin user.
 
 ## Specific Configuration
 
-Check <https://goauthentik.io/docs/installation/configuration> for full list of configuration options.
+Check [https://goauthentik.io/docs/installation/configuration](https://goauthentik.io/docs/installation/configuration) for full list of configuration options.

roles/barcodebuddy/docs/barcodebuddy.md

@@ -1,13 +1,13 @@
 # Barcode Buddy
 
-Homepage: <https://github.com/Forceu/barcodebuddy/>
+Homepage: [https://github.com/Forceu/barcodebuddy/](https://github.com/Forceu/barcodebuddy/)
 
 Barcode Buddy for Grocy is an extension for Grocy, allowing to pass barcodes to Grocy. It supports barcodes for products and chores. If you own a physical barcode scanner, it can be integrated, so that all barcodes scanned are automatically pushed to BarcodeBuddy/Grocy.
 
 ## Usage
 
-Set `barcodebuddy_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `barcodebuddy_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
 Set all `barcodebuddy_*` variables in `inventories/<your_inventory>/group_vars/all.yml`.
 
-The barcodebuddy web interface can be found at <http://ansible_nas_host_or_ip:9284>.
+The barcodebuddy web interface can be found at [http://ansible_nas_host_or_ip:9284](http://ansible_nas_host_or_ip:9284).

roles/beets/docs/beets.md

@@ -1,11 +1,11 @@
 # Beets
 
-Homepage: <https://beets.io/>
+Homepage: [https://beets.io/](https://beets.io/)
 
 Beets is a music library manager.
 
 ## Usage
 
-Set `beets_enabled: true` in your `inventories/<your_inventory>/nas.yml` file. Set `beets_data_directory`, `beets_music_directory` and `beets_downloads_directory` and execute the playbook.
+Set `beets_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file. Set `beets_data_directory`, `beets_music_directory` and `beets_downloads_directory` and execute the playbook.
 
-The Beets web interface can be found at <http://ansible_nas_host_or_ip:8337>.
+The Beets web interface can be found at [http://ansible_nas_host_or_ip:8337](http://ansible_nas_host_or_ip:8337).

roles/blaze/docs/blaze.md

@@ -1,11 +1,11 @@
 # Blaze
 
-Homepage: <https://github.com/blenderskool/blaze>
+Homepage: [https://github.com/blenderskool/blaze](https://github.com/blenderskool/blaze)
 
 Blaze is a file sharing progressive web app(PWA) that allows users to transfer files between multiple devices. It works similar to SHAREit or the Files app by Google but uses web technologies to eliminate the process of installing native apps for different devices and operating systems. It also supports instant file sharing with multiple devices at once which many file sharing apps lack.
 
 ## Usage
 
-Set `blaze_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `blaze_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-blaze web interface can be found at <http://ansible_nas_host_or_ip:8119>.
+blaze web interface can be found at [http://ansible_nas_host_or_ip:8119](http://ansible_nas_host_or_ip:8119).

roles/blocky/docs/blocky.md

@@ -1,11 +1,11 @@
 # Blocky
 
-Homepage: <https://0xerr0r.github.io/blocky/>
+Homepage: [https://0xerr0r.github.io/blocky/](https://0xerr0r.github.io/blocky/)
 
 Fast and lightweight DNS proxy as ad-blocker for local network with many features
 
 ## Usage
 
-Set `blocky_enabled: true` in your `inventories/<your_inventory>/nas.yml` file. Edit the config file `files/config.yml` according to [Blocky configuration](https://0xerr0r.github.io/blocky/v0.22/configuration/). Run the playbook.
+Set `blocky_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file. Edit the config file `files/config.yml` according to [Blocky configuration](https://0xerr0r.github.io/blocky/v0.22/configuration/). Run the playbook.
 
-Blocky web interface can be found at <http://ansible_nas_host_or_ip:8004>.
+Blocky web interface can be found at [http://ansible_nas_host_or_ip:8004](http://ansible_nas_host_or_ip:8004).

roles/changedetection/docs/changedetection.md

@@ -1,13 +1,13 @@
 # Changedetection.io
 
-Homepage: <https://github.com/dgtlmoon/changedetection.io>
+Homepage: [https://github.com/dgtlmoon/changedetection.io](https://github.com/dgtlmoon/changedetection.io)
 
 The best and simplest self-hosted free open source website change detection, monitor and notification service. Restock Monitor, change detection. Designed for simplicity - the main goal is to simply monitor which websites had a text change for free. Free Open source web page change detection, Restock Monitoring, Visualping and Apify alternative.
 
 ## Usage
 
-Set `changedetection_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `changedetection_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
 Optionally you can enable WebDriver with `changedetection_webdriver_enabled` and Playwright with `changedetection_playwright_enabled`.
 
-changedetection web interface can be found at <http://ansible_nas_host_or_ip:5003>.
+changedetection web interface can be found at [http://ansible_nas_host_or_ip:5003](http://ansible_nas_host_or_ip:5003).

roles/chatpad/docs/chatpad.md

@@ -1,11 +1,11 @@
 # Chatpad
 
-Homepage: <https://chatpad.ai/>
+Homepage: [https://chatpad.ai/](https://chatpad.ai/)
 
 Not just another ChatGPT user-interface!
 
 ## Usage
 
-Set `chatpad_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `chatpad_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-Chatpad web interface can be found at <http://ansible_nas_host_or_ip:8116>.
+Chatpad web interface can be found at [http://ansible_nas_host_or_ip:8116](http://ansible_nas_host_or_ip:8116).

roles/claper/docs/claper.md

@@ -1,14 +1,14 @@
 # Claper
 
-Homepage: <https://claper.co/>
+Homepage: [https://claper.co/](https://claper.co/)
 
 Claper turns your presentations into an interactive, engaging and exciting experience.
 
 ## Usage
 
-Set `claper_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `claper_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-Claper web interface can be found at <http://ansible_nas_host_or_ip:4000>.
+Claper web interface can be found at [http://ansible_nas_host_or_ip:4000](http://ansible_nas_host_or_ip:4000).
 
 ## Specific Configuration
 

roles/commafeed/docs/commafeed.md

@@ -1,6 +1,6 @@
 # CommaFeed
 
-Homepage: <https://github.com/lcomplete/commafeed>
+Homepage: [https://github.com/lcomplete/commafeed](https://github.com/lcomplete/commafeed)
 
 Google Reader inspired self-hosted RSS reader, based on Dropwizard and React/TypeScript.
 
@@ -17,6 +17,6 @@ Google Reader inspired self-hosted RSS reader, based on Dropwizard and React/Typ
 
 ## Usage
 
-Set `commafeed_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `commafeed_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-CommaFeed web interface can be found at <http://ansible_nas_host_or_ip:8122>.
+CommaFeed web interface can be found at [http://ansible_nas_host_or_ip:8122](http://ansible_nas_host_or_ip:8122).

roles/dockge/docs/dockge.md

@@ -1,11 +1,11 @@
 # Dockge
 
-Homepage: <https://github.com/louislam/dockge>
+Homepage: [https://github.com/louislam/dockge](https://github.com/louislam/dockge)
 
 A fancy, easy-to-use and reactive self-hosted docker compose.yaml stack-oriented manager
 
 ## Usage
 
-Set `dockge_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `dockge_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-dockge web interface can be found at <http://ansible_nas_host_or_ip:5004>.
+dockge web interface can be found at [http://ansible_nas_host_or_ip:5004](http://ansible_nas_host_or_ip:5004).

roles/dufs/docs/dufs.md

@@ -1,11 +1,11 @@
 # dufs
 
-Homepage: <https://github.com/sigoden/dufs>
+Homepage: [https://github.com/sigoden/dufs](https://github.com/sigoden/dufs)
 
 Dufs is a distinctive utility file server that supports static serving, uploading, searching, accessing control, webdav...
 
 ## Usage
 
-Set `dufs_enabled: true` in your `inventories/<your_inventory>/nas.yml` file. Optionally, edit `dufs_options` to set the needed dufs options.
+Set `dufs_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file. Optionally, edit `dufs_options` to set the needed dufs options.
 
-dufs web interface can be found at <http://ansible_nas_host_or_ip:8118>.
+dufs web interface can be found at [http://ansible_nas_host_or_ip:8118](http://ansible_nas_host_or_ip:8118).

roles/ebusd/docs/ebusd.md

@@ -1,11 +1,11 @@
 # ebusd
 
-Homepage: <https://github.com/john30/ebusd>
+Homepage: [https://github.com/john30/ebusd](https://github.com/john30/ebusd)
 
 ebusd is a daemon for handling communication with eBUS devices connected to a 2-wire bus system ("energy bus" used by numerous heating systems).
 
 ## Usage
 
-Set `ebusd_enabled: true` in your `inventories/<your_inventory>/nas.yml` file. Set any `ebusd_*` environment variables to suit your needs.
+Set `ebusd_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file. Set any `ebusd_*` environment variables to suit your needs.
 
-ebusd web interface can be found at <http://ansible_nas_host_or_ip:8110>.
+ebusd web interface can be found at [http://ansible_nas_host_or_ip:8110](http://ansible_nas_host_or_ip:8110).

roles/excalidraw/docs/exaclidraw.md

@@ -1,11 +1,11 @@
 # Excalidraw
 
-Homepage: <https://excalidraw.com/>
+Homepage: [https://excalidraw.com/](https://excalidraw.com/)
 
 Virtual whiteboard for sketching hand-drawn like diagrams
 
 ## Usage
 
-Set `excalidraw_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `excalidraw_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-excalidraw web interface can be found at <http://ansible_nas_host_or_ip:3008>.
+excalidraw web interface can be found at [http://ansible_nas_host_or_ip:3008](http://ansible_nas_host_or_ip:3008).

roles/flame/docs/flame.md

@@ -1,17 +1,17 @@
 # Flame
 
-Homepage: <https://github.com/pawelmalak/flame>
+Homepage: [https://github.com/pawelmalak/flame](https://github.com/pawelmalak/flame)
 
 Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
 
 ## Usage
 
-Set `flame_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `flame_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
 Set all `flame_*` variables in `inventories/<your_inventory>/group_vars/all.yml`.
 
-The flame web interface can be found at <http://ansible_nas_host_or_ip:5005>.
+The flame web interface can be found at [http://ansible_nas_host_or_ip:5005](http://ansible_nas_host_or_ip:5005).
 
 ## Specific Configuration
 
-Check <https://github.com/pawelmalak/flame> for more details on using the docker integration.
+Check [https://github.com/pawelmalak/flame](https://github.com/pawelmalak/flame) for more details on using the docker integration.

roles/flarum/docs/flarum.md

@@ -1,14 +1,14 @@
 # Flarum
 
-Homepage: <https://flarum.org/>
+Homepage: [https://flarum.org/](https://flarum.org/)
 
 Flarum is a delightfully simple discussion platform for your website. It's fast, free, and easy to use, with all the features you need to run a successful community. It's also extremely extensible, allowing for ultimate customizability.
 
 ## Usage
 
-Set `flarum_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `flarum_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-Flarum web interface can be found at <http://ansible_nas_host_or_ip:8001>. Login with default credentials (`flarum`/`flarum`) and change them.
+Flarum web interface can be found at [http://ansible_nas_host_or_ip:8001](http://ansible_nas_host_or_ip:8001). Login with default credentials (`flarum`/`flarum`) and change them.
 
 ## Specific Configuration
 

roles/flatnotes/docs/flatnotes.md

@@ -1,11 +1,11 @@
 # flatnotes
 
-Homepage: <https://flatnotes.io/>
+Homepage: [https://flatnotes.io/](https://flatnotes.io/)
 
 A self-hosted, database-less note taking web app that utilises a flat folder of markdown files for storage.
 
 ## Usage
 
-Set `flatnotes_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `flatnotes_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-Flatnotes web interface can be found at <http://ansible_nas_host_or_ip:8115>.
+Flatnotes web interface can be found at [http://ansible_nas_host_or_ip:8115](http://ansible_nas_host_or_ip:8115).

roles/frigate/docs/frigate.md

@@ -1,14 +1,14 @@
 # Frigate
 
-Homepage: <https://frigate.video/>
+Homepage: [https://frigate.video/](https://frigate.video/)
 
 Frigate is an open source NVR built around real-time AI object detection. All processing is performed locally on your own hardware, and your camera feeds never leave your home.
 
 ## Usage
 
-Set `frigate_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `frigate_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-Frigate web interface can be found at <http://ansible_nas_host_or_ip:5000>.
+Frigate web interface can be found at [http://ansible_nas_host_or_ip:5000](http://ansible_nas_host_or_ip:5000).
 
 ## Specific Configuration
 

roles/gaps/docs/gaps.md

@@ -1,11 +1,11 @@
 # Gaps
 
-Homepage: <https://github.com/JasonHHouse/gaps>
+Homepage: [https://github.com/JasonHHouse/gaps](https://github.com/JasonHHouse/gaps)
 
 Find the missing movies in your Plex Server.
 
 ## Usage
 
-Set `gaps_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+Set `gaps_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
 
-Gaps web interface can be found at <http://ansible_nas_host_or_ip:8484>. Login and configure the application according to the [docs](https://github.com/JasonHHouse/Gaps/blob/master/README.md).
+Gaps web interface can be found at [http://ansible_nas_host_or_ip:8484](http://ansible_nas_host_or_ip:8484). Login and configure the application according to the [docs](https://github.com/JasonHHouse/Gaps/blob/master/README.md).