187379de4e
- multistreaming (new): RTMP ingest + multi-platform fan-out with pluggable providers (Twitch/YouTube/Kick/custom), zero-knowledge key vaults, Authelia OIDC auth, shared rooms with editor/streamer roles, single-use invites, per-account streaming grants, and scenes & composition (grid/PiP layouts, text/image overlays, per-output audio routing). - installer: support Dockerfile build in metadata (not just image) and RSA key generation for the Authelia OIDC JWKS. - authelia: add OIDC provider with portainer + multistreaming clients (public + PKCE). - services: remove allprox; add nginx-proxy-manager and portainer; update lldap; regenerate catalog.
82 lines
2.9 KiB
JSON
82 lines
2.9 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"$id": "https://raw.githubusercontent.com/ReinadoRojo/homelab/master/docs/metadata-schema.json",
|
|
"title": "Homelab Service Metadata",
|
|
"description": "Schema for a service's metadata.json in a homelab repository.",
|
|
"type": "object",
|
|
"required": ["id", "name", "description", "version", "compose"],
|
|
"additionalProperties": true,
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Unique kebab-case id. Must equal the folder name.",
|
|
"pattern": "^[a-z0-9][a-z0-9-]*$"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Human-readable service name."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Short description of the service."
|
|
},
|
|
"version": {
|
|
"type": "string",
|
|
"description": "Version string used to detect updates."
|
|
},
|
|
"compose": {
|
|
"type": "object",
|
|
"description": "A Docker Compose service definition. Must set either `image` (pull a prebuilt image) or `build` (build from a Dockerfile, e.g. { \"context\": \".\", \"dockerfile\": \"Dockerfile\" }), plus ports, volumes, environment, etc."
|
|
},
|
|
"volumes": {
|
|
"type": "object",
|
|
"description": "Top-level named volumes to declare."
|
|
},
|
|
"networks": {
|
|
"type": "object",
|
|
"description": "Top-level networks to declare."
|
|
},
|
|
"env": {
|
|
"type": "array",
|
|
"description": "Variables the installer resolves and writes to .env.",
|
|
"items": {
|
|
"type": "object",
|
|
"required": ["name"],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"name": { "type": "string" },
|
|
"label": { "type": "string" },
|
|
"description": { "type": "string" },
|
|
"default": { "type": "string" },
|
|
"required": { "type": "boolean" },
|
|
"secret": { "type": "boolean" },
|
|
"options": { "type": "array", "items": { "type": "string" } },
|
|
"generate": { "type": "boolean" }
|
|
}
|
|
}
|
|
},
|
|
"rsaKeys": {
|
|
"type": "array",
|
|
"description": "RSA private keys the installer generates into files on first install (used for OIDC signing keys that cannot be injected via env).",
|
|
"items": {
|
|
"type": "object",
|
|
"required": ["name", "path"],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"name": { "type": "string" },
|
|
"path": { "type": "string" },
|
|
"bits": { "type": "number" }
|
|
}
|
|
}
|
|
},
|
|
"category": { "type": "string" },
|
|
"tags": { "type": "array", "items": { "type": "string" } },
|
|
"icon": { "type": "string", "format": "uri" },
|
|
"author": { "type": "string" },
|
|
"license": { "type": "string" },
|
|
"homepage": { "type": "string", "format": "uri" },
|
|
"documentation": { "type": "string", "format": "uri" },
|
|
"dependsOn": { "type": "array", "items": { "type": "string" } },
|
|
"notes": { "type": "string" }
|
|
}
|
|
}
|