diff --git a/docs/how-to-guides/periodic-authentication.md b/docs/how-to-guides/periodic-authentication.md new file mode 100644 index 00000000..b381cfe1 --- /dev/null +++ b/docs/how-to-guides/periodic-authentication.md @@ -0,0 +1,52 @@ +--- +sidebar_position: 4 +--- +# Configure periodic user authentication + +To ensure a high level of security, NetBird offers a peer login expiration feature that requires users to periodically reauthenticate their devices. +Every new network has this feature enabled, and the expiration period is set to 24 hours by default. You can disable this feature and configure the expiration period in the account settings in the web UI https://app.netbird.io/settings. + +:::tip +This feature is only applied to peers added with the [interactive SSO login feature](/getting-started/installation#running-netbird-with-sso-login). Peers, added with a setup key, won't be affected. +::: + +Expired peers will appear in the peers' view with the status `needs login`. + +

+ peer-needs-login.png +

+ +### Configure and disable expiration +The expiration period can be set to anything between one hour and 180 days. +Go to the Web UI Settings tab and set the desired period in the Authentication section. +You can also disable the expiration for the whole network in the same section. + +

+ peer-login-expiration +

+ + +:::danger +Enabling peer expiration or changing the expiration period will cause some peers added with the SSO login to disconnect, +and re-authentication will be required. +::: + +### Disable expiration individually per peer +Sometimes, you might want to disable peer expiration for some peers. +With NetBird you can disable login expiration per peer without disabling expiration globally. +In the Peers tab of the web UI click on the peer you want to disable expiration for and use the Login Expiration switch. +Peers with `expiration disabled` will be marked with a corresponding label in the peers' table. + +

+ peer-login-expiration +

+ +## Get started +

+ +

+ +- Make sure to [star us on GitHub](https://github.com/netbirdio/netbird) +- Follow us [on Twitter](https://twitter.com/netbird) +- Join our [Slack Channel](https://join.slack.com/t/netbirdio/shared_invite/zt-vrahf41g-ik1v7fV8du6t0RwxSrJ96A) +- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub \ No newline at end of file diff --git a/docs/integrations/identity-providers/self-hosted/available-integrations.md b/docs/integrations/identity-providers/self-hosted/available-integrations.md index 9baec117..efaf43fb 100644 --- a/docs/integrations/identity-providers/self-hosted/available-integrations.md +++ b/docs/integrations/identity-providers/self-hosted/available-integrations.md @@ -13,4 +13,3 @@ NetBird supports generic OpenID (OIDC) protocol allowing for the integration wit List of available guides: - [Auth0](/integrations/identity-providers/self-hosted/using-netbird-with-auth0) (managed service) - [Keycloak](/integrations/identity-providers/self-hosted/using-netbird-with-keycloak) -- [Azure SSO](/integrations/identity-providers/self-hosted/using-netbird-with-Azure-SSO) diff --git a/docs/integrations/identity-providers/self-hosted/azure-sso.md b/docs/integrations/identity-providers/self-hosted/azure-sso.md.disabled similarity index 100% rename from docs/integrations/identity-providers/self-hosted/azure-sso.md rename to docs/integrations/identity-providers/self-hosted/azure-sso.md.disabled diff --git a/static/img/how-to-guides/individual-peer-login-expiration.png b/static/img/how-to-guides/individual-peer-login-expiration.png new file mode 100644 index 00000000..808e74fc Binary files /dev/null and b/static/img/how-to-guides/individual-peer-login-expiration.png differ diff --git a/static/img/how-to-guides/peer-login-expiration.png b/static/img/how-to-guides/peer-login-expiration.png new file mode 100644 index 00000000..e0a4029d Binary files /dev/null and b/static/img/how-to-guides/peer-login-expiration.png differ diff --git a/static/img/how-to-guides/peer-needs-login.png b/static/img/how-to-guides/peer-needs-login.png new file mode 100644 index 00000000..b3075aa6 Binary files /dev/null and b/static/img/how-to-guides/peer-needs-login.png differ