Skip to content

Commit

Permalink
[DOCS] Add notes for IPv6 literal address (#1541)
Browse files Browse the repository at this point in the history
  • Loading branch information
nightah committed Dec 16, 2020
1 parent a7968bc commit f2282f7
Show file tree
Hide file tree
Showing 8 changed files with 54 additions and 3 deletions.
2 changes: 1 addition & 1 deletion config.template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
7 changes: 7 additions & 0 deletions docs/configuration/authentication/ldap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions docs/configuration/miscellaneous.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
6 changes: 6 additions & 0 deletions docs/configuration/notifier/smtp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
15 changes: 13 additions & 2 deletions docs/configuration/session.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
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).
7 changes: 7 additions & 0 deletions docs/configuration/storage/mariadb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
7 changes: 7 additions & 0 deletions docs/configuration/storage/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
7 changes: 7 additions & 0 deletions docs/configuration/storage/postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit f2282f7

Please sign in to comment.