From f2282f78a94fa34219f48baab8c8a886bf9a1a7a Mon Sep 17 00:00:00 2001 From: Amir Zarrinkafsh Date: Wed, 16 Dec 2020 11:31:39 +1100 Subject: [PATCH] [DOCS] Add notes for IPv6 literal address (#1541) --- config.template.yml | 2 +- docs/configuration/authentication/ldap.md | 7 +++++++ docs/configuration/miscellaneous.md | 6 ++++++ docs/configuration/notifier/smtp.md | 6 ++++++ docs/configuration/session.md | 15 +++++++++++++-- docs/configuration/storage/mariadb.md | 7 +++++++ docs/configuration/storage/mysql.md | 7 +++++++ docs/configuration/storage/postgres.md | 7 +++++++ 8 files changed, 54 insertions(+), 3 deletions(-) diff --git a/config.template.yml b/config.template.yml index 004ec9105..4b49f2038 100644 --- a/config.template.yml +++ b/config.template.yml @@ -333,7 +333,7 @@ session: redis: host: 127.0.0.1 port: 6379 - # # Use a unix socket instead + # Use a unix socket instead # host: /var/run/redis/redis.sock diff --git a/docs/configuration/authentication/ldap.md b/docs/configuration/authentication/ldap.md index 654435de2..1c7c7c584 100644 --- a/docs/configuration/authentication/ldap.md +++ b/docs/configuration/authentication/ldap.md @@ -129,6 +129,13 @@ The user must have an email address in order for Authelia to perform identity verification when a user attempts to reset their password or register a second factor device. +## IPv6 Addresses + +If utilising an IPv6 literal address it must enclosed by square brackets: +```yaml +url: ldap://[fd00:1111:2222:3333::1] +``` + ## TLS Settings ### Skip Verify diff --git a/docs/configuration/miscellaneous.md b/docs/configuration/miscellaneous.md index cf378b6d5..80f013fa3 100644 --- a/docs/configuration/miscellaneous.md +++ b/docs/configuration/miscellaneous.md @@ -20,6 +20,12 @@ host: 0.0.0.0 port: 9091 ``` +Note: If utilising an IPv6 literal address it must enclosed by square brackets and quoted: + +```yaml +host: "[fd00:1111:2222:3333::1]" +``` + ## TLS `optional: true` diff --git a/docs/configuration/notifier/smtp.md b/docs/configuration/notifier/smtp.md index ee5aff029..3c005a6d1 100644 --- a/docs/configuration/notifier/smtp.md +++ b/docs/configuration/notifier/smtp.md @@ -61,6 +61,12 @@ notifier: Most configuration options are self-explanatory, however here is an explanation of the ones that may not be as obvious. +### host +If utilising an IPv6 literal address it must enclosed by square brackets and quoted: +```yaml +host: "[fd00:1111:2222:3333::1]" +``` + ### identifier The name to send to the SMTP server as the identifier with the HELO/EHLO command. Some SMTP providers like Google Mail reject the message if it's localhost. diff --git a/docs/configuration/session.md b/docs/configuration/session.md index ca06ab67e..cb0fddde8 100644 --- a/docs/configuration/session.md +++ b/docs/configuration/session.md @@ -48,7 +48,7 @@ session: redis: host: 127.0.0.1 port: 6379 - # # Use a unix socket instead + # Use a unix socket instead # host: /var/run/redis/redis.sock # Password can also be set using a secret: https://docs.authelia.com/configuration/secrets.html @@ -63,4 +63,15 @@ Configuration of this section has an impact on security. You should read notes i ### Duration Notation The configuration parameters expiration, inactivity, and remember_me_duration use duration notation. See the documentation -for [duration notation format](index.md#duration-notation-format) for more information. \ No newline at end of file +for [duration notation format](index.md#duration-notation-format) for more information. + +## IPv6 Addresses + +If utilising an IPv6 literal address it must enclosed by square brackets and quoted: +```yaml +host: "[fd00:1111:2222:3333::1]" +``` + +## Loading a password from a secret instead of inside the configuration + +Password can also be defined using a [secret](../secrets.md). \ No newline at end of file diff --git a/docs/configuration/storage/mariadb.md b/docs/configuration/storage/mariadb.md index 7cd4c23b0..f02305454 100644 --- a/docs/configuration/storage/mariadb.md +++ b/docs/configuration/storage/mariadb.md @@ -19,6 +19,13 @@ storage: password: mypassword ``` +## IPv6 Addresses + +If utilising an IPv6 literal address it must enclosed by square brackets and quoted: +```yaml +host: "[fd00:1111:2222:3333::1]" +``` + ## Loading a password from a secret instead of inside the configuration Password can also be defined using a [secret](../secrets.md). diff --git a/docs/configuration/storage/mysql.md b/docs/configuration/storage/mysql.md index 72f4b021e..d1c385948 100644 --- a/docs/configuration/storage/mysql.md +++ b/docs/configuration/storage/mysql.md @@ -19,6 +19,13 @@ storage: password: mypassword ``` +## IPv6 Addresses + +If utilising an IPv6 literal address it must enclosed by square brackets and quoted: +```yaml +host: "[fd00:1111:2222:3333::1]" +``` + ## Loading a password from a secret instead of inside the configuration Password can also be defined using a [secret](../secrets.md). \ No newline at end of file diff --git a/docs/configuration/storage/postgres.md b/docs/configuration/storage/postgres.md index e864166ce..4d2358269 100644 --- a/docs/configuration/storage/postgres.md +++ b/docs/configuration/storage/postgres.md @@ -20,6 +20,13 @@ storage: sslmode: disable ``` +## IPv6 Addresses + +If utilising an IPv6 literal address it must enclosed by square brackets and quoted: +```yaml +host: "[fd00:1111:2222:3333::1]" +``` + ## SSL Mode SSL mode configures how to handle SSL connections with Postgres.