Back to Authelia

Network

docs/content/configuration/definitions/network.md

4.39.161.6 KB
Original Source

The network section configures named network lists.

Configuration

{{< config-alert-example >}}

yaml
definitions:
  network:
    network_name:
      - '192.168.1.0/24'
      - '192.168.2.20'
      - '2001:db8::/32'
      - '2001:db8:1234:5678::1'

Options

This section describes the individual configuration options. The configuration for this section is incredibly basic, effectively it's key value pairs, where the key is the name used elsewhere in the configuration, and the value is a list of network addresses.

These definitions are used as Access Control Networks and OpenID Connect 1.0 Authorization Policy Networks.

key

The key is the name of the policy. In the example above, the key is network_name and is the value which must be used in other areas of the configuration to reference it.

value

{{< confkey type="string" syntax="network" required="yes" >}}

The values which represent the CIDR notation of the IP's this definition applies to. In the example, the value is a list which contains 192.168.1.0/24, 192.168.2.20, 2001:db8::/32, and 2001:db8:1234:5678::1.

CIDR notation (e.g., 192.168.1.0/24) represents a range of IP addresses. The number after the slash indicates how many bits are used for the network portion. For example, /24 means the first 24 bits are fixed, allowing the last 8 bits to vary (giving you 256 possible addresses). A single IP address like 192.168.2.20 can be written as is or with /32.