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_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.