v0.6.29 (#139)

* add docs for hiding headers * Added status field for GameDig widget * add mjpeg docs * Update mjpeg.md * add to nav * add openmediavault docs * Adding Mealie * Update mealie.md * Add docs for calibre-web (#143) --------- Co-authored-by: shamoon <[email protected]> * Atsumeru widget docs (#144) * Atsumeru widget docs * Update atsumeru.md --------- Co-authored-by: shamoon <[email protected]> * Revert "Add docs for calibre-web (#143)" This reverts commit 036f7a1. * Re-add calibre-web docs * Added custom API widget - docs (#147) * Added custom API widget - docs * Rename custom widget to customapi --------- Co-authored-by: shamoon <[email protected]> --------- Co-authored-by: Ben Phelps <[email protected]> Co-authored-by: fredodiable <[email protected]> Co-authored-by: Xinos <[email protected]> Co-authored-by: joncrangle <[email protected]> Co-authored-by: Georges-Antoine Assi <[email protected]> Co-authored-by: AtsumeruDev <[email protected]> Co-authored-by: Denis Papec <[email protected]>
benphelps · Aug 26, 2023 · bea2155 · bea2155 · vercel · Aug 26, 2023
1 parent 9c6e9d8
commit bea2155
Show file tree

Hide file tree

Showing 9 changed files with 195 additions and 1 deletion.
diff --git a/src/config.ts b/src/config.ts
@@ -77,6 +77,7 @@ export const SIDEBAR: Sidebar = {
                 { text: 'Xteve', link: 'en/services/xteve' },
             ]},
             { text: 'Media Management Tools', links: [
+                { text: 'Atsumeru', link: 'en/services/atsumeru' },
                 { text: 'Audiobookshelf', link: 'en/services/audiobookshelf' },
                 { text: 'Bazarr', link: 'en/services/bazarr' },
                 { text: 'Immich', link: 'en/services/immich' },
@@ -130,6 +131,7 @@ export const SIDEBAR: Sidebar = {
                 { text: 'Caddy', link: 'en/services/caddy' },
                 { text: 'Cloudflare Tunnels', link: 'en/services/cloudflared' },
                 { text: 'NGINX Proxy Manager', link: 'en/services/nginx-proxy-manager' },
+                { text: 'OpenMediaVault', link: 'en/services/openmediavault' },
                 { text: 'OPNSense', link: 'en/services/opnsense' },
                 { text: 'pfSense', link: 'en/services/pfsense' },
                 { text: 'Portainer', link: 'en/services/portainer' },
@@ -146,7 +148,9 @@ export const SIDEBAR: Sidebar = {
             ]},
             { text: 'Other', links: [
                 { text: 'AzureDevOps', link: 'en/services/azuredevops'},
+                { text: 'Calibre-web', link: 'en/services/calibre-web' },
                 { text: 'Changedetection.io', link: 'en/services/changedetectionio'},
+                { text: 'Custom API', link: 'en/services/customapi'},
                 { text: 'EVCC', link: 'en/services/evcc'},
                 { text: 'Fileflows', link: 'en/services/fileflows' },
                 { text: 'FreshRSS', link: 'en/services/freshrss' },
@@ -157,8 +161,10 @@ export const SIDEBAR: Sidebar = {
                 { text: 'Home Assistant', link: 'en/services/homeassistant' },
                 { text: 'Homebridge', link: 'en/services/homebridge' },
                 { text: 'Kopia', link: 'en/services/kopia' },
+                { text: 'Mealie', link: 'en/services/mealie'},
                 { text: 'Minecraft', link: 'en/services/minecraft'},
                 { text: 'Miniflux', link: 'en/services/miniflux' },
+                { text: 'Mjpeg', link: 'en/services/mjpeg' },
                 { text: 'Moonraker', link: 'en/services/moonraker' },
                 { text: 'Nextcloud', link: 'en/services/nextcloud' },
                 { text: 'OctoPrint', link: 'en/services/octoprint' },

diff --git a/src/pages/en/configs/settings.md b/src/pages/en/configs/settings.md
@@ -121,6 +121,20 @@ layout:
       columns: 3
 ```
 
+### Headers
+
+You can hide headers for each section in the layout as well by passing `header` as false, like so:
+
+```yaml
+layout:
+    Section A:
+        header: false
+    Section B:
+        style: row
+        columns: 3
+        header: false
+```
+
 ### Category Icons
 
 You can also add an icon to a category under the `layout` setting similar to the [options for service icons](/en/configs/services/#icons), e.g.

diff --git a/src/pages/en/services/atsumeru.md b/src/pages/en/services/atsumeru.md
@@ -0,0 +1,19 @@
+---
+title: Atsumeru
+description: Atsumeru Widget Configuration
+layout: ../../../layouts/MainLayout.astro
+---
+
+Define same username and password that is used for login from web or supported apps
+
+Allowed fields: `["series", "archives", "chapters", "categories"]`.
+
+```yaml
+widget:
+    type: atsumeru
+    url: http://atsumeru.host.or.ip:port
+    username: username
+    password: password
+```
+
+*Added in v0.6.29*
diff --git a/src/pages/en/services/calibre-web.md b/src/pages/en/services/calibre-web.md
@@ -0,0 +1,20 @@
+---
+title: Calibre-web
+description: Calibre-web Widget Configuration
+layout: ../../../layouts/MainLayout.astro
+---
+
+**Note: this widget requires a feature of calibre-web that has not yet been distributed in versioned release. The code is contained in ["nightly" lsio builds after 25/8/23](https://hub.docker.com/layers/linuxserver/calibre-web/nightly/images/sha256-b27cbe5d17503de38135d925e226eb3e5ba04c558dbc865dc85d77824d35d7e2) or running the calibre-web source code including commit [0499e57](https://github.com/janeczku/calibre-web/commit/0499e578cdd45db656da34cd2d7152c8d88ceb23).**
+
+Allowed fields: `["books", "authors", "categories", "series"]`.
+
+```yaml
+widget:
+    type: calibreweb
+    url: http://your.calibreweb.host:port
+    username: username
+    password: password
+
+```
+
+*Added in v0.6.29*
diff --git a/src/pages/en/services/customapi.md b/src/pages/en/services/customapi.md
@@ -0,0 +1,74 @@
+---
+title: Custom API
+description: Custom Widget Configuration from the API
+layout: ../../../layouts/MainLayout.astro
+---
+
+This widget can show information from custom self-hosted or third party API.
+
+Fields need to be defined in the `mappings` section YAML object to correlate with the value in the APIs JSON object. Final field definition needs to be the key with the desired value information.
+
+```yaml
+widget:
+    type: customapi
+    url: http://custom.api.host.or.ip:port/path/to/exact/api/endpoint
+    refreshInterval: 10000 # optional - in milliseconds, defaults to 10s
+    username: username # auth - optional
+    password: password # auth - optional
+    mappings:
+      - field: key # needs to be YAML string or object
+        label: Field 1
+        format: text # optional - defaults to text
+      - field: # needs to be YAML string or object
+          path:
+            to: key2
+        format: number # optional - defaults to text
+        label: Field 2
+      - field: # needs to be YAML string or object
+          path:
+            to:
+              another: key3
+        label: Field 3
+        format: percent # optional - defaults to text
+```
+
+Supported formats for the values are `text`, `number`, `float` and `percent`.
+
+## Example
+
+For the following JSON object from the API:
+```json
+{
+  "id": 1,
+  "name": "Rick Sanchez",
+  "status": "Alive",
+  "species": "Human",
+  "gender": "Male",
+  "origin": {
+    "name": "Earth (C-137)"
+  },
+  "locations": [{
+    "name": "Earth (C-137)"
+  },{
+    "name": "Citadel of Ricks"
+  }]
+}
+```
+
+we can define the `mappings` section as following:
+```yaml
+    mappings:
+      - field: name # Rick Sanchez
+        label: Name
+      - field: status # Alive
+        label: Status
+      - field:
+          origin: name # Earth (C-137)
+        label: Origin
+      - field:
+          locations:
+            1: name # Citadel of Ricks
+        label: Location
+```
+
+*Added in v0.6.29*
diff --git a/src/pages/en/services/gamedig.md b/src/pages/en/services/gamedig.md
@@ -6,7 +6,7 @@ layout: ../../../layouts/MainLayout.astro
 
 Uses the [GameDig](https://www.npmjs.com/package/gamedig) library to get game server information for any supported server type.
 
-Allowed fields (limited to a max of 4): `["name", "map", "currentPlayers", "players", "maxPlayers", "bots", "ping"]`.
+Allowed fields (limited to a max of 4): `["status", "name", "map", "currentPlayers", "players", "maxPlayers", "bots", "ping"]`.
 
 ```yaml
 widget:

diff --git a/src/pages/en/services/mealie.md b/src/pages/en/services/mealie.md
@@ -0,0 +1,18 @@
+---
+title: Mealie
+description: Mealie Widget Configuration
+layout: ../../../layouts/MainLayout.astro
+---
+
+Generate a user API key under `Profile > Manage Your API Tokens > Generate`.
+
+Allowed fields: `["recipes", "users", "categories", "tags"]`.
+
+```yaml
+widget:
+    type: mealie
+    url: http://mealie-frontend.host.or.ip
+    key: mealieapitoken
+```
+
+*Added in v0.6.29*
diff --git a/src/pages/en/services/mjpeg.md b/src/pages/en/services/mjpeg.md
@@ -0,0 +1,15 @@
+---
+title: MJPEG
+description: MJPEG Stream Widget Configuration
+layout: ../../../layouts/MainLayout.astro
+---
+
+![camera-preview](https://github.com/benphelps/homepage-docs/assets/82196/dc375ae3-0670-489f-8db6-83ff1f423d12)
+
+Pass the stream URL from a service like [µStreamer](https://github.com/pikvm/ustreamer) or [camera-streamer](https://github.com/ayufan/camera-streamer).
+
+```yaml
+widget:
+    type: mjpeg
+    stream: http://mjpeg.host.or.ip/webcam/stream
+```
diff --git a/src/pages/en/services/openmediavault.md b/src/pages/en/services/openmediavault.md
@@ -0,0 +1,28 @@
+---
+title: OpenMediaVault
+description: OpenMediaVault Widget Configuration
+layout: ../../../layouts/MainLayout.astro
+---
+
+Provides useful information from your OpenMediaVault
+
+```yaml
+widget:
+    type: openmediavault
+    url: http://omv.host.or.ip
+    username: admin
+    password: pass
+    method: services.getStatus # required
+```
+
+## Methods
+
+The method field determines the type of data to be displayed and is required. Supported methods:
+
+`services.getStatus`: Shows status of running services. Allowed fields: `["running", "stopped", "total"]`
+
+`smart.getListBg`: Shows S.M.A.R.T. status from disks. Allowed fields: `["passed", "failed"]`
+
+`downloader.getDownloadList`: Displays the number of tasks from the Downloader plugin currently being downloaded and total. Allowed fields: `["downloading", "total"]`
+
+