The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
docs - 2FA (#77883)
Jeff Bruemmer55e1aa315de8
diff --git a/docs/README.md b/docs/README.mdindex 0e1b817d259..ffda962551c 100644--- a/docs/README.md+++ b/docs/README.md@@ -182,6 +182,7 @@ Metabase's reference documentation.- [Managing people and groups](./people-and-groups/managing.md)- [Password complexity](./people-and-groups/changing-password-complexity.md)- [Session expiration](./people-and-groups/changing-session-expiration.md)+- [Two-factor authentication](./people-and-groups/two-factor-authentication.md)- [Google Sign-In](./people-and-groups/google-sign-in.md)- [LDAP](./people-and-groups/ldap.md)- [API keys](./people-and-groups/api-keys.md)diff --git a/docs/people-and-groups/account-settings.md b/docs/people-and-groups/account-settings.mdindex f9ef23b3a4b..50ae4fd81b6 100644--- a/docs/people-and-groups/account-settings.md+++ b/docs/people-and-groups/account-settings.md@@ -1,47 +1,80 @@-----title: Account settings-summary: Update your profile, change your password, view login history, manage notifications, and customize your Metabase experience.-redirect_from:- - /docs/latest/users-guide/account-settings------# Account settings--To access your account settings, click the **profile or grid icon** in the top right corner, then click your **profile name and email.**--## Account profile--You can set your first and last names, change your email address, and set your language. See our list of [supported languages](../configuring-metabase/localization.md).--## Theme--You can choose to display Metabase in light or dark mode.--To quickly toggle dark mode, use the [command palette](../exploration-and-organization/exploration.md#command-palette).--The theme only applies to your account. The theme doesn't apply to chart colors or embedded Metabases.--## Account password--You can change your password here. Note that if your Metabase uses Single Sign-On (SSO), your administrator will have disabled this password section, as your identity provider will manage logins.--If you're having trouble logging in, see our [People can't log into Metabase](../troubleshooting-guide/cant-log-in.md).--## Account login history--The login history lists each login, along with some location information (if available), and some client information (like Browser (Firefox/Windows)).-If you see any suspicious login attempts, change your password and notify your administrator.--### A note about new login emails--Whenever you log in from a new device, Metabase will send you an email just to let you know someone (presumably you) has logged in from an unrecognized device. If you see this email, but don't remember logging in, or don't recognize the device, change your password and let your administrator know.--## Disable animations in Metabase--This isn't an in-Metabase setting, but just so you know: you can disable UI animations in Metabase (like sidebars sliding around, or rotating spinners) by changing the settings for your operating system so it respects the `prefers-reduced-motion` CSS media feature. This change will also affect other applications, not just Metabase. Check out the instructions for how to set the user preferences for your operating system in the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion#user_preferences).--## Notifications--If you subscribe or are added to dashboard subscriptions or alerts, you’ll be able to manage those notifications here (as well as on the relevant question or dashboard themselves).--Metabase excludes notifications for [comments](../documents/introduction.md#comment-notifications) from this page.+---+title: Account settings+summary: Update your profile, change your password, view login history, manage notifications, and customize your Metabase experience.+redirect_from:+ - /docs/latest/users-guide/account-settings+---++# Account settings++To access your account settings, click the **profile or grid icon** in the top right corner, then click your **profile name and email.**++## Account profile++You can set your first and last names, change your email address, and set your language. See our list of [supported languages](../configuring-metabase/localization.md).++## Theme++You can choose to display Metabase in light or dark mode.++To quickly toggle dark mode, use the [command palette](../exploration-and-organization/exploration.md#command-palette).++The theme only applies to your account. The theme doesn't apply to chart colors or embedded Metabases.++## Account password++You can change your password here. Note that if your Metabase uses Single Sign-On (SSO), your administrator will have disabled this password section, as your identity provider will manage logins.++If you log in through LDAP, you won't see this password section either, since your directory manages your password. You may get a **Security** tab to enroll in 2FA if your admin has [turned it on](./two-factor-authentication.md#turn-on-two-factor-authentication).++If you're having trouble logging in, see our [People can't log into Metabase](../troubleshooting-guide/cant-log-in.md).++## Two-factor authentication++{% include plans-blockquote.html feature="Two-factor authentication" %}++If your admin has turned on [two-factor authentication](./two-factor-authentication.md) (2FA), you'll see a **Security** tab in your account settings. 2FA adds a second step to logging in: after your password, you enter a code from an authenticator app, so your password alone won't let someone into your account.++### Set up two-factor authentication on your account++1. Click the grid icon in the upper right.+2. Click your profile.+3. On the **Security** tab, click **Set up two-factor authentication**.+4. Confirm your password.+5. Scan the QR code with an authenticator app like Google Authenticator, 1Password, or Authy. If you can't scan it, enter the key manually in your authenticator app.+6. Enter the six-digit code from the app.+7. Save your recovery codes. Metabase shows these ten codes only once, so copy them and store them somewhere safe. Each recovery code only works once. If you [regenerate recovery codes](#regenerate-recovery-codes), the old codes will no longer work.++### Logging in with two-factor authentication++Once you set up two-factor authentication, Metabase will ask for a code every time you log in. After you enter your email and password:++- Enter the six-digit code from your authenticator app.+- Lost your app? Click **Use a recovery code instead** and enter one of your saved codes.+- If your admin set up email, click **Email me a code** to get a one-time code in your inbox.++### Regenerate recovery codes++Recovery codes are single-use, so it's worth generating a fresh set if you're running low or think someone else has seen them. On the **Security** tab, click **Generate recovery codes** and confirm with a current authenticator or recovery code. Generating new codes invalidates the old ones.++### Turn off two-factor authentication++In your account settings, on the **Security** tab , click **Disable**. Your account will be protected by your password only, and your recovery codes will stop working.++## Account login history++The login history lists each login, along with some location information (if available), and some client information (like Browser (Firefox/Windows)). If you see any suspicious login attempts, change your password and notify your administrator.++### A note about new login emails++Whenever you log in from a new device, Metabase will send you an email just to let you know someone (presumably you) has logged in from an unrecognized device. If you see this email, but don't remember logging in, or don't recognize the device, change your password and let your administrator know.++## Disable animations in Metabase++This isn't an in-Metabase setting, but just so you know: you can disable UI animations in Metabase (like sidebars sliding around, or rotating spinners) by changing the settings for your operating system so it respects the `prefers-reduced-motion` CSS media feature. This change will also affect other applications, not just Metabase. Check out the instructions for how to set the user preferences for your operating system in the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion#user_preferences).++## Notifications++If you subscribe or are added to dashboard subscriptions or alerts, you’ll be able to manage those notifications here (as well as on the relevant question or dashboard themselves).++Metabase excludes notifications for [comments](../documents/introduction.md#comment-notifications) from this page.diff --git a/docs/people-and-groups/start.md b/docs/people-and-groups/start.mdindex fbce7335017..ddb5627236f 100644--- a/docs/people-and-groups/start.md+++ b/docs/people-and-groups/start.md@@ -25,12 +25,14 @@ Make people use longer and more complex passwords.Tell Metabase how long it should wait before asking people to log in again.+## [Two-factor authentication](./two-factor-authentication.md)++Have people confirm their identity with an authenticator app when they log in.+## AuthenticationMetabase offers several options for authentication.-> If you need to set up 2-step or multi-factor authentication (2FA or MFA) for your Metabase, consider using one of the SSO options below.-### SSO for Metabase Open Source and Starter plans- [Google Sign-in](./google-sign-in.md)diff --git a/docs/people-and-groups/two-factor-authentication.md b/docs/people-and-groups/two-factor-authentication.mdnew file mode 100644index 00000000000..46ca68690a4--- /dev/null+++ b/docs/people-and-groups/two-factor-authentication.md@@ -0,0 +1,52 @@+---+title: Two-factor authentication+summary: Add a second step to logins by having people confirm their identity with an authenticator app. A Pro/Enterprise feature.+---++# Two-factor authentication++{% include plans-blockquote.html feature="Two-factor authentication" %}++Two-factor authentication (2FA) adds a second step to signing in. On top of people's email and password logins, they'll have to confirm their identity with a time-based code from an authenticator app.++Metabase's native 2FA applies to password logins and LDAP logins. 2FA for Single Sign-on (SSO) via JWT, SAML, or OIDC is managed through your identity provider.++## Turn on two-factor authentication++An admin can turn 2FA on for your Metabase:++1. Go to **Admin settings** > **Settings** > **Authentication**.+2. Find the **Two-factor authentication** card.+3. Toggle it to **Enabled**.+Once enabled, a **Security** tab shows up in each person's account settings, where they can enroll in 2FA.++If you configure Metabase through environment variables or a [config file](../configuring-metabase/config-file.md), the matching setting is [`MB_MFA_ENFORCEMENT`](../configuring-metabase/environment-variables.md#mb_mfa_enforcement). Set `MB_MFA_ENFORCEMENT` to `optional` to let people enroll, or `off` to turn 2FA off.++## Supported methods++- **Authenticator app (primary).** People scan a QR code with an app like Google Authenticator or 1Password, which then generates a new six-digit code every 30 seconds.+- **Email code (fallback at login).** If an admin has set up [email](../configuring-metabase/email.md), people who are already enrolled in two-factor authentication can have Metabase email them a one-time code when they can't reach their authenticator app. You can only use the code once, and expires after ten minutes. If email isn't configured, Metabase hides this option.+- **Recovery codes.** When someone enrolls in 2FA, Metabase gives them ten single-use codes to save.++Metabase doesn't support SMS codes or hardware keys (passkeys, U2F, or WebAuthn).++## Before you turn on two-factor authentication++### If you're self-hosting Metabase, set an encryption key++Set the [`MB_ENCRYPTION_SECRET_KEY`](../databases/encrypting-details-at-rest.md) environment variable so Metabase encrypts authenticator secrets at rest. If you turn on 2FA without it, Metabase shows a warning on the settings page.++If you're using Metabase Cloud, we've encrypted your keys for you.++### Set up email for the fallback code++Metabase requires people to use an email address as a login, but that doesn't mean that email is set up. The email fallback only appears if your Metabase can send [email](../configuring-metabase/email.md). If you skip setting up email, people will have to rely on their authenticator app and recovery codes only.++## See who's enrolled++When 2FA is on, go to **Admin settings** > **Settings** > **Authentication** > **Two-factor authentication**. The 2FA card shows how many people have enrolled in 2FA and how many haven't.++## Further reading++- [Enrolling in two-factor authentication](./account-settings.md#two-factor-authentication)+- [Authentication options](./start.md#authentication)