configuration.md

Configuration

General

Name	Type	Description
HOST	str	The listening address of the server (eg: 127.0.0.1 or 0.0.0.0).
PORT	int	The port the server will listen at (eg: 8080).
IPV6	bool	If IPv6 should be enabled for the server/client, by default the created socket is either IPV4 or IPv6 only, note that under Linux dual stack is provided for "free" for IPv6 stacks (defaults to False).
SSL	bool	If the server is going to use SSL/TLS (Secure Sockets Layer).
UNIX_PATH	str	The path to the file that is going to be used for Unix domain sockets (defaults to $PORT), note that under the hood the port variable is used as the path for the socket.
BACKLOG	int	The number of connections to be hold waiting in queue while pending accept operation.
ALLOWED	list	Sequence of IP or Subnet addresses (eg: 172.16.0.0/16) that are considered to be allowed as clients for a given server, any client connection with an IP address not contained in the list will be dropped (defaults to []).
CHILDREN	int	Number of child processes that are meant to be created upon launch using a pre-fork approach (defaults to 0).
CHILD	int	Same as CHILDREN.
MIDDLEWARE	list	The middleware as a set of strings (eg: proxy) that is going to be loaded into the instance, the notation used to define the modules to be loaded should be underscore based (notice that loading extra middleware into an instance may impact the performance of the same).
SECURE	bool	Control if a secure production environment should be ensured by hiding some critical information (eg: version) (defaults to True).

Logging

Name	Type	Description
LOGGER_FLUSH_TIMEOUT	float	The amount of time in seconds in between flush operations on the logging handlers (defaults to 60.0).

Internal

Name	Type	Description
ASYNCIO	bool	If the asyncio mode should be used, meaning that the loop retrieval method to be used is the one provided by the asyncio module, in case no asyncio support exists the flag is ignored (defaults to False).
COMPAT	bool	If the "heavyweight" compatibility mode should be ensured so that some operations will use an asyncio compatible way of performing execution, using this mode has performance implications (defaults to False).
POLL	str	The name of the polling system to be used for the controlling of the main event loop by default this values is inferred automatically based on the current system capabilities.
POLL_TIMEOUT	float	The timeout in seconds for each of the iteration of the event loop, this value should be carefully chosen as it controls the minimum resolution of a delayed execution.
KEEPALIVE_TIMEOUT	int	The amount of time in seconds that a connection is set as idle until a new refresh token is sent to it to make sure that it's still online and not disconnected, make sure that this value is high enough that it does not consume to much bandwidth.
KEEPALIVE_INTERVAL	int	The time between the retrying of "ping" packets, this value does not need to be too large and should not be considered too important (may be calculated automatically).
KEEPALIVE_COUNT	int	The amount of times the "ping" packet is re-sent until the connection is considered to be offline and is dropped.

Diagnostics

Name	Type	Default	Description
DIAG	bool	False	If the diagnostics system should be launched for the current system, if launched the system will be running as an HTTP server on localhost under port 5050.
DIAG_SERVER	str	netius	The server that is going to be used for serving the diagnostics system infrastructure.
DIAG_HOST	str	127.0.0.1	The hostname that is going to be used when launching the diagnostics system.
DIAG_PORT	int	5050	The TCP port that is going to be used when launching the diagnostics system.

SSL

Name	Type	Description
CER_FILE	str	The path to the certificate file to be used for SSL (PEM format).
KEY_FILE	str	The path to the private key file to be used for SSL (PEM format).
CA_FILE	str	The path to the CA (certificate authority) file to be used for SSL (PEM format).
CA_ROOT	bool	If the default CA file/files should be loaded from the current environment (defaults to True).
SSL_VERIFY	bool	If the standard SSL verification process (CA) should be performed for the connection, if the current instance is a client the host verification will also be performed for the server side host.
SSL_HOST	str	The hostname that is going to be used in for domain verification, this value is only user in server to be able to verify client certificates against an expected host.
SSL_FINGERPRINT	str	The fingerprint (SHA1 digest of certificate) that is going to be used to verify the integrity of a peer/client certificate against the expected one.
SSL_DUMP	bool	If the certificate information should be dumped to the directory specified by the SSL_PATH configuration value (defaults to False).
SSL_PATH	str	Path to the directory where the SSL dump information is going to be placed, in case the directory does not exist it's created (defaults to /tmp/ssl).
SSL_SECURE	int	The level of security to be used for the suite of SSL (eg: some protocols removed) (defaults to 1).
SSL_CONTEXT_OPTIONS	list	List of strings that defined the options to be used in the SSL context creation (eg: OP_NO_SSLv2) for more information check ssl module documentation (defaults to []).
SSL_CONTEXTS	dict	The dictionary that associates the various domains that may be served with different context values (certificate, key, etc) for such domain.
CER_DATA	str	Equivalent to CER_FILE but with explicit (data) contents of the file (\n escaped).
KEY_DATA	str	Equivalent to KEY_FILE but with explicit (data) contents of the file (\n escaped).
CA_DATA	str	Equivalent to CA_FILE but with explicit (data) contents of the file (\n escaped).

