Skip to content

Athena::Framework::Bundle::Schema#

Represents the possible properties used to configure and customize Athena Framework features. See the Getting Started docs for more information.

Configuration Properties

default_locale#

type:

String

default:

en

The default locale is used if no _locale routing parameter has been set.


trusted_proxies#

type:

Array(String) | ::Nil

default:

nil

Controls the IP addresses of trusted proxies that'll be used to get precise information about the client.

See the external documentation for more information.


trusted_headers#

default:

Athena::Framework::Request::ProxyHeader[:forwarded_for, :forwarded_port, :forwarded_proto]

Controls which headers your #trusted_proxies use.

See the external documentation for more information.


trusted_hosts#

type:

Array(Regex)

default:

[] of Regex

By default the application can handle requests from any host. This property allows configuring regular expression patterns to control what hostnames the application is allowed to serve. This effectively prevents host header attacks.

If there is at least one pattern defined, requests whose hostname does NOT match any of the patterns, will receive a 400 response.


trusted_header_overrides#

type:

Hash(Athena::Framework::Request::ProxyHeader, String)

default:

{} of NoReturn => NoReturn

Allows overriding the header name to use for a given ATH::Request::ProxyHeader.

See the external documentation for more information.