schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
minecraft-dimension.json | type | The namespaced ID of the dimension type. | {"anyOf": [{"type": "string", "enum": ["minecraft:overworld", "minecraft:overworld_caves", "minecraft:the_nether", "minecraft:the_end"]}, {}]} |
minecraft-dimension.json | generator | Generation settings used for that dimension. | {"type": "object", "properties": {"type": {"type": "string", "enum": ["minecraft:flat", "minecraft:noise", "minecraft:debug"]}}, "allOf": [{"if": {"properties": {"type": {"const": "minecraft:flat"}}}, "then": {"properties": {"settings": {"type": "object", "properties": {"layers": {"type": "array", "items": {"type": "object", "properties": {"height": {"type": "integer"}, "block": {"type": "string"}}}}, "biome": {"type": "string"}, "lakes": {"type": "boolean"}, "features": {"type": "boolean"}, "structures": {"type": "object", "properties": {"stronghold": {"type": "object", "properties": {"distance": {"type": "integer"}, "count": {"type": "integer"}, "spread": {"type": "integer"}}}, "structures": {"type": "object", "additionalProperties": {"type": "object", "properties": {"spacing": {"type": "integer"}, "seperation": {"type": "integer"}, "salt": {"type": "integer"}}}}}}}}}}}, {"if": {"properties": {"type": {"const": "minecraft:noise"}}}, "then": {"properties": {"seed": {"type": "integer"}, "settings": {"type": ["string", "object"]}, "biome_source": {"type": "object", "properties": {"seed": {"type": "integer"}, "biomes": {"type": "array"}, "type": {"type": "string", "allOf": [{"if": {"properties": {"type": {"const": "minecraft:vanilla_layered"}}}, "then": {"properties": {"large_biomes": {"type": "boolean"}, "legacy_biome_init_layer": {"type": "boolean"}}}}, {"if": {"properties": {"type": {"const": "minecraft:fixed"}}}, "then": {"properties": {"biome": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "minecraft:checkerboard"}}}, "then": {"properties": {"biomes": {"type": "array"}, "scale": {"type": "integer", "minimum": 0, "maximum": 62}}}}, {"if": {"properties": {"type": {"const": "minecraft:multi_noise"}}}, "then": {"properties": {"altitude_noise": {}, "weirdness_noise": {}, "temperature_noise": {}, "humidity_noise": {}}, "anyOf": [{"properties": {"preset": {"type": "string", "enum": ["minecraft:nether"]}}}, {"properties": {"biomes": {"type": "array", "items": {"type": "object", "properties": {"biome": {"type": "string"}, "parameters": {"type": "object", "properties": {"altitude": {"type": "number", "minimum": -2, "maximum": 2}, "weirdness": {"type": "number", "minimum": -2, "maximum": 2}, "offset": {"type": "number", "minimum": 0, "maximum": 1}, "temperature": {"type": "number", "minimum": -2, "maximum": 2}, "humidity": {"type": "number", "minimum": -2, "maximum": 2}}}}}}}}]}}, {"if": {"properties": {"type": {"const": "minecraft:the_end"}}}, "then": {}}]}}}}}}]} |
minecraft-dimension.json | type | The ID of the generator. | {"type": "string", "enum": ["minecraft:flat", "minecraft:noise", "minecraft:debug"]} |
minecraft-dimension.json | settings | Superflat settings. | {"type": "object", "properties": {"layers": {"type": "array", "items": {"type": "object", "properties": {"height": {"type": "integer"}, "block": {"type": "string"}}}}, "biome": {"type": "string"}, "lakes": {"type": "boolean"}, "features": {"type": "boolean"}, "structures": {"type": "object", "properties": {"stronghold": {"type": "object", "properties": {"distance": {"type": "integer"}, "count": {"type": "integer"}, "spread": {"type": "integer"}}}, "structures": {"type": "object", "additionalProperties": {"type": "object", "properties": {"spacing": {"type": "integer"}, "seperation": {"type": "integer"}, "salt": {"type": "integer"}}}}}}}} |
minecraft-dimension.json | layers | Layer settings. | {"type": "array", "items": {"type": "object", "properties": {"height": {"type": "integer"}, "block": {"type": "string"}}}} |
minecraft-dimension.json | items | A superflat layer. The first entry is the bottom layer, the last entry is the top layer. | {"type": "object", "properties": {"height": {"type": "integer"}, "block": {"type": "string"}}} |
minecraft-dimension.json | height | The number of blocks in the layer. | {"type": "integer"} |
minecraft-dimension.json | block | The block the layer is made of. | {"type": "string"} |
minecraft-dimension.json | biome | The single biome of the world. | {"type": "string"} |
minecraft-dimension.json | lakes | Whether or not to generate lakes. If set to true, then water and lava lakes generate often even in biomes where lakes don't normally generate. Lava lakes generate surrounded by different types of stone and ores from the overworld. | {"type": "boolean"} |
minecraft-dimension.json | features | Whether or not to generate biome-specific decorations like trees, grass, flowers, cacti, etc. | {"type": "boolean"} |
minecraft-dimension.json | structures | Structure settings. | {"type": "object", "properties": {"stronghold": {"type": "object", "properties": {"distance": {"type": "integer"}, "count": {"type": "integer"}, "spread": {"type": "integer"}}}, "structures": {"type": "object", "additionalProperties": {"type": "object", "properties": {"spacing": {"type": "integer"}, "seperation": {"type": "integer"}, "salt": {"type": "integer"}}}}}} |
minecraft-dimension.json | stronghold | Settings for how strongholds should be spawned. | {"type": "object", "properties": {"distance": {"type": "integer"}, "count": {"type": "integer"}, "spread": {"type": "integer"}}} |
minecraft-dimension.json | distance | Controls how far apart the strongholds are. | {"type": "integer"} |
minecraft-dimension.json | count | How many strongholds to generate. | {"type": "integer"} |
minecraft-dimension.json | structures | Map of structures to use in this dimension. | {"type": "object", "additionalProperties": {"type": "object", "properties": {"spacing": {"type": "integer"}, "seperation": {"type": "integer"}, "salt": {"type": "integer"}}}} |
minecraft-dimension.json | spacing | Average distance between two structure placement attempts of this type in chunks. | {"type": "integer"} |
minecraft-dimension.json | seperation | Minimum distance between two structures of this type in chunks; must be less than spacing. | {"type": "integer"} |
minecraft-dimension.json | salt | A number that assists in randomization. | {"type": "integer"} |
minecraft-dimension.json | seed | The seed used to generate the dimension. In most cases, this is exactly the same as the world seed, but can be different and the dimension generated is based upon this seed and not the world seed. | {"type": "integer"} |
minecraft-dimension.json | settings | The noise settings used in the terrain generator. Can be set to a string to use a preset defined in the worldgen/noise_settings folder with a list of customized options. | {"type": ["string", "object"]} |
minecraft-dimension.json | biome_source | Settings dictating which biomes and biome shapes. | {"type": "object", "properties": {"seed": {"type": "integer"}, "biomes": {"type": "array"}, "type": {"type": "string", "allOf": [{"if": {"properties": {"type": {"const": "minecraft:vanilla_layered"}}}, "then": {"properties": {"large_biomes": {"type": "boolean"}, "legacy_biome_init_layer": {"type": "boolean"}}}}, {"if": {"properties": {"type": {"const": "minecraft:fixed"}}}, "then": {"properties": {"biome": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "minecraft:checkerboard"}}}, "then": {"properties": {"biomes": {"type": "array"}, "scale": {"type": "integer", "minimum": 0, "maximum": 62}}}}, {"if": {"properties": {"type": {"const": "minecraft:multi_noise"}}}, "then": {"properties": {"altitude_noise": {}, "weirdness_noise": {}, "temperature_noise": {}, "humidity_noise": {}}, "anyOf": [{"properties": {"preset": {"type": "string", "enum": ["minecraft:nether"]}}}, {"properties": {"biomes": {"type": "array", "items": {"type": "object", "properties": {"biome": {"type": "string"}, "parameters": {"type": "object", "properties": {"altitude": {"type": "number", "minimum": -2, "maximum": 2}, "weirdness": {"type": "number", "minimum": -2, "maximum": 2}, "offset": {"type": "number", "minimum": 0, "maximum": 1}, "temperature": {"type": "number", "minimum": -2, "maximum": 2}, "humidity": {"type": "number", "minimum": -2, "maximum": 2}}}}}}}}]}}, {"if": {"properties": {"type": {"const": "minecraft:the_end"}}}, "then": {}}]}}} |
minecraft-dimension.json | seed | The seed used for biome generation. | {"type": "integer"} |
minecraft-dimension.json | biomes | A list of biome IDs to generate. | {"type": "array"} |
minecraft-dimension.json | type | The type of biome generation. | {"type": "string", "allOf": [{"if": {"properties": {"type": {"const": "minecraft:vanilla_layered"}}}, "then": {"properties": {"large_biomes": {"type": "boolean"}, "legacy_biome_init_layer": {"type": "boolean"}}}}, {"if": {"properties": {"type": {"const": "minecraft:fixed"}}}, "then": {"properties": {"biome": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "minecraft:checkerboard"}}}, "then": {"properties": {"biomes": {"type": "array"}, "scale": {"type": "integer", "minimum": 0, "maximum": 62}}}}, {"if": {"properties": {"type": {"const": "minecraft:multi_noise"}}}, "then": {"properties": {"altitude_noise": {}, "weirdness_noise": {}, "temperature_noise": {}, "humidity_noise": {}}, "anyOf": [{"properties": {"preset": {"type": "string", "enum": ["minecraft:nether"]}}}, {"properties": {"biomes": {"type": "array", "items": {"type": "object", "properties": {"biome": {"type": "string"}, "parameters": {"type": "object", "properties": {"altitude": {"type": "number", "minimum": -2, "maximum": 2}, "weirdness": {"type": "number", "minimum": -2, "maximum": 2}, "offset": {"type": "number", "minimum": 0, "maximum": 1}, "temperature": {"type": "number", "minimum": -2, "maximum": 2}, "humidity": {"type": "number", "minimum": -2, "maximum": 2}}}}}}}}]}}, {"if": {"properties": {"type": {"const": "minecraft:the_end"}}}, "then": {}}]} |
minecraft-dimension.json | then | Default and large biome generation used in the overworld. | {"properties": {"large_biomes": {"type": "boolean"}, "legacy_biome_init_layer": {"type": "boolean"}}} |
minecraft-dimension.json | large_biomes | Whether the biomes are large. | {"type": "boolean"} |
minecraft-dimension.json | legacy_biome_init_layer | Whether the world was default_1_1. | {"type": "boolean"} |
minecraft-dimension.json | then | A single biome. | {"properties": {"biome": {"type": "string"}}} |
minecraft-dimension.json | biome | The single biome to generate. | {"type": "string"} |
minecraft-dimension.json | then | A biome generation in which biomes are square (or close to square) and repeat along the diagonals. | {"properties": {"biomes": {"type": "array"}, "scale": {"type": "integer", "minimum": 0, "maximum": 62}}} |
minecraft-dimension.json | biomes | A list of biomes that repeat along the diagonals. | {"type": "array"} |
minecraft-dimension.json | scale | Determines the size of the squares on an exponential scale. | {"type": "integer", "minimum": 0, "maximum": 62} |
minecraft-dimension.json | then | 3D biome generation used in the nether. | {"properties": {"altitude_noise": {}, "weirdness_noise": {}, "temperature_noise": {}, "humidity_noise": {}}, "anyOf": [{"properties": {"preset": {"type": "string", "enum": ["minecraft:nether"]}}}, {"properties": {"biomes": {"type": "array", "items": {"type": "object", "properties": {"biome": {"type": "string"}, "parameters": {"type": "object", "properties": {"altitude": {"type": "number", "minimum": -2, "maximum": 2}, "weirdness": {"type": "number", "minimum": -2, "maximum": 2}, "offset": {"type": "number", "minimum": 0, "maximum": 1}, "temperature": {"type": "number", "minimum": -2, "maximum": 2}, "humidity": {"type": "number", "minimum": -2, "maximum": 2}}}}}}}}]} |
minecraft-dimension.json | altitude_noise | How the altitude parameter is spread in the world. | {} |
minecraft-dimension.json | weirdness_noise | Similar to altitude_noise for the weirdness parameter. | {} |
minecraft-dimension.json | temperature_noise | Similar to altitude_noise for the temperature parameter. | {} |
minecraft-dimension.json | humidity_noise | Similar to altitude_noise for the humidity parameter. | {} |
minecraft-dimension.json | preset | A preset of the set of biomes to be used. | {"type": "string", "enum": ["minecraft:nether"]} |
minecraft-dimension.json | biomes | A list of biomes, including their likelihood. | {"type": "array", "items": {"type": "object", "properties": {"biome": {"type": "string"}, "parameters": {"type": "object", "properties": {"altitude": {"type": "number", "minimum": -2, "maximum": 2}, "weirdness": {"type": "number", "minimum": -2, "maximum": 2}, "offset": {"type": "number", "minimum": 0, "maximum": 1}, "temperature": {"type": "number", "minimum": -2, "maximum": 2}, "humidity": {"type": "number", "minimum": -2, "maximum": 2}}}}}} |
minecraft-dimension.json | items | A biome and its properties. | {"type": "object", "properties": {"biome": {"type": "string"}, "parameters": {"type": "object", "properties": {"altitude": {"type": "number", "minimum": -2, "maximum": 2}, "weirdness": {"type": "number", "minimum": -2, "maximum": 2}, "offset": {"type": "number", "minimum": 0, "maximum": 1}, "temperature": {"type": "number", "minimum": -2, "maximum": 2}, "humidity": {"type": "number", "minimum": -2, "maximum": 2}}}}} |
minecraft-dimension.json | biome | The biome. | {"type": "string"} |
minecraft-dimension.json | parameters | Represent optimal conditions for where the biome should be placed. These values do not affect the generation of terrain within biomes; they affect where the game chooses to place biomes. | {"type": "object", "properties": {"altitude": {"type": "number", "minimum": -2, "maximum": 2}, "weirdness": {"type": "number", "minimum": -2, "maximum": 2}, "offset": {"type": "number", "minimum": 0, "maximum": 1}, "temperature": {"type": "number", "minimum": -2, "maximum": 2}, "humidity": {"type": "number", "minimum": -2, "maximum": 2}}} |
minecraft-dimension.json | altitude | Used to place similar biomes near each other. | {"type": "number", "minimum": -2, "maximum": 2} |
minecraft-dimension.json | weirdness | Defines how weird the biome is going to appear next to other biomes. | {"type": "number", "minimum": -2, "maximum": 2} |
minecraft-dimension.json | offset | Similar to the other parameters but offset is 0 everywhere, thus setting this parameter nearer to 0 gives the biome a greater edge over others, all else being equal. | {"type": "number", "minimum": 0, "maximum": 1} |
minecraft-dimension.json | temperature | Used to place similar biomes near each other. This is NOT the same as the temperature value listed on Biome, it does NOT affect rain/snow or the color of leaves and grass. | {"type": "number", "minimum": -2, "maximum": 2} |
minecraft-dimension.json | humidity | Used to place similar biomes near each other. | {"type": "number", "minimum": -2, "maximum": 2} |
minecraft-dimension.json | then | Biome generation used in the end with biome minecraft:the_end in the center and other end biomes around. | {} |
grunt-watch-task.json | files | One or more files to watch. | {"type": "array", "items": {"type": "string"}} |
grunt-watch-task.json | tasks | One or more tasks to run. | {"type": "array", "items": {"type": "string"}} |
grunt-watch-task.json | events | Specify the type watch event that trigger the specified task. | {"type": "array", "items": {}} |
grunt-watch-task.json | eventType | Specify the type watch event that trigger the specified task. | {"type": "string", "default": "all", "enum": ["all", "changed", "added", "deleted"]} |
grunt-watch-task.json | options | One or more files to watch. | {"type": "object", "allOf": [{}], "properties": {"spawn": {"type": "boolean", "default": true}, "interrupt": {"type": "boolean", "default": false}, "debounceDelay": {"type": "integer", "default": 500}, "interval": {"type": "integer", "default": 100}, "reload": {"type": "boolean", "default": false}, "forever": {"type": "boolean", "default": true}, "atBegin": {"type": "boolean", "default": false}, "livereload": {"type": ["boolean", "number"], "default": false}, "cwd": {"type": ["string", "object"]}, "livereloadOnError": {"type": "boolean", "default": true}}} |
grunt-watch-task.json | spawn | Whether to spawn task runs in a child process. | {"type": "boolean", "default": true} |
grunt-watch-task.json | interrupt | As files are modified this watch task will spawn tasks in child processes. | {"type": "boolean", "default": false} |
grunt-watch-task.json | debounceDelay | How long to wait before emitting events in succession for the same filepath and status. For example if your Gruntfile.js file was changed, a 'changed' event will only fire again after the given milliseconds. | {"type": "integer", "default": 500} |
grunt-watch-task.json | interval | The interval is passed to 'fs.watchFile'. Since 'interval' is only used by 'fs.watchFile' and this watcher also uses 'fs.watch'; it is recommended to ignore this option. | {"type": "integer", "default": 100} |
grunt-watch-task.json | reload | By default, if Gruntfile.js is being watched, then changes to it will trigger the watch task to restart, and reload the Gruntfile.js changes. When reload is set to true, changes to any of the watched files will trigger the watch task to restart. This is especially useful if your Gruntfile.js is dependent on other files. | {"type": "boolean", "default": false} |
grunt-watch-task.json | forever | This is only a task level option and cannot be configured per target. By default the watch task will duck punch grunt.fatal and grunt.warn to try and prevent them from exiting the watch process. If you don't want grunt.fatal and grunt.warn to be overridden set the forever option to false. | {"type": "boolean", "default": true} |
grunt-watch-task.json | atBegin | This option will trigger the run of each specified task at startup of the watcher. | {"type": "boolean", "default": false} |
grunt-watch-task.json | livereload | If enabled a live reload server will be started with the watch task per target. Then after the indicated tasks have run, the live reload server will be triggered with the modified files. | {"type": ["boolean", "number"], "default": false} |
grunt-watch-task.json | cwd | Ability to set the current working directory. | {"type": ["string", "object"]} |
grunt-watch-task.json | livereloadOnError | Option to prevent the livereload if the executed tasks encountered an error. If set to false , the livereload will only be triggered if all tasks completed successfully. | {"type": "boolean", "default": true} |
traefik-v2-file-provider.json | Traefik v2 Dynamic Configuration File Provider | {"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": {"httpRouter": {"type": "object", "properties": {"entryPoints": {"type": "array", "items": {"type": "string"}}, "rule": {"type": "string"}, "priority": {"type": "integer", "default": 0, "minimum": 0}, "middlewares": {"type": "array", "items": {"type": "string"}}, "service": {"type": "string"}, "tls": {"type": "object", "properties": {"options": {"type": "string"}, "certResolver": {"type": "string"}, "domains": {"type": "array", "items": {"type": "object", "properties": {"main": {"type": "string"}, "sans": {"type": "array", "items": {"type": "string"}}}}}}}}, "additionalProperties": false, "required": ["rule", "service"]}, "httpLoadBalancerService": {"type": "object", "properties": {"servers": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"url": {"type": "string"}}, "required": ["url"]}}, "sticky": {"type": "object", "properties": {"cookie": {"type": "object", "properties": {"name": {"type": "string"}, "secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "default": ""}}}}}, "healthCheck": {"type": "object", "properties": {"method": {"type": "string"}, "path": {"type": "string"}, "scheme": {"type": "string"}, "hostname": {"type": "string"}, "port": {"type": "integer"}, "interval": {"type": "string"}, "timeout": {"type": "string"}, "headers": {"type": "object", "additionalProperties": {"type": "string"}}, "followRedirects": {"type": "boolean", "default": true}}}, "passHostHeader": {"type": "boolean", "default": true}, "responseForwarding": {"type": "object", "properties": {"flushInterval": {"type": "string"}}}, "serversTransport": {"type": "string"}}, "additionalProperties": false, "required": ["servers"]}, "httpWeightedService": {"type": "object", "properties": {"services": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "weight": {"type": "number"}}}}, "sticky": {"type": "object", "properties": {"cookie": {"type": "object", "properties": {"name": {"type": "string"}, "secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "default": ""}}}}}, "healthCheck": {"type": "object"}}, "additionalProperties": false}, "httpMirroringService": {"type": "object", "properties": {"service": {"type": "string"}, "maxBodySize": {"type": "integer", "default": -1}, "mirrors": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "percent": {"type": "number", "minimum": 0, "maximum": 100}}}}, "healthCheck": {"type": "object"}}, "additionalProperties": false}, "httpFailoverService": {"type": "object", "properties": {"service": {"type": "string"}, "fallback": {"type": "string"}, "healthCheck": {"type": "object"}}, "additionalProperties": false}, "httpService": {"type": "object", "oneOf": [{"properties": {"loadBalancer": {}}, "additionalProperties": false}, {"properties": {"weighted": {}}, "additionalProperties": false}, {"properties": {"mirroring": {}}, "additionalProperties": false}, {"properties": {"failover": {}}, "additionalProperties": false}]}, "addPrefixMiddleware": {"type": "object", "properties": {"prefix": {"type": "string"}}, "additionalProperties": false}, "basicAuthMiddleware": {"type": "object", "properties": {"users": {"type": "array", "items": {"type": "string"}}, "usersFile": {"type": "string"}, "realm": {"type": "string", "default": "traefik"}, "headerField": {"type": "string"}, "removeHeader": {"type": "boolean", "default": false}}}, "bufferingMiddleware": {"type": "object", "properties": {"maxRequestBodyBytes": {"type": "integer"}, "memRequestBodyBytes": {"type": "integer"}, "maxResponseBodyBytes": {"type": "integer"}, "memResponseBodyBytes": {"type": "integer"}, "retryExpression": {"type": "string"}}, "additionalProperties": false}, "chainMiddleware": {"type": "object", "properties": {"middlewares": {"type": "array", "minItems": 1, "items": {"type": "string"}}}, "additionalProperties": false}, "circuitBreakerMiddleware": {"type": "object", "properties": {"expression": {"type": "string"}, "checkPeriod": {"type": "string"}, "fallbackDuration": {"type": "string"}, "recoveryDuration": {"type": "string"}}, "additionalProperties": false}, "compressMiddleware": {"type": "object", "properties": {"excludedContentTypes": {"type": "array", "items": {"type": "string"}}, "minResponseBodyBytes": {"type": "integer"}}, "additionalProperties": false}, "contentTypeMiddleware": {"type": "object", "properties": {"autoDetect": {"type": "boolean", "default": false}}, "additionalProperties": false}, "digestAuthMiddleware": {"type": "object", "properties": {"users": {"type": "array", "items": {"type": "string"}}, "usersFile": {"type": "string"}, "realm": {"type": "string", "default": "traefik"}, "headerField": {"type": "string"}, "removeHeader": {"type": "boolean", "default": false}}, "additionalProperties": false}, "errorsMiddleware": {"type": "object", "properties": {"status": {"type": "array", "items": {"type": "string"}}, "service": {"type": "string"}, "query": {"type": "string"}}, "additionalProperties": false}, "forwardAuthMiddleware": {"type": "object", "properties": {"address": {"type": "string"}, "tls": {"type": "object", "properties": {"ca": {"type": "string"}, "caOptional": {"type": "boolean"}, "cert": {"type": "string"}, "key": {"type": "string"}, "insecureSkipVerify": {"type": "boolean"}}, "dependencies": {"caOptional": ["ca"]}}, "trustForwardHeader": {"type": "boolean"}, "authResponseHeaders": {"type": "array", "items": {"type": "string"}}, "authResponseHeadersRegex": {"type": "string"}, "authRequestHeaders": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "headersMiddleware": {"type": "object", "properties": {"customRequestHeaders": {"type": "object", "additionalProperties": {"type": "string"}}, "customResponseHeaders": {"type": "object", "additionalProperties": {"type": "string"}}, "accessControlAllowCredentials": {"type": "boolean"}, "accessControlAllowHeaders": {"type": "array", "items": {"type": "string"}}, "accessControlAllowMethods": {"type": "array", "items": {"type": "string"}}, "accessControlAllowOriginList": {"type": "array", "items": {"type": "string"}}, "accessControlAllowOriginListRegex": {"type": "array", "items": {"type": "string"}}, "accessControlExposeHeaders": {"type": "array", "items": {"type": "string"}}, "accessControlMaxAge": {"type": "integer"}, "addVaryHeader": {"type": "boolean"}, "allowedHosts": {"type": "array", "items": {"type": "string"}}, "hostsProxyHeaders": {"type": "array", "items": {"type": "string"}}, "sslRedirect": {"type": "boolean"}, "sslTemporaryRedirect": {"type": "boolean"}, "sslHost": {"type": "string"}, "sslProxyHeaders": {"type": "object", "additionalProperties": {"type": "string"}}, "sslForceHost": {"type": "boolean"}, "stsSeconds": {"type": "integer"}, "stsIncludeSubdomains": {"type": "boolean"}, "stsPreload": {"type": "boolean"}, "forceSTSHeader": {"type": "boolean"}, "frameDeny": {"type": "boolean"}, "customFrameOptionsValue": {"type": "string"}, "contentTypeNosniff": {"type": "boolean"}, "browserXssFilter": {"type": "boolean"}, "customBrowserXSSValue": {"type": "string"}, "contentSecurityPolicy": {"type": "string"}, "publicKey": {"type": "string"}, "referrerPolicy": {"type": "string"}, "featurePolicy": {"type": "string"}, "permissionsPolicy": {"type": "string"}, "isDevelopment": {"type": "boolean"}}, "additionalProperties": false}, "ipStrategy": {"type": "object", "properties": {"depth": {"type": "integer"}, "excludedIPs": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "ipWhiteListMiddleware": {"type": "object", "properties": {"sourceRange": {"type": "array", "items": {"type": "string"}}, "ipStrategy": {}}, "additionalProperties": false}, "sourceCriterion": {"type": "object", "properties": {"ipStrategy": {}, "requestHeaderName": {"type": "string"}, "requestHost": {"type": "boolean"}}, "additionalProperties": false}, "inFlightReqMiddleware": {"type": "object", "properties": {"amount": {"type": "integer"}, "sourceCriterion": {}}, "additionalProperties": false}, "passTLSClientCertMiddleware": {"type": "object", "properties": {"pem": {"type": "boolean"}, "info": {"type": "object", "properties": {"notAfter": {"type": "boolean"}, "notBefore": {"type": "boolean"}, "sans": {"type": "boolean"}, "subject": {"type": "object", "properties": {"country": {"type": "boolean"}, "province": {"type": "boolean"}, "locality": {"type": "boolean"}, "organization": {"type": "boolean"}, "commonName": {"type": "boolean"}, "serialNumber": {"type": "boolean"}, "domainComponent": {"type": "boolean"}}}, "issuer": {"type": "object", "properties": {"country": {"type": "boolean"}, "province": {"type": "boolean"}, "locality": {"type": "boolean"}, "organization": {"type": "boolean"}, "commonName": {"type": "boolean"}, "serialNumber": {"type": "boolean"}, "domainComponent": {"type": "boolean"}}}}}}, "additionalProperties": false}, "pluginMiddleware": {"type": "object", "additionalProperties": {"type": "object"}}, "rateLimitMiddleware": {"type": "object", "properties": {"average": {"oneOf": [{"type": "string"}, {"type": "number"}]}, "period": {"oneOf": [{"type": "string"}, {"type": "number", "default": 1}]}, "burst": {"type": "number", "default": 1}, "sourceCriterion": {}}, "additionalProperties": false}, "redirectRegexMiddleware": {"type": "object", "properties": {"permanent": {"type": "boolean"}, "regex": {"type": "string"}, "replacement": {"type": "string"}}, "additionalProperties": false}, "redirectSchemeMiddleware": {"type": "object", "properties": {"permanent": {"type": "boolean"}, "scheme": {"type": "string"}, "port": {"type": "string"}}, "additionalProperties": false}, "replacePathMiddleware": {"type": "object", "properties": {"path": {"type": "string"}}, "additionalProperties": false}, "replacePathRegexMiddleware": {"type": "object", "properties": {"regex": {"type": "string"}, "replacement": {"type": "string"}}, "additionalProperties": false}, "retryMiddleware": {"type": "object", "properties": {"attempts": {"type": "integer"}, "initialInterval": {"type": "string"}}, "additionalProperties": false, "required": ["attempts"]}, "stripPrefixMiddleware": {"type": "object", "properties": {"prefixes": {"type": "array", "items": {"type": "string"}}, "forceSlash": {"type": "boolean"}}, "additionalProperties": false}, "stripPrefixRegexMiddleware": {"type": "object", "properties": {"regex": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "httpMiddleware": {"type": "object", "oneOf": [{"properties": {"addPrefix": {}}, "additionalProperties": false}, {"properties": {"basicAuth": {}}, "additionalProperties": false}, {"properties": {"buffering": {}}, "additionalProperties": false}, {"properties": {"chain": {}}, "additionalProperties": false}, {"properties": {"circuitBreaker": {}}, "additionalProperties": false}, {"properties": {"compress": {}}, "additionalProperties": false}, {"properties": {"contentType": {}}, "additionalProperties": false}, {"properties": {"digestAuth": {}}, "additionalProperties": false}, {"properties": {"errors": {}}, "additionalProperties": false}, {"properties": {"forwardAuth": {}}, "additionalProperties": false}, {"properties": {"headers": {}}, "additionalProperties": false}, {"properties": {"ipWhiteList": {}}, "additionalProperties": false}, {"properties": {"inFlightReq": {}}, "additionalProperties": false}, {"properties": {"passTLSClientCert": {}}, "additionalProperties": false}, {"properties": {"plugin": {}}, "additionalProperties": false}, {"properties": {"rateLimit": {}}, "additionalProperties": false}, {"properties": {"redirectRegex": {}}, "additionalProperties": false}, {"properties": {"redirectScheme": {}}, "additionalProperties": false}, {"properties": {"replacePath": {}}, "additionalProperties": false}, {"properties": {"replacePathRegex": {}}, "additionalProperties": false}, {"properties": {"retry": {}}, "additionalProperties": false}, {"properties": {"stripPrefix": {}}, "additionalProperties": false}, {"properties": {"stripPrefixRegex": {}}, "additionalProperties": false}]}, "tcpRouter": {"type": "object", "properties": {"entryPoints": {"type": "array", "items": {"type": "string"}}, "middlewares": {"type": "array", "items": {"type": "string"}}, "rule": {"type": "string"}, "service": {"type": "string"}, "priority": {"type": "integer", "default": 0, "minimum": 0}, "tls": {"type": "object", "properties": {"passthrough": {"type": "boolean", "default": false}, "options": {"type": "string"}, "certResolver": {"type": "string"}, "domains": {"type": "array", "items": {"type": "object", "properties": {"main": {"type": "string"}, "sans": {"type": "array", "items": {"type": "string"}}}}}}}}, "additionalProperties": false, "required": ["rule", "service"]}, "tcpLoadBalancerService": {"type": "object", "properties": {"servers": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"address": {"type": "string"}}, "required": ["address"]}}, "terminationDelay": {"type": "number", "default": 100}, "proxyProtocol": {"type": "object", "properties": {"version": {"type": "integer"}}}}, "additionalProperties": false, "required": ["servers"]}, "tcpWeightedService": {"type": "object", "properties": {"services": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "weight": {"type": "number"}}, "additionalProperties": false, "required": ["name", "weight"]}}}, "additionalProperties": false, "required": ["services"]}, "tcpService": {"type": "object", "oneOf": [{"properties": {"loadBalancer": {}}, "additionalProperties": false}, {"properties": {"weighted": {}}, "additionalProperties": false}]}, "udpRouter": {"type": "object", "properties": {"entryPoints": {"type": "array", "items": {"type": "string"}}, "service": {"type": "string"}}, "additionalProperties": false, "required": ["service"]}, "udpLoadBalancerService": {"type": "object", "properties": {"servers": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"address": {"type": "string"}}, "required": ["address"]}}}, "additionalProperties": false, "required": ["servers"]}, "udpWeightedService": {"type": "object", "properties": {"services": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "weight": {"type": "number"}}, "additionalProperties": false, "required": ["name", "weight"]}}}, "additionalProperties": false, "required": ["services"]}, "udpService": {"type": "object", "oneOf": [{"properties": {"loadBalancer": {}}, "additionalProperties": false}, {"properties": {"weighted": {}}, "additionalProperties": false}]}}, "id": "https://json.schemastore.org/traefik-v2-file-provider.json", "properties": {"http": {"type": "object", "properties": {"routers": {"type": "object", "additionalProperties": {}}, "services": {"type": "object", "additionalProperties": {}}, "middlewares": {"type": "object", "additionalProperties": {}}}}, "tcp": {"type": "object", "properties": {"routers": {"type": "object", "additionalProperties": {}}, "services": {"type": "object", "additionalProperties": {}}}}, "udp": {"type": "object", "additionalProperties": false, "properties": {"routers": {"type": "object", "additionalProperties": {}}, "services": {"type": "object", "additionalProperties": {}}}}, "tls": {"type": "object", "additionalProperties": false, "properties": {"certificates": {"type": "array", "items": {"type": "object", "properties": {"certFile": {"type": "string"}, "keyFile": {"type": "string"}, "stores": {"type": "array", "items": {"type": "string"}}}}}, "options": {"type": "object", "additionalProperties": false, "patternProperties": {"[a-zA-Z0-9-_]+": {"type": "object", "properties": {"minVersion": {"type": "string"}, "maxVersion": {"type": "string"}, "cipherSuites": {"type": "array", "items": {"type": "string"}}, "curvePreferences": {"type": "array", "items": {"type": "string"}}, "sniStrict": {"type": "boolean"}, "preferServerCipherSuites": {"type": "boolean"}, "clientAuth": {"type": "object", "properties": {"caFiles": {"type": "array", "items": {"type": "string"}}, "clientAuthType": {"type": "string"}}}}}}}, "stores": {"type": "object", "patternProperties": {"[a-zA-Z0-9-_]+": {"type": "object", "additionalProperties": false, "properties": {"defaultCertificate": {"type": "object", "additionalProperties": false, "properties": {"certFile": {"type": "string"}, "keyFile": {"type": "string"}}}, "defaultGeneratedCert": {"type": "object", "additionalProperties": false, "properties": {"resolver": {"type": "string"}, "domain": {"type": "object", "properties": {"main": {"type": "string"}, "sans": {"type": "array", "items": {"type": "string"}}}}}}}}}}}}}, "type": "object"} | |
traefik-v2-file-provider.json | httpRouter | A router is in charge of connecting incoming requests to the services that can handle them. In the process, routers may use pieces of middleware to update the request, or act before forwarding the request to the service. | {"type": "object", "properties": {"entryPoints": {"type": "array", "items": {"type": "string"}}, "rule": {"type": "string"}, "priority": {"type": "integer", "default": 0, "minimum": 0}, "middlewares": {"type": "array", "items": {"type": "string"}}, "service": {"type": "string"}, "tls": {"type": "object", "properties": {"options": {"type": "string"}, "certResolver": {"type": "string"}, "domains": {"type": "array", "items": {"type": "object", "properties": {"main": {"type": "string"}, "sans": {"type": "array", "items": {"type": "string"}}}}}}}}, "additionalProperties": false, "required": ["rule", "service"]} |
traefik-v2-file-provider.json | entryPoints | If not specified, HTTP routers will accept requests from all defined entry points. If you want to limit the router scope to a set of entry points, set the entryPoints option. | {"type": "array", "items": {"type": "string"}} |
traefik-v2-file-provider.json | rule | Rules are a set of matchers configured with values, that determine if a particular request matches specific criteria. If the rule is verified, the router becomes active, calls middlewares, and then forwards the request to the service. | {"type": "string"} |
traefik-v2-file-provider.json | priority | To avoid path overlap, routes are sorted, by default, in descending order using rules length. The priority is directly equal to the length of the rule, and so the longest length has the highest priority. A value of 0 for the priority is ignored: priority = 0 means that the default rules length sorting is used. | {"type": "integer", "default": 0, "minimum": 0} |
traefik-v2-file-provider.json | middlewares | You can attach a list of middlewares to each HTTP router. The middlewares will take effect only if the rule matches, and before forwarding the request to the service. Middlewares are applied in the same order as their declaration in router. | {"type": "array", "items": {"type": "string"}} |
traefik-v2-file-provider.json | service | Each request must eventually be handled by a service, which is why each router definition should include a service target, which is basically where the request will be passed along to. HTTP routers can only target HTTP services (not TCP services). | {"type": "string"} |
traefik-v2-file-provider.json | tls | When a TLS section is specified, it instructs Traefik that the current router is dedicated to HTTPS requests only (and that the router should ignore HTTP (non TLS) requests). Traefik will terminate the SSL connections (meaning that it will send decrypted data to the services). If you need to define the same route for both HTTP and HTTPS requests, you will need to define two different routers: one with the tls section, one without. | {"type": "object", "properties": {"options": {"type": "string"}, "certResolver": {"type": "string"}, "domains": {"type": "array", "items": {"type": "object", "properties": {"main": {"type": "string"}, "sans": {"type": "array", "items": {"type": "string"}}}}}}} |
traefik-v2-file-provider.json | options | The options field enables fine-grained control of the TLS parameters. It refers to a TLS Options and will be applied only if a Host rule is defined. | {"type": "string"} |
traefik-v2-file-provider.json | certResolver | If certResolver is defined, Traefik will try to generate certificates based on routers Host & HostSNI rules. | {"type": "string"} |
traefik-v2-file-provider.json | domains | You can set SANs (alternative domains) for each main domain. Every domain must have A/AAAA records pointing to Traefik. Each domain & SAN will lead to a certificate request. | {"type": "array", "items": {"type": "object", "properties": {"main": {"type": "string"}, "sans": {"type": "array", "items": {"type": "string"}}}}} |
traefik-v2-file-provider.json | main | Main defines the main domain name. | {"type": "string"} |
traefik-v2-file-provider.json | sans | SANs defines the subject alternative domain names. | {"type": "array", "items": {"type": "string"}} |
traefik-v2-file-provider.json | httpLoadBalancerService | The load balancers are able to load balance the requests between multiple instances of your programs.
Each service has a load-balancer, even if there is only one server to forward traffic to. | {"type": "object", "properties": {"servers": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"url": {"type": "string"}}, "required": ["url"]}}, "sticky": {"type": "object", "properties": {"cookie": {"type": "object", "properties": {"name": {"type": "string"}, "secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "default": ""}}}}}, "healthCheck": {"type": "object", "properties": {"method": {"type": "string"}, "path": {"type": "string"}, "scheme": {"type": "string"}, "hostname": {"type": "string"}, "port": {"type": "integer"}, "interval": {"type": "string"}, "timeout": {"type": "string"}, "headers": {"type": "object", "additionalProperties": {"type": "string"}}, "followRedirects": {"type": "boolean", "default": true}}}, "passHostHeader": {"type": "boolean", "default": true}, "responseForwarding": {"type": "object", "properties": {"flushInterval": {"type": "string"}}}, "serversTransport": {"type": "string"}}, "additionalProperties": false, "required": ["servers"]} |
traefik-v2-file-provider.json | servers | Servers declare a single instance of your program. | {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"url": {"type": "string"}}, "required": ["url"]}} |
traefik-v2-file-provider.json | url | The url option point to a specific instance. Paths in the servers' url have no effect. If you want the requests to be sent to a specific path on your servers, configure your routers to use a corresponding middleware (e.g. the AddPrefix or ReplacePath) middlewares. | {"type": "string"} |
traefik-v2-file-provider.json | sticky | When sticky sessions are enabled, a cookie is set on the initial request and response to let the client know which server handles the first response. On subsequent requests, to keep the session alive with the same server, the client should resend the same cookie. | {"type": "object", "properties": {"cookie": {"type": "object", "properties": {"name": {"type": "string"}, "secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "default": ""}}}}} |
traefik-v2-file-provider.json | name | The default cookie name is an abbreviation of a sha1 (ex: _1d52e). | {"type": "string"} |
traefik-v2-file-provider.json | sameSite | Can be none, lax, strict or empty. | {"type": "string", "default": ""} |
traefik-v2-file-provider.json | healthCheck | Configure health check to remove unhealthy servers from the load balancing rotation. Traefik will consider your servers healthy as long as they return status codes between 2XX and 3XX to the health check requests (carried out every interval). Traefik keeps monitoring the health of unhealthy servers. If a server has recovered (returning 2xx -> 3xx responses again), it will be added back to the load balancer rotation pool. | {"type": "object", "properties": {"method": {"type": "string"}, "path": {"type": "string"}, "scheme": {"type": "string"}, "hostname": {"type": "string"}, "port": {"type": "integer"}, "interval": {"type": "string"}, "timeout": {"type": "string"}, "headers": {"type": "object", "additionalProperties": {"type": "string"}}, "followRedirects": {"type": "boolean", "default": true}}} |
traefik-v2-file-provider.json | method | If defined, will apply this Method for the health check request. | {"type": "string"} |
traefik-v2-file-provider.json | path | path is appended to the server URL to set the health check endpoint. | {"type": "string"} |
traefik-v2-file-provider.json | scheme | If defined, will replace the server URL scheme for the health check endpoint | {"type": "string"} |
traefik-v2-file-provider.json | hostname | If defined, will apply Host header hostname to the health check request. | {"type": "string"} |
traefik-v2-file-provider.json | port | If defined, will replace the server URL port for the health check endpoint. | {"type": "integer"} |
traefik-v2-file-provider.json | interval | Defines the frequency of the health check calls. Interval is to be given in a format understood by `time.ParseDuration`. The interval must be greater than the timeout. If configuration doesn't reflect this, the interval will be set to timeout + 1 second. | {"type": "string"} |
traefik-v2-file-provider.json | timeout | Defines the maximum duration Traefik will wait for a health check request before considering the server failed (unhealthy). Timeout is to be given in a format understood by `time.ParseDuration`. | {"type": "string"} |
traefik-v2-file-provider.json | headers | Defines custom headers to be sent to the health check endpoint. | {"type": "object", "additionalProperties": {"type": "string"}} |
traefik-v2-file-provider.json | followRedirects | Defines whether redirects should be followed during the health check calls (default: true). | {"type": "boolean", "default": true} |
traefik-v2-file-provider.json | passHostHeader | The passHostHeader allows to forward client Host header to server. By default, passHostHeader is true. | {"type": "boolean", "default": true} |
traefik-v2-file-provider.json | responseForwarding | Defines how Traefik forwards the response from the backend server to the client. | {"type": "object", "properties": {"flushInterval": {"type": "string"}}} |
traefik-v2-file-provider.json | flushInterval | Specifies the interval in between flushes to the client while copying the response body. It is a duration in milliseconds, defaulting to 100. A negative value means to flush immediately after each write to the client. The flushInterval is ignored when ReverseProxy recognizes a response as a streaming response; for such responses, writes are flushed to the client immediately. | {"type": "string"} |
traefik-v2-file-provider.json | httpWeightedService | The WRR is able to load balance the requests between multiple services based on weights.
This strategy is only available to load balance between services and not between servers. | {"type": "object", "properties": {"services": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "weight": {"type": "number"}}}}, "sticky": {"type": "object", "properties": {"cookie": {"type": "object", "properties": {"name": {"type": "string"}, "secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "default": ""}}}}}, "healthCheck": {"type": "object"}}, "additionalProperties": false} |
traefik-v2-file-provider.json | sticky | When sticky sessions are enabled, a cookie is set on the initial request and response to let the client know which server handles the first response. On subsequent requests, to keep the session alive with the same server, the client should resend the same cookie. | {"type": "object", "properties": {"cookie": {"type": "object", "properties": {"name": {"type": "string"}, "secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "default": ""}}}}} |
traefik-v2-file-provider.json | name | The default cookie name is an abbreviation of a sha1 (ex: _1d52e). | {"type": "string"} |
traefik-v2-file-provider.json | sameSite | Can be none, lax, strict or empty. | {"type": "string", "default": ""} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.