Array_of_ServerConfig

Type: array
No Additional Items

Each item of this array must be:

root ServerConfig
Type: object

Server specific configuration settings.

 No Additional Properties

root root items body_buffer_size
Type: integer or nullFormat: uint Default: null

Default maximum buffer-size when reading messages into memory.

root root items directives
Type: array

Request handling directives associated with server instance.

 No Additional Items

Each item of this array must be:

root root items directives DirectiveCfg
Type: object

Group of request modules bound to a specific uri path prefix.

 No Additional Properties

root root items directives directives items construct
Type: array

List of additional web components bound to directive.

Items are constructed in the order they're given
meaning middlewares only wrap elements defined before them.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct Component
Type: object

Module or Middleware Component

root root items directives directives items construct construct items oneOf item 0
Type: object
No Additional Properties

root root items directives directives items construct construct items oneOf item 0 Middleware
Type: object

Middleware configuration for request processing.

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 0
Type: object

Configuration for [actix_authn::basic::BasicAuthSession] Middleware.

 No Additional Properties

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 0 cache_size
Type: integer or nullFormat: uint

Cache size linked to authentication lookup

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 0 htpasswd
Type: array of string

Htpasswd filepaths to load credentials from.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 0 htpasswd htpasswd items
Type: string

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 1
Type: object

Configuration for [actix_authn::basic::BasicAuthSession] Middleware.

 No Additional Properties

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 1 cache_size
Type: integer or nullFormat: uint

Cache size linked to authentication lookup

Default is u16::MAX

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 1 htpasswd
Type: array of string

Htpasswd filepaths to load credentials from.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 1 htpasswd htpasswd items
Type: string

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 2
Type: object

Configuration for [actix_ipware] Middleware.

 No Additional Properties

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 2 allow_untrusted
Type: boolean Default: false

Allow untrusted client IP assignments.

Default is false

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 2 proxy_count
Type: integer or nullFormat: uint16 Default: null

Number of expected proxy jumps to be trusted.

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 2 strict
Type: boolean or null Default: null

Allow fake/broken ips in trusted headers if false.

Default is true

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 2 trusted_headers
Type: array of string Default: []

Trusted headers to parse client IP address from.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 2 trusted_headers trusted_headers items
Type: string

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 2 trusted_proxies
Type: array of string Default: []

List of trusted upstream proxy globs.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 2 trusted_proxies trusted_proxies items
Type: string
root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 3
Type: object

Configuration for [actix_ip_filter] Middleware.

 No Additional Properties

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 3 blacklist
Type: array of string Default: []

Always denied blacklist of IP Globs.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 3 blacklist blacklist items
Type: string

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 3 exclude
Type: array of string Default: []

Paths globs to specifically exclude from protection.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 3 exclude exclude items
Type: string

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 3 protect
Type: array of string Default: []

Path globs to specifically include for protection.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 3 protect protect items
Type: string

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 3 whitelist
Type: array of string Default: []

Always allowed whitelist of IP Globs.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 3 whitelist whitelist items
Type: string
root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 4
Type: object

Configuration for [actix_modsecurity] Middleware.

 No Additional Properties

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 4 max_request_body_size
Type: integer or nullFormat: uint Default: null

Max request body size allowed to be read into memory for scanning.

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 4 max_response_body_size
Type: integer or nullFormat: uint Default: null

Max response body size allowed to be read into memory for scanning.

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 4 rule_files
Type: array of string Default: []

List of additional files to load rules from.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 4 rule_files rule_files items
Type: string

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 4 rules
Type: string or null Default: null

Plaintext rules contained within a single string.

See [actix_modsecurity::ModSecurity::add_rules] for more info.
root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 5
Type: object

Configuration for [actix_rewrite] Middleware.

 No Additional Properties

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 5 max_iterations
Type: integer or nullFormat: uint Default: null

Max number of iterations allowed for looping rulesets.

Default is 10.

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 5 rule_files
Type: array of string Default: []

List of additional files to load rules from.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 5 rule_files rule_files items
Type: string

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 5 rules
Type: string or null Default: null

Plaintext rules contained within a single string.

See [actix_rewrite::Engine::add_rules] for more info.
root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 6
Type: object

Configuration for [actix_extensible_rate_limit] Middleware

 No Additional Properties

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 6 fail_open
Type: boolean Default: false

Allow request by default if backend fails to respond in time

Default is false

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 6 limit
Type: integerFormat: uint64

Request limit

Value must be greater or equal to 0

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 6 response_headers
Type: boolean Default: false

Include ratelimit explanation headers if enabled

Default is false

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 6 use_path
Type: boolean Default: false

Discriminate ratelimit by IP and Path if enabled

Default is false
root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 7
Type: object

Configuration for [actix_timeout] Middleware

 No Additional Properties

root root items directives directives items construct construct items oneOf item 0 Middleware oneOf item 7 duration
Type: integerFormat: uint64 Default: 0

Timeout duration in miliseconds

Value must be greater or equal to 0

root root items directives directives items construct construct items oneOf item 1
Type: object
No Additional Properties

root root items directives directives items construct construct items oneOf item 1 Module
Type: object