File Serving

Name	Type	Description
BASE_PATH	str	The base directory path to be used for the file serving, if not defined the current directory is used instead (defaults to None).
STYLE_URLS	list	The list of URLs that are going to be used to include stylesheets at directory listing.
INDEX_FILES	list	List of file names that should be considered for eligible for index operation (eg: index.html).
PATH_REGEX	list	The list of regex to path values (separated by the : character) that provide a simple way of URL re-writing like behaviour under the file serving extension (eg: .*:index.html).
LIST_DIRS	bool	If directory listing is enabled (may pose a security issue) (defaults to True).
LIST_ENGINE	str	The name of the HTML generation engine to be used while listing files (eg: base, apache, legacy, etc.) (defaults to base).

HTTP

Name	Type	Description
SAFE	bool	If safe execution should be enforced, (eg: avoiding HTTP2 execution) (defaults to False).
COMMON_LOG	str	The path to the file to log the HTTP request in "Common Log Format (defaults to None).

Proxy

Name	Type	Description
DYNAMIC	bool	In case this value is active dynamic connection encoding is applied, meaning that extra heuristics will be applied on a response basis to determine the proper encoding of the response (eg: plain, chunked, gzip, etc.).
THROTTLE	bool	If throttling of the connection stream should be applied on both ways to avoid starvation of the producer consumer relation.
TRUST_ORIGIN	bool	If the origin connection (eg: http client, proxy client, etc.) is meant to be trusted meaning that its information is considered reliable, this value is especially important for proxy to proxy relations (defaults to False).

Proxy Reverse

Name	Type	Description
STS	int	Defines the strict transport security header value (in seconds) for the reverse proxy, in case the value is zero the strict transport security is disabled (defaults to 0).
ECHO	bool	If enabled allows for more verbose output of the rules associated with the reverse proxy (defaults to False).
RESOLVE	bool	If the DNS based resolution of the hosts should be enabled meaning that from time to time the hostname associated with the target URLs is resolved (defaults to True).
RESOLVE_TIMEOUT	float	The amount of seconds between DNS resolution queries (defaults to 120).
HOST_FORWARD	bool	If the Host header for HTTP back-end connections should be resolved from rules, avoiding Host header populated with the IP address (defaults to False).
REUSE	bool	If HTTP connections/rules should be re-used from a proxy point of view, this options may pose a problem when different suffixes are used for the same host (defaults to True).
STRATEGY	str	The load balancing strategy that is going to be used for multiple back-end connections (defaults to smart).
X_FORWARDED_PORT	str	If defined allow "forcing" the X-Forwarded-Port HTTP header (defaults to None).
X_FORWARDED_PROTO	str	If defined allow "forcing" the X-Forwarded-Proto HTTP header (defaults to None).

DNS Client

Name	Type	Description
NAMESERVERS	list	The sequence of DNS servers to be used for forward of resolution requests (defaults to []).
NAMESERVERS_IP4	list	Same as NAMESERVERS but just for IPv4 resolution (defaults to []).
NAMESERVERS_IP6	list	Same as NAMESERVERS but just for IPv6 resolution (defaults to []).

Blacklist Middleware

Name	Type	Description
BLACKLIST	list	List of IP addresses of the connections that should be dropped immediately, use * to drop all of the connections.
WHITELIST	list	Sequence of IP addresses that should be allowed explicitly, use * to allow all of the connection to be accepted.

Flood (Mitigation) Middleware

Name	Type	Description
CONNS_PER_MIN	int	The maximum number of connections per minute allowed per a certain IP before it becomes black listed and connections are dropped (default to 600).
WHITELIST	list	Sequence of IP addresses that should be allowed explicitly, use * to allow all of the connection to be accepted.

PROXY Middleware

Name	Type	Description
PROXY_VERSION	int	The version of the PROXY protocol that is going to be used (defaults to 1).

Annoyer Middleware

Name	Type	Description
ANNOYER_PERIOD	float	The period (in seconds) to wait in between the printing of the "annoying" diagnostics message, this is opposite of the frequency (defaults to 10).