Blame view

software/caddy-frontend/instance-caddy-input-schema.json 4.74 KB
Łukasz Nowak committed
1
{
Jérome Perrin committed
2 3 4 5 6 7
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "-frontend-authorized-slave-string": {
      "description": "List of SOFTINST-XXX of Slaves, separated by space which is allowed to use custom configuration.",
      "title": "Authorized Slave String",
      "type": "string"
Łukasz Nowak committed
8
    },
Jérome Perrin committed
9 10 11 12 13
    "-frontend-quantity": {
      "description": "Quantity of Frontends Replicate.",
      "title": "Frontend Replication Quantity",
      "type": "integer"
    },
Łukasz Nowak committed
14
    "apache-certificate": {
Łukasz Nowak committed
15
      "description": "SSL Certificate used by the server. By appending to it CA certificate it is possible to use this field to replace not implemented apache-ca-certificate. Deprecated, please use master-key-upload-url.",
Łukasz Nowak committed
16
      "textarea": true,
Łukasz Nowak committed
17
      "title": "[DEPRECATED] SSL Certificate, with optional CA certificate",
Łukasz Nowak committed
18 19 20 21 22 23 24 25
      "type": "string"
    },
    "apache-key": {
      "description": "SSL Key used by the server. Deprecated, please use master-key-upload-url.",
      "textarea": true,
      "title": "[DEPRECATED] SSL Key",
      "type": "string"
    },
Jérome Perrin committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
    "domain": {
      "description": "Base Domain for create subdomains (ie.: example.com).",
      "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6}$",
      "title": "Domain",
      "type": "string"
    },
    "enable-http2-by-default": {
      "default": "true",
      "description": "Use HTTP2 as default Protocol",
      "enum": [
        "true",
        "false"
      ],
      "title": "Enable HTTP2 by Default",
      "type": "string"
    },
Łukasz Nowak committed
42 43
    "global-disable-http2": {
      "default": "false",
Łukasz Nowak committed
44
      "description": "Disables globally HTTP2 in Caddy, thus enable-http2-by-default here and enable-http2 have no effect. Rational is that in some loaded environments it is better to run Caddy without any HTTP2 capabilities. Warning: Changing the parameter will result in restarting Caddy process.",
Łukasz Nowak committed
45 46 47 48 49 50 51
      "enum": [
        "true",
        "false"
      ],
      "title": "Globally disable HTTP2",
      "type": "string"
    },
Jérome Perrin committed
52 53 54
    "mpm-graceful-shutdown-timeout": {
      "default": 5,
      "description": "Value passed to -grace parameter of Caddy, see https://caddyserver.com/docs/cli .",
Łukasz Nowak committed
55
      "title": "Duration of the graceful shutdown period. Warning: Changing the parameter will result in restarting Caddy process.",
Jérome Perrin committed
56 57 58 59 60
      "type": "integer"
    },
    "nginx-domain": {
      "description": "Base Domain for create subdomains (ie.: example2.com) for websocket, notebook and eventsource.",
      "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6}$",
Łukasz Nowak committed
61
      "title": "[NOT IMPLEMENTED] Nginx Domain",
Jérome Perrin committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75
      "type": "string"
    },
    "public-ipv4": {
      "description": "Public ipv4 of the frontend (the one Caddy will be indirectly listening to).",
      "title": "Public IPv4",
      "type": "string"
    },
    "re6st-verification-url": {
      "description": "Url to verify if the internet and/or re6stnet is working.",
      "title": "Test Verification URL",
      "type": "string"
    },
    "enable-quic": {
      "default": "false",
Łukasz Nowak committed
76
      "description": "Enables QUIC - Quick UDP Internet Connections. Note that this is experimental feature, thus can result in undefined behaviour. Warning: Changing the parameter will result in restarting Caddy process.",
Jérome Perrin committed
77 78 79 80 81 82
      "enum": [
        "true",
        "false"
      ],
      "title": "Enable QUIC",
      "type": "string"
Łukasz Nowak committed
83 84 85 86 87 88 89 90 91 92 93 94
    },
    "proxy-try-duration": {
      "default": 5,
      "description": "A time during which Caddy will try to establish connection with a backend. Setting it to 0 will result with immediate return of 502 EOF error to the browser, even if it would be possible to (re)connect to the backend during few moments. More info in https://caddyserver.com/docs/proxy try_durtion.",
      "title": "Duration in seconds of trying a backend",
      "type": "integer"
    },
    "proxy-try-interval": {
      "default": 250,
      "description": "How often Caddy will try to establish connection with a backend during proxy-try-duration. More info in https://caddyserver.com/docs/proxy try_interval",
      "title": "Interval in milliseconds of tries during proxy-try-duration",
      "type": "integer"
Łukasz Nowak committed
95 96
    },
    "automatic-internal-kedifa-caucase-csr": {
Łukasz Nowak committed
97
      "default": "true",
Łukasz Nowak committed
98 99 100 101 102 103 104
      "description": "Automatically signs CSRs sent to KeDiFa's caucase, based on csr_id and matching certificate.",
      "enum": [
        "true",
        "false"
      ],
      "title": "Automatic Internal KeDiFa's Caucase CSR",
      "type": "string"
Łukasz Nowak committed
105 106 107 108 109
    },
    "ciphers": {
      "description": "List of ciphers. Empty defaults to Caddy list of ciphers. See https://caddyserver.com/docs/tls for more information.",
      "title": "Ordered space separated list of ciphers",
      "type": "string"
Jérome Perrin committed
110 111 112 113
    }
  },
  "title": "Input Parameters",
  "type": "object"
Łukasz Nowak committed
114
}