mirror of https://github.com/0rangebananaspy/authelia.git synced 2024-09-14 22:47:21 +07:00

feat(ntp): check clock sync on startup (#2251 )

This adds method to validate the system clock is synchronized on startup. Configuration allows adjusting the server address, enabled state, desync limit, and if the error is fatal.

Co-authored-by: James Elliott <james-d-elliott@users.noreply.github.com>

2021-09-17 14:44:35 +10:00

2.3 KiB

Raw Blame History

layout	title	parent	nav_order
default	NTP	Configuration	9

NTP

Authelia has the ability to check the system time against an NTP server. Currently this only occurs at startup. This section configures and tunes the settings for this check which is primarily used to ensure TOTP can be accurately validated.

In the instance of inability to contact the NTP server Authelia will just log an error and will continue to run.

Configuration

ntp:
  address: "time.cloudflare.com:123"
  version: 3
  max_desync: 3s
  disable_startup_check: false
  disable_failure: false

Options

address

type: string {: .label .label-config .label-purple } default: time.cloudflare.com:123 {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

Determines the address of the NTP server to retrieve the time from. The format is <host>:<port>, and both of these are required.

version

type: integer {: .label .label-config .label-purple } default: 4 {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

Determines the NTP verion supported. Valid values are 3 or 4.

max_desync

type: duration {: .label .label-config .label-purple } default: 3s {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

This is used to tune the acceptable desync from the time reported from the NTP server. This uses our duration notation format.

disable_startup_check

type: boolean {: .label .label-config .label-purple } default: false {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

Setting this to true will disable the startup check entirely.

disable_failure