refactor: add JSON schema validation on configs

2022-08-24 11:18:00 +02:00 · 2022-08-24 11:18:00 +02:00 · b87dd2d1f5
commit b87dd2d1f5
parent db234272d4
40 changed files with 162 additions and 0 deletions
--- a/apps/adguard/config.json
+++ b/apps/adguard/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Adguard",
  "available": true,
  "tipi_version": 1,
--- a/apps/booksonic/config.json
+++ b/apps/booksonic/config.json
@ -1,8 +1,10 @@
 {
+  "$schema": "../schema.json",
  "name": "Booksonic",
  "available": true,
  "port": 8040,
  "tipi_version": 1,
+  "version": "latest",
  "id": "booksonic",
  "categories": ["books", "media"],
  "description": "",
--- a/apps/calibre-web/config.json
+++ b/apps/calibre-web/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Calibre-Web - EBook Reader",
  "available": true,
  "port": 8100,
--- a/apps/code-server/config.json
+++ b/apps/code-server/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Code-Server - Web VS Code",
  "available": true,
  "port": 8101,
--- a/apps/filebrowser/config.json
+++ b/apps/filebrowser/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "File Browser",
  "available": true,
  "port": 8096,
--- a/apps/firefly-iii/config.json
+++ b/apps/firefly-iii/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Firefly III",
  "available": true,
  "port": 8115,
--- a/apps/freshrss/config.json
+++ b/apps/freshrss/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "FreshRSS",
  "available": true,
  "port": 8086,
--- a/apps/ghost/config.json
+++ b/apps/ghost/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Ghost",
  "port": 8117,
  "available": true,
--- a/apps/gitea/config.json
+++ b/apps/gitea/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Gitea",
  "port": 8108,
  "available": true,
--- a/apps/homarr/config.json
+++ b/apps/homarr/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Homarr",
  "available": true,
  "port": 8102,
--- a/apps/homeassistant/config.json
+++ b/apps/homeassistant/config.json
@ -1,8 +1,10 @@
 {
+  "$schema": "../schema.json",
  "name": "Home Assistant",
  "available": true,
  "port": 8123,
  "tipi_version": 2,
+  "version": "stable",
  "id": "homeassistant",
  "categories": ["automation"],
  "description": "Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server.",
--- a/apps/invidious/config.json
+++ b/apps/invidious/config.json
@ -1,8 +1,10 @@
 {
+  "$schema": "../schema.json",
  "name": "Invidious",
  "available": true,
  "port": 8095,
  "id": "invidious",
+  "version": "latest",
  "tipi_version": 1,
  "categories": ["media", "social"],
  "description": "Invidious is an open source alternative front-end to YouTube.",
--- a/apps/jackett/config.json
+++ b/apps/jackett/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Jackett",
  "available": true,
  "port": 8097,
--- a/apps/jellyfin/config.json
+++ b/apps/jellyfin/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Jellyfin",
  "available": true,
  "port": 8091,
--- a/apps/joplin/config.json
+++ b/apps/joplin/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Joplin Server",
  "available": true,
  "port": 8099,
--- a/apps/libreddit/config.json
+++ b/apps/libreddit/config.json
@ -1,9 +1,11 @@
 {
+  "$schema": "../schema.json",
  "name": "LibReddit",
  "available": true,
  "port": 8105,
  "id": "libreddit",
  "tipi_version": 1,
+  "version": "latest",
  "categories": ["social"],
  "description": "LibReddit is a bloat free reddit frontend written in Rust, no ads, no tracking and strong Content Security Policy prevents any request from going to reddit, everything is proxied.",
  "short_desc": "Browse reddit without problems!",
--- a/apps/mealie/config.json
+++ b/apps/mealie/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Mealie",
  "port": 8114,
  "available": true,
--- a/apps/n8n/config.json
+++ b/apps/n8n/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "n8n",
  "available": true,
  "port": 8094,
--- a/apps/nextcloud/config.json
+++ b/apps/nextcloud/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Nextcloud",
  "available": true,
  "port": 8083,
--- a/apps/nitter/config.json
+++ b/apps/nitter/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Nitter",
  "available": true,
  "port": 8106,
--- a/apps/nodered/config.json
+++ b/apps/nodered/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Node-RED",
  "port": 8111,
  "available": true,
--- a/apps/overseerr/config.json
+++ b/apps/overseerr/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Overseerr",
  "available": true,
  "port": 8116,
--- a/apps/photoprism/config.json
+++ b/apps/photoprism/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "PhotoPrism",
  "port": 8110,
  "available": true,
--- a/apps/pihole/config.json
+++ b/apps/pihole/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Pi-hole",
  "available": true,
  "port": 8081,
--- a/apps/plex/config.json
+++ b/apps/plex/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Plex",
  "available": true,
  "port": 32400,
--- a/apps/portainer/config.json
+++ b/apps/portainer/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Portainer",
  "port": 9443,
  "available": true,
--- a/apps/prowlarr/config.json
+++ b/apps/prowlarr/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Prowlarr",
  "available": true,
  "port": 8109,
--- a/apps/proxitok/config.json
+++ b/apps/proxitok/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "ProxiTok",
  "available": true,
  "port": 8118,
--- a/apps/radarr/config.json
+++ b/apps/radarr/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Radarr",
  "available": true,
  "port": 8088,
--- a/apps/readarr/config.json
+++ b/apps/readarr/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Readarr",
  "available": true,
  "port": 8112,
--- a/apps/resilio-sync/config.json
+++ b/apps/resilio-sync/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Resilio",
  "port": 8113,
  "available": true,
--- a/apps/schema.json
+++ b/apps/schema.json
@ -0,0 +1,119 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "available": {
+      "type": "boolean"
+    },
+    "port": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 65535
+    },
+    "requirements": {
+      "type": "object",
+      "properties": {
+        "ports": {
+          "type": "array",
+          "items": [
+            {
+              "type": "integer"
+            }
+          ]
+        }
+      }
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[a-z0-9-_]+$"
+    },
+    "tipi_version": {
+      "type": "integer"
+    },
+    "version": {
+      "type": "string"
+    },
+    "categories": {
+      "type": "array",
+      "items": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "description": {
+      "type": "string"
+    },
+    "short_desc": {
+      "type": "string"
+    },
+    "author": {
+      "type": "string"
+    },
+    "source": {
+      "type": "string",
+      "format": "uri"
+    },
+    "website": {
+      "type": "string",
+      "format": "uri"
+    },
+    "url_suffix": {
+      "type": "string",
+      "pattern": "^/[a-z0-9-_]+$"
+    },
+    "form_fields": {
+      "type": "array",
+      "items": [
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string"
+            },
+            "label": {
+              "type": "string"
+            },
+            "max": {
+              "type": "integer"
+            },
+            "min": {
+              "type": "integer"
+            },
+            "required": {
+              "type": "boolean"
+            },
+            "env_variable": {
+              "type": "string"
+            }
+          },
+          "required": ["type", "label", "env_variable"]
+        }
+      ]
+    }
+  },
+  "required": [
+    "name",
+    "available",
+    "port",
+    "id",
+    "tipi_version",
+    "version",
+    "categories",
+    "description",
+    "short_desc",
+    "author",
+    "source",
+    "form_fields"
+  ]
+}
--- a/apps/sonarr/config.json
+++ b/apps/sonarr/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Sonarr",
  "available": true,
  "port": 8098,
--- a/apps/syncthing/config.json
+++ b/apps/syncthing/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Syncthing",
  "available": true,
  "port": 8090,
--- a/apps/tailscale/config.json
+++ b/apps/tailscale/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Tailscale",
  "available": true,
  "port": 8093,
--- a/apps/tautulli/config.json
+++ b/apps/tautulli/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Tautulli",
  "available": true,
  "port": 8181,
--- a/apps/transmission/config.json
+++ b/apps/transmission/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Transmission",
  "available": true,
  "port": 8089,
--- a/apps/vaultwarden/config.json
+++ b/apps/vaultwarden/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "VaultWarden",
  "available": true,
  "port": 8107,
--- a/apps/wg-easy/config.json
+++ b/apps/wg-easy/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Wireguard",
  "available": true,
  "port": 8082,
--- a/apps/your-spotify/config.json
+++ b/apps/your-spotify/config.json
@ -1,4 +1,5 @@
 {
+  "$schema": "../schema.json",
  "name": "Your Spotify",
  "available": true,
  "port": 8103,