schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
3.0.schema.json | cache | RFC 7234 Souin cache: https://github.com/darkweak/souin/tree/master/plugins/roadrunner | {"type": "object", "properties": {"api": {"type": "object", "properties": {"basepath": {"type": "string", "default": null}, "prometheus": {"type": "object", "properties": {"basepath": {"type": "string", "default": null}}}, "souin": {"type": "object", "properties": {"basepath": {"type": "string", "default": null}}}}}, "cache_keys": {"type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {"type": "object", "properties": {"disable_body": {"type": "boolean", "default": false}, "disable_host": {"type": "boolean", "default": false}, "disable_method": {"type": "boolean", "default": false}}}}}, "cdn": {"type": "object", "properties": {"api_key": {"type": "string"}, "provider": {"type": "string", "enum": ["fastly", "cloudflare", "akamai", "varnish"]}, "strategy": {"type": "string", "enum": ["soft", "hard"]}, "dynamic": {"type": "boolean", "default": false}}}, "default_cache": {"type": "object", "properties": {"allowed_http_verbs": {"type": "array", "default": ["GET", "POST"]}, "cache_name": {"type": "string", "default": "roadrunner"}, "distributed": {"type": "boolean", "default": false}, "headers": {"type": "array", "default": null}, "key": {"type": "object", "properties": {"disable_body": {"type": "boolean", "default": false}, "disable_host": {"type": "boolean", "default": false}, "disable_method": {"type": "boolean", "default": false}}}, "etcd": {"type": "object", "properties": {"configuration": {"type": "object", "properties": {"endpoints": {"type": "array", "default": null}}}}}, "olric": {"type": "object", "properties": {"url": {"type": "string", "default": "http://127.0.0.1:3320"}}}, "regex": {"type": "object", "properties": {"exclude": {"type": "string", "default": null}}}, "stale": {"type": "string", "default": "1000s"}, "timeout": {"type": "object", "properties": {"backend": {"type": "string", "default": "10s"}, "cache": {"type": "string", "default": "20ms"}}}, "ttl": {"type": "string", "default": "1000s"}, "default_cache_control": {"type": "string", "default": "no-store"}}}, "log_level": {"type": "string", "default": "INFO", "enum": ["DEBUG", "INFO", "WARN", "DPANIC", "PANIC", "ERROR", "FATAL"]}}} |
3.0.schema.json | api | The cache-handler API cache management | {"type": "object", "properties": {"basepath": {"type": "string", "default": null}, "prometheus": {"type": "object", "properties": {"basepath": {"type": "string", "default": null}}}, "souin": {"type": "object", "properties": {"basepath": {"type": "string", "default": null}}}}} |
3.0.schema.json | basepath | Default route basepath for every additional APIs to avoid conflicts with existing routes | {"type": "string", "default": null} |
3.0.schema.json | prometheus | Prometheus exposed metrics | {"type": "object", "properties": {"basepath": {"type": "string", "default": null}}} |
3.0.schema.json | souin | Souin listing keys and cache management | {"type": "object", "properties": {"basepath": {"type": "string", "default": null}}} |
3.0.schema.json | ^[a-zA-Z0-9._-]+$ | cache keys configuration | {"type": "object", "properties": {"disable_body": {"type": "boolean", "default": false}, "disable_host": {"type": "boolean", "default": false}, "disable_method": {"type": "boolean", "default": false}}} |
3.0.schema.json | cdn | If Souin is set after a CDN fill these information | {"type": "object", "properties": {"api_key": {"type": "string"}, "provider": {"type": "string", "enum": ["fastly", "cloudflare", "akamai", "varnish"]}, "strategy": {"type": "string", "enum": ["soft", "hard"]}, "dynamic": {"type": "boolean", "default": false}}} |
3.0.schema.json | api_key | Your provider API key if mandatory | {"type": "string"} |
3.0.schema.json | provider | The provider placed before Souin (e.g. fastly, cloudflare, akamai, varnish) | {"type": "string", "enum": ["fastly", "cloudflare", "akamai", "varnish"]} |
3.0.schema.json | strategy | The strategy to purge the CDN cache based on tags (e.g. soft, hard) | {"type": "string", "enum": ["soft", "hard"]} |
3.0.schema.json | dynamic | If true, you'll be able to add custom keys than the ones defined under the surrogate_keys key | {"type": "boolean", "default": false} |
3.0.schema.json | cache_name | Override the cache name to use in the Cache-Status header | {"type": "string", "default": "roadrunner"} |
3.0.schema.json | distributed | Use Olric or Etcd distributed storage | {"type": "boolean", "default": false} |
3.0.schema.json | headers | Default headers concatenated in stored keys | {"type": "array", "default": null} |
3.0.schema.json | etcd | If distributed is set to true, you'll have to define either the etcd or olric section | {"type": "object", "properties": {"configuration": {"type": "object", "properties": {"endpoints": {"type": "array", "default": null}}}}} |
3.0.schema.json | configuration | Configure directly the Etcd client | {"type": "object", "properties": {"endpoints": {"type": "array", "default": null}}} |
3.0.schema.json | endpoints | Define multiple endpoints | {"type": "array", "default": null} |
3.0.schema.json | olric | If distributed is set to true, you'll have to define either the etcd or olric section | {"type": "object", "properties": {"url": {"type": "string", "default": "http://127.0.0.1:3320"}}} |
3.0.schema.json | url | Olric server | {"type": "string", "default": "http://127.0.0.1:3320"} |
3.0.schema.json | regex | Regex to exclude from cache | {"type": "object", "properties": {"exclude": {"type": "string", "default": null}}} |
3.0.schema.json | stale | Stale duration | {"type": "string", "default": "1000s"} |
3.0.schema.json | timeout | Timeout configuration | {"type": "object", "properties": {"backend": {"type": "string", "default": "10s"}, "cache": {"type": "string", "default": "20ms"}}} |
3.0.schema.json | backend | Backend timeout before returning an HTTP unavailable response | {"type": "string", "default": "10s"} |
3.0.schema.json | cache | Cache provider (badger, etcd, nutsdb, olric, depending the configuration you set) timeout before returning a miss | {"type": "string", "default": "20ms"} |
3.0.schema.json | ttl | Default TTL | {"type": "string", "default": "1000s"} |
3.0.schema.json | default_cache_control | Set default value for Cache-Control response header if not set by upstream | {"type": "string", "default": "no-store"} |
3.0.schema.json | log_level | Logs verbosity | {"type": "string", "default": "INFO", "enum": ["DEBUG", "INFO", "WARN", "DPANIC", "PANIC", "ERROR", "FATAL"]} |
3.0.schema.json | dir | Directory for file uploads. Empty value means to use $TEMP based on your OS | {"type": "string", "examples": ["/tmp"], "default": ""} |
3.0.schema.json | forbid | Deny files with the following extensions to upload | {"type": "array", "items": {"type": "string", "examples": [".php", ".exe"]}, "default": [".php", ".exe", ".bat"]} |
3.0.schema.json | allow | Allow files with the following extensions to upload | {"type": "array", "items": {"type": "string", "examples": [".html", ".go"]}, "default": ""} |
3.0.schema.json | headers | HTTP headers map | {"type": "object", "properties": {"cors": {"type": "object", "properties": {"allowed_origin": {"type": "string", "examples": ["*"], "default": ""}, "allowed_headers": {"type": "string", "examples": ["*"], "default": ""}, "allowed_methods": {"type": "string", "examples": ["GET,POST,PUT,DELETE"], "default": ""}, "allow_credentials": {"type": "boolean", "default": false}, "exposed_headers": {"type": "string", "examples": ["Cache-Control,Content-Language,Content-Type,Expires,Last-Modified,Pragma"], "default": ""}, "max_age": {"type": "integer", "examples": [600], "default": 0}}}, "request": {}, "response": {}}} |
3.0.schema.json | cors | Allows to control CORS headers | {"type": "object", "properties": {"allowed_origin": {"type": "string", "examples": ["*"], "default": ""}, "allowed_headers": {"type": "string", "examples": ["*"], "default": ""}, "allowed_methods": {"type": "string", "examples": ["GET,POST,PUT,DELETE"], "default": ""}, "allow_credentials": {"type": "boolean", "default": false}, "exposed_headers": {"type": "string", "examples": ["Cache-Control,Content-Language,Content-Type,Expires,Last-Modified,Pragma"], "default": ""}, "max_age": {"type": "integer", "examples": [600], "default": 0}}} |
3.0.schema.json | allowed_origin | Controls 'Access-Control-Allow-Origin' header value | {"type": "string", "examples": ["*"], "default": ""} |
3.0.schema.json | allowed_headers | Controls 'Access-Control-Allow-Headers' header value | {"type": "string", "examples": ["*"], "default": ""} |
3.0.schema.json | allowed_methods | Controls 'Access-Control-Allow-Methods' header value | {"type": "string", "examples": ["GET,POST,PUT,DELETE"], "default": ""} |
3.0.schema.json | allow_credentials | Controls 'Access-Control-Allow-Credentials' header value | {"type": "boolean", "default": false} |
3.0.schema.json | exposed_headers | Controls 'Access-Control-Expose-Headers' header value | {"type": "string", "examples": ["Cache-Control,Content-Language,Content-Type,Expires,Last-Modified,Pragma"], "default": ""} |
3.0.schema.json | max_age | Controls 'Access-Control-Max-Age' header value (in seconds) | {"type": "integer", "examples": [600], "default": 0} |
3.0.schema.json | request | Automatically add headers to every request passed to PHP | {} |
3.0.schema.json | response | Automatically add headers to every response | {} |
3.0.schema.json | static | Static assets serving settings | {"type": "object", "properties": {"dir": {"type": "string", "examples": [".", "/var/www/html"]}, "forbid": {"type": "array", "items": {"type": "string", "examples": [".php", ".htaccess"]}}, "allow": {"type": "array", "items": {"type": "string", "examples": [".php", ".htaccess"]}}, "calculate_etag": {"type": "boolean"}, "weak": {"type": "boolean"}, "response": {}}, "required": ["dir"]} |
3.0.schema.json | dir | Path to the directory with static assets | {"type": "string", "examples": [".", "/var/www/html"]} |
3.0.schema.json | forbid | File extensions that should not be served | {"type": "array", "items": {"type": "string", "examples": [".php", ".htaccess"]}} |
3.0.schema.json | allow | File extensions which should be served | {"type": "array", "items": {"type": "string", "examples": [".php", ".htaccess"]}} |
3.0.schema.json | calculate_etag | Turn on etag computation for the static file | {"type": "boolean"} |
3.0.schema.json | weak | Use a weak generator (/W), it uses only filename to generate a CRC32 sum | {"type": "boolean"} |
3.0.schema.json | response | Custom headers for the static files | {} |
3.0.schema.json | pool | Workers pool settings | {} |
3.0.schema.json | ssl | SSL (Secure Sockets Layer) settings | {"type": "object", "properties": {"address": {"examples": ["127.0.0.1:443", ":8443"]}, "acme": {"type": "object", "properties": {"certs_dir": {"type": "string", "default": "rr_cache"}, "email": {"type": "string"}, "alt_http_port": {"type": "integer", "default": 80}, "alt_tlsalpn_port": {"type": "integer", "default": 443}, "challenge_type": {"type": "string", "enum": ["http-01", "tlsalpn-01"], "default": "http-01"}, "use_production_endpoint": {"type": "boolean", "default": false}, "domains": {"type": "array"}}, "required": ["domains", "email"]}, "redirect": {"type": "boolean", "default": false}, "cert": {"type": "string", "minLength": 1, "examples": ["/ssl/server.crt"]}, "key": {"type": "string", "minLength": 1, "examples": ["/ssl/server.key"]}, "root_ca": {"type": "string", "minLength": 1, "examples": ["/ssl/root.crt"]}, "client_auth_type": {"type": "string", "default": "no_client_certs", "enum": ["request_client_cert", "require_any_client_cert", "verify_client_cert_if_given", "no_client_certs", "require_and_verify_client_cert"]}}, "required": ["address", "cert", "key"]} |
3.0.schema.json | address | Host and port to listen on | {"examples": ["127.0.0.1:443", ":8443"]} |
3.0.schema.json | acme | ACME certificates provider (Let's encrypt) | {"type": "object", "properties": {"certs_dir": {"type": "string", "default": "rr_cache"}, "email": {"type": "string"}, "alt_http_port": {"type": "integer", "default": 80}, "alt_tlsalpn_port": {"type": "integer", "default": 443}, "challenge_type": {"type": "string", "enum": ["http-01", "tlsalpn-01"], "default": "http-01"}, "use_production_endpoint": {"type": "boolean", "default": false}, "domains": {"type": "array"}}, "required": ["domains", "email"]} |
3.0.schema.json | certs_dir | Directory to use as a certificate/pk, account info storage | {"type": "string", "default": "rr_cache"} |
3.0.schema.json | email | User email, used to create LE account | {"type": "string"} |
3.0.schema.json | alt_http_port | Alternate port for the http challenge. Challenge traffic should be redirected to this port if overridden. | {"type": "integer", "default": 80} |
3.0.schema.json | alt_tlsalpn_port | Alternate port for the tls-alpn-01 challenge. Challenge traffic should be redirected to this port if overridden. | {"type": "integer", "default": 443} |
3.0.schema.json | challenge_type | Challenge types | {"type": "string", "enum": ["http-01", "tlsalpn-01"], "default": "http-01"} |
3.0.schema.json | use_production_endpoint | Use production or staging endpoint. NOTE, try to use staging endpoint to make sure, that everything works correctly. | {"type": "boolean", "default": false} |
3.0.schema.json | domains | List of your domains to obtain certificates | {"type": "array"} |
3.0.schema.json | redirect | Automatic redirect from http to https schema | {"type": "boolean", "default": false} |
3.0.schema.json | cert | Path to the cert file | {"type": "string", "minLength": 1, "examples": ["/ssl/server.crt"]} |
3.0.schema.json | key | Path to the cert key file | {"type": "string", "minLength": 1, "examples": ["/ssl/server.key"]} |
3.0.schema.json | root_ca | Path to the root certificate authority file | {"type": "string", "minLength": 1, "examples": ["/ssl/root.crt"]} |
3.0.schema.json | client_auth_type | Client auth type | {"type": "string", "default": "no_client_certs", "enum": ["request_client_cert", "require_any_client_cert", "verify_client_cert_if_given", "no_client_certs", "require_and_verify_client_cert"]} |
3.0.schema.json | fcgi | FastCGI frontend support | {"type": "object", "properties": {"address": {"type": "string", "examples": ["tcp://0.0.0.0:7921"]}}, "required": ["address"]} |
3.0.schema.json | address | FastCGI connection DSN. Supported TCP and Unix sockets. An empty value disables this | {"type": "string", "examples": ["tcp://0.0.0.0:7921"]} |
3.0.schema.json | http2 | HTTP/2 settings | {"type": "object", "properties": {"h2c": {"type": "boolean", "default": false}, "max_concurrent_streams": {"type": "integer", "default": 128, "minimum": 0}}} |
3.0.schema.json | h2c | HTTP/2 over non-encrypted TCP connection using H2C | {"type": "boolean", "default": false} |
3.0.schema.json | max_concurrent_streams | Maximal concurrent streams count | {"type": "integer", "default": 128, "minimum": 0} |
3.0.schema.json | redis | Redis section. | {"type": "object"} |
3.0.schema.json | metrics | Application metrics in Prometheus format (docs: https://roadrunner.dev/docs/beep-beep-metrics) | {"type": "object", "properties": {"address": {"type": "string", "default": "127.0.0.1:2112"}, "collect": {"type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {"type": "object", "properties": {"type": {"type": "string", "enum": ["histogram", "gauge", "counter", "summary"]}, "help": {"type": "string"}, "labels": {"type": "array", "minItems": 1}, "buckets": {"type": "array", "items": {"type": "number"}}, "objectives": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "number"}}}}}}}}} |
3.0.schema.json | address | Prometheus client address (path /metrics added automatically). | {"type": "string", "default": "127.0.0.1:2112"} |
3.0.schema.json | collect | Application-specific metrics (published using an RPC connection to the server) | {"type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {"type": "object", "properties": {"type": {"type": "string", "enum": ["histogram", "gauge", "counter", "summary"]}, "help": {"type": "string"}, "labels": {"type": "array", "minItems": 1}, "buckets": {"type": "array", "items": {"type": "number"}}, "objectives": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "number"}}}}}}} |
3.0.schema.json | help | Help message | {"type": "string"} |
3.0.schema.json | labels | Metrics labels | {"type": "array", "minItems": 1} |
3.0.schema.json | status | Health check endpoint (docs: https://roadrunner.dev/docs/beep-beep-health). If response code is 200 - it means at least one worker ready to serve requests. 500 - there are no workers ready to service requests. | {"type": "object", "properties": {"address": {"type": "string", "examples": ["127.0.0.1:2114"]}, "unavailable_status_code": {"type": "integer", "default": 503}}, "required": ["address"]} |
3.0.schema.json | address | Host and port to listen on (eg.: `127.0.0.1:2114`). Use the following URL: http://127.0.0.1:2114/health?plugin=http. Multiple plugins must be separated using & - http://127.0.0.1:2114/health?plugin=http&plugin=rpc where http and rpc are active (connected) plugins. | {"type": "string", "examples": ["127.0.0.1:2114"]} |
3.0.schema.json | unavailable_status_code | Response status code if a requested plugin not ready to handle requests. Valid for both /health and /ready endpoints | {"type": "integer", "default": 503} |
3.0.schema.json | reload | Automatically detect PHP file changes and reload connected services | {"type": "object", "properties": {"interval": {"default": "1s"}, "patterns": {"type": "array", "items": {"type": "string", "examples": [".php", ".json"]}, "default": [".php"]}, "services": {"type": "object", "minProperties": 0, "patternProperties": {"^[a-zA-Z0-9._-]+$": {"type": "object", "properties": {"dirs": {"type": "array", "default": [], "items": {"type": "string", "examples": [".", "/app/src"], "minLength": 1}}, "recursive": {"type": "boolean", "default": false}, "ignore": {"type": "array", "default": [], "items": {"type": "string", "examples": ["vendor", "/app/logs"], "minLength": 1}}, "patterns": {"type": "array", "default": [], "items": {"type": "string", "examples": [".php", ".go", ".md"], "minLength": 1}}}}}, "additionalProperties": false}}} |
3.0.schema.json | interval | Sync interval | {"default": "1s"} |
3.0.schema.json | patterns | Global patterns to sync | {"type": "array", "items": {"type": "string", "examples": [".php", ".json"]}, "default": [".php"]} |
3.0.schema.json | services | List of included for sync services (this is a map, where key name is a plugin name) | {"type": "object", "minProperties": 0, "patternProperties": {"^[a-zA-Z0-9._-]+$": {"type": "object", "properties": {"dirs": {"type": "array", "default": [], "items": {"type": "string", "examples": [".", "/app/src"], "minLength": 1}}, "recursive": {"type": "boolean", "default": false}, "ignore": {"type": "array", "default": [], "items": {"type": "string", "examples": ["vendor", "/app/logs"], "minLength": 1}}, "patterns": {"type": "array", "default": [], "items": {"type": "string", "examples": [".php", ".go", ".md"], "minLength": 1}}}}}, "additionalProperties": false} |
3.0.schema.json | dirs | Directories to sync. If recursive is set to true, recursive sync will be applied only to the directories in 'dirs' section. Dot (.) means 'current working directory' | {"type": "array", "default": [], "items": {"type": "string", "examples": [".", "/app/src"], "minLength": 1}} |
3.0.schema.json | recursive | Recursive search for file patterns to add | {"type": "boolean", "default": false} |
3.0.schema.json | ignore | Ignored folders | {"type": "array", "default": [], "items": {"type": "string", "examples": ["vendor", "/app/logs"], "minLength": 1}} |
3.0.schema.json | patterns | Service specific file pattens to sync | {"type": "array", "default": [], "items": {"type": "string", "examples": [".php", ".go", ".md"], "minLength": 1}} |
3.0.schema.json | amqp | AMQP jobs driver | {"type": "object", "properties": {"addr": {"type": "string", "default": "amqp://guest:[email protected]:5672"}, "tls": {"properties": {"key": {"type": "string"}, "cert": {"type": "string"}, "root_ca": {"type": "string"}, "client_auth_type": {"type": "string", "default": "no_client_certs", "enum": ["request_client_cert", "require_any_client_cert", "verify_client_cert_if_given", "no_client_certs", "require_and_verify_client_cert"]}}}}} |
3.0.schema.json | addr | AMQP Uri to connect to the rabbitmq server https://www.rabbitmq.com/uri-spec.html | {"type": "string", "default": "amqp://guest:[email protected]:5672"} |
3.0.schema.json | tls | {"properties": {"key": {"type": "string"}, "cert": {"type": "string"}, "root_ca": {"type": "string"}, "client_auth_type": {"type": "string", "default": "no_client_certs", "enum": ["request_client_cert", "require_any_client_cert", "verify_client_cert_if_given", "no_client_certs", "require_and_verify_client_cert"]}}} |
|
3.0.schema.json | key | Path to the key file | {"type": "string"} |
3.0.schema.json | cert | Path to the cert file | {"type": "string"} |
3.0.schema.json | root_ca | Path to the CA certificate, defines the set of root certificate authorities that servers use if required to verify a client certificate. Used with the `client_auth_type` option. | {"type": "string"} |
3.0.schema.json | beanstalk | Beanstalk jobs driver | {"type": "object", "properties": {"addr": {"type": "string", "default": "tcp://127.0.0.1:11300"}, "timeout": {"type": "string", "default": "30s"}}} |
3.0.schema.json | addr | Beanstalk server address | {"type": "string", "default": "tcp://127.0.0.1:11300"} |
3.0.schema.json | timeout | Beanstalk connect timeout | {"type": "string", "default": "30s"} |
3.0.schema.json | sqs | SQS jobs driver (https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html) | {"type": "object", "properties": {"key": {"type": "string", "default": null}, "secret": {"type": "string", "default": null}, "region": {"type": "string", "default": null}, "session_token": {"type": "string", "default": null}, "endpoint": {"type": "string", "default": "http://127.0.0.1:9324"}}} |
3.0.schema.json | key | AccessKey ID | {"type": "string", "default": null} |
3.0.schema.json | secret | Secret Access key | {"type": "string", "default": null} |
3.0.schema.json | region | AWS Region | {"type": "string", "default": null} |
3.0.schema.json | session_token | AWS Session token | {"type": "string", "default": null} |
3.0.schema.json | endpoint | AWS SQS endpoint to connect | {"type": "string", "default": "http://127.0.0.1:9324"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.