MMM-Remote-Control/config.schema.json at master · Jopyth/MMM-Remote-Control · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "customCommand": {
      "type": "object",
      "description": "Override system commands used by Remote Control",
      "properties": {
        "monitorOnCommand": { "type": "string" },
        "monitorOffCommand": { "type": "string" },
        "monitorStatusCommand": { "type": "string" },
        "shutdownCommand": { "type": "string" },
        "rebootCommand": { "type": "string" }
      }
    },
    "showModuleApiMenu": {
      "type": "boolean",
      "description": "Show module API controls in the remote menu"
    },
    "showNotificationMenu": {
      "type": "boolean",
      "description": "Show the notification menu"
    },
    "showQRCode": {
      "type": "boolean",
      "description": "Display the remote access QR code on the mirror"
    },
    "qrCodeSize": {
      "type": "number",
      "description": "QR code size in pixels"
    },
    "qrCodePosition": {
      "type": "string",
      "enum": ["below", "above", "replace"],
      "description": "Place the QR code below or above the URL, or show it instead"
    },
    "hostname": {
      "type": "string",
      "description": "Hostname to show instead of the IP address in the URL and QR code (e.g. mirror.local), empty to show the IP address"
    },
    "secureEndpoints": {
      "type": "boolean",
      "description": "Require an API key for protected endpoints when enabled"
    },
    "apiKey": {
      "type": "string",
      "description": "Optional API key for protected endpoints"
    },
    "customMenu": {
      "type": "string",
      "description": "Config-relative path to a custom menu JSON file"
    },
    "classes": {
      "type": "object",
      "description": "Named CSS class groups used by the classes API"
    }
  }
}