2022-06-15 07:51:47 +00:00
|
|
|
---
|
|
|
|
title: "Environment"
|
|
|
|
description: "Using the Environment Variable Configuration Method."
|
|
|
|
lead: "Authelia has a layered configuration model. This section describes how to implement the environment configuration."
|
2022-06-28 05:27:14 +00:00
|
|
|
date: 2022-06-15T17:51:47+10:00
|
2022-06-15 07:51:47 +00:00
|
|
|
draft: false
|
|
|
|
images: []
|
|
|
|
menu:
|
|
|
|
configuration:
|
|
|
|
parent: "methods"
|
|
|
|
weight: 101300
|
|
|
|
toc: true
|
|
|
|
---
|
|
|
|
|
|
|
|
Environment variables are applied after the configuration file meaning anything specified as part of the environment
|
|
|
|
overrides the configuration files.
|
|
|
|
|
2023-01-26 02:23:02 +00:00
|
|
|
*__Please Note:__ It is not possible to configure several sections at this time, these include but may nott not be
|
|
|
|
limited to the rules section in access control, the clients section in the OpenID Connect identity provider, the cookies
|
|
|
|
section of in session, and the authz section in the server endpoints.*
|
2022-06-15 07:51:47 +00:00
|
|
|
|
|
|
|
## Prefix
|
|
|
|
|
|
|
|
The environment variables must be prefixed with `AUTHELIA_`. All environment variables that start with this prefix must
|
|
|
|
be for configuration. Any supplied environment variables that have this prefix and are not meant for configuration will
|
|
|
|
likely result in an error or even worse misconfiguration.
|
|
|
|
|
|
|
|
### Kubernetes
|
|
|
|
|
|
|
|
Please see the
|
2022-12-07 09:43:02 +00:00
|
|
|
[Kubernetes Integration: Enable Service Links](../../integration/kubernetes/introduction.md#enable-service-links)
|
2022-06-15 07:51:47 +00:00
|
|
|
documentation for specific requirements for using *Authelia* with Kubernetes.
|
|
|
|
|
|
|
|
## Mapping
|
|
|
|
|
|
|
|
Configuration options are mapped by their name. Levels of indentation / subkeys are replaced by underscores.
|
|
|
|
|
|
|
|
For example this YAML configuration:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
log:
|
|
|
|
level: info
|
|
|
|
server:
|
2022-08-08 21:50:12 +00:00
|
|
|
buffers:
|
|
|
|
read: 4096
|
2022-06-15 07:51:47 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
Can be replaced by this environment variable configuration:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
AUTHELIA_LOG_LEVEL=info
|
2022-08-08 21:50:12 +00:00
|
|
|
AUTHELIA_SERVER_BUFFERS_READ=4096
|
2022-06-15 07:51:47 +00:00
|
|
|
```
|
2022-09-16 04:21:05 +00:00
|
|
|
|
|
|
|
## Environment Variables
|
|
|
|
|
|
|
|
{{% table-config-keys secrets="false" %}}
|