Server specific configuration modules for request processing.

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 0
Type: object

Configuration for buitltin redirect service.

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 0 status_code
Type: integer or nullFormat: uint16

Redirect status code

Default is 302
root root items directives directives items construct construct items oneOf item 1 Module oneOf item 1
Type: object

Configuration for builtin static response service.

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 1 body
Type: string or null Default: null

Static body content

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 1 content_type
Type: string or null Default: null

Content type override

Default is text/html

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 1 headers
Type: object Default: {}

Headers to append to response

Each additional property must conform to the following schema

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 1 headers additionalProperties
Type: string

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 1 status_code
Type: integer or nullFormat: uint16 Default: null

Content status code

Default is 200
root root items directives directives items construct construct items oneOf item 1 Module oneOf item 2
Type: object

Configuration for [actix_files] service.

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 2 async_threshold
Type: integer or nullFormat: uint64 Default: null

Size Threshold for Asyncly Processing Files

Default is u16::MAX (65_365)

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 2 hidden_files
Type: boolean Default: false

Allow serving hidden files that begin with a .

Default is false.

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 2 index_files
Type: boolean Default: false

Allow director indexing to browse files.

Default is false

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 2 root
Type: string or null Default: null

Root filepath for serving files

Overrides [crate::config::ServerConfig::root]
root root items directives directives items construct construct items oneOf item 1 Module oneOf item 3
Type: object

Configuration for [actix_revproxy] service.

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 3 change_host
Type: boolean Default: false

Change host to upstream address host.

Default is false

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 3 downstream_headers
Type: object Default: {}

Downstream headers to send to client.

Each additional property must conform to the following schema

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 3 downstream_headers additionalProperties
Type: string

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 3 initial_conn_size
Type: integer or nullFormat: uint32

Initial Connection Window Size

Default is u16::MAX

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 3 initial_window_size
Type: integer or nullFormat: uint32

Initial Window Size

Default is u16::MAX

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 3 max_redirects
Type: integer or nullFormat: uint8

Max number of redirects allowed in client lookup.

Default is 0.

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 3 upstream_headers
Type: object Default: {}

Upstream headers to send to server.

Each additional property must conform to the following schema

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 3 upstream_headers additionalProperties
Type: string

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 3 verify_ssl
Type: boolean or null

Verify SSL Configuration

Default is true
root root items directives directives items construct construct items oneOf item 1 Module oneOf item 4
Type: object

Configuration for [actix_fastcgi] service.

root root items directives directives items construct construct items oneOf item 1 Module oneOf item 4 root
Type: string or null

Document-Root assigned to FastCGI.

Overrides [crate::config::ServerConfig::root].

root root items directives directives items construct construct items oneOf item 1 Module next
Type: array of integer or null Default: null

Override of [actix_chain::Link::next] behavior.

 No Additional Items

Each item of this array must be:

root root items directives directives items construct construct items oneOf item 1 Module next next items
Type: integerFormat: uint16

Value must be greater or equal to 0 and lesser or equal to 65535

root root items directives directives items location
Type: string or null

Location associated with modules

Default is /

root root items disable
Type: boolean Default: false

Disable configuration from initialization within server.

root root items index
Type: array of string Default: []

List of supported index file patterns when requesting resources.

Default is [index.html, ]

 No Additional Items

Each item of this array must be:

root root items index index items
Type: string

root root items listen
Type: array

List of configurations for binding server addresses.

 No Additional Items

Each item of this array must be:

root root items listen ListenCfg
Type: object

Server listener bindings configuration.

 No Additional Properties

root root items listen listen items host
Type: string or null

Host address server will bind to.

root root items listen listen items port
Type: integerFormat: uint16

Port server will bind to.

Value must be greater or equal to 0 and lesser or equal to 65535

root root items listen listen items ssl

SSL configuration for listener.

root root items listen listen items ssl anyOf SSLCfg
Type: object

TLS Configuration for server listener.

 No Additional Properties

root root items listen listen items ssl anyOf item 0 certificate
Type: string

TLS Certificate public key.

root root items listen listen items ssl anyOf item 0 certificate_key
Type: string

TLS Certificate private key.
root root items listen listen items ssl anyOf item 1
Type: null

root root items logging
Type: object

Configuration settings for logging.

 No Additional Properties

root root items logging disable
Type: boolean Default: false

Disable logging if set to true

root root items logging log_level

Logging level attached to log.

Default is INFO

root root items logging use_ipware
Type: boolean or null Default: null

Use IpWare Middleware RealIP if enabled.

Default is true

root root items middleware
Type: array

Configuration settings for middlware within server instance.

 No Additional Items

Each item of this array must be:

root root items middleware Middleware
Type: object

Middleware configuration for request processing.

Same definition as Middleware

root root items root
Type: string or null Default: null

Default root filepath for various request handling modules.

root root items sanitize_errors
Type: boolean or null Default: null

Sanitizes error-messages produced by configured modules when enabled.

Default is true

root root items server_name
Type: array

List of domain-names matchers with the server.

Once registered, the server will only respond to
requests with Host set to the relevant matchers.

 No Additional Items

Each item of this array must be:

root root items server_name DomainMatch
Type: string