diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 85c725fa..a810e3e3 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -154,6 +154,7 @@ function sidebarKagi() { items: [ { text: 'Privacy Protection', link: '/kagi/privacy/privacy-protection' }, { text: 'Private Browser Sessions', link: '/kagi/privacy/private-browser-sessions' }, + { text: 'Two Factor Authentication', link: '/kagi/privacy/two-factor-authentication' }, { text: 'Security', link: '/kagi/privacy/security' }, { text: 'Legal Safe Harbor', link: '/kagi/privacy/safe-harbor' }, ] diff --git a/docs/kagi/privacy/media/2fa_auth_finish_setup.png b/docs/kagi/privacy/media/2fa_auth_finish_setup.png new file mode 100644 index 00000000..253e740e Binary files /dev/null and b/docs/kagi/privacy/media/2fa_auth_finish_setup.png differ diff --git a/docs/kagi/privacy/media/2fa_auth_get_started.png b/docs/kagi/privacy/media/2fa_auth_get_started.png new file mode 100644 index 00000000..f46002c3 Binary files /dev/null and b/docs/kagi/privacy/media/2fa_auth_get_started.png differ diff --git a/docs/kagi/privacy/media/2fa_auth_login.png b/docs/kagi/privacy/media/2fa_auth_login.png new file mode 100644 index 00000000..de94f89b Binary files /dev/null and b/docs/kagi/privacy/media/2fa_auth_login.png differ diff --git a/docs/kagi/privacy/media/2fa_auth_qr_code.png b/docs/kagi/privacy/media/2fa_auth_qr_code.png new file mode 100644 index 00000000..52898b5c Binary files /dev/null and b/docs/kagi/privacy/media/2fa_auth_qr_code.png differ diff --git a/docs/kagi/privacy/media/2fa_auth_remove_2fa.png b/docs/kagi/privacy/media/2fa_auth_remove_2fa.png new file mode 100644 index 00000000..2ba57e84 Binary files /dev/null and b/docs/kagi/privacy/media/2fa_auth_remove_2fa.png differ diff --git a/docs/kagi/privacy/two-factor-authentication.md b/docs/kagi/privacy/two-factor-authentication.md new file mode 100644 index 00000000..ac18dad7 --- /dev/null +++ b/docs/kagi/privacy/two-factor-authentication.md @@ -0,0 +1,50 @@ +# Two-Factor Authentication (2FA) + +One of the best ways to protect your Kagi account is to set up two-factor authentication (2FA), this allows you to use an authenticator app to generate a verification code that will be requested every time you sign in to your account. + +In the event that your account password was compromised, attackers wouldn’t be able to log in to your account as they would be required to enter the verification code generated by your authenticator app. + +## Authenticator Apps + +Kagi’s 2FA implementation is compatible with most authenticator apps, some options are provided below: +iOS: +- [Raivo Authenticator](https://apps.apple.com/us/app/raivo-authenticator/id1459042137) +- [Google Authenticator](https://apps.apple.com/us/app/google-authenticator/id388497605) +- [Microsoft Authenticator](https://apps.apple.com/us/app/microsoft-authenticator/id983156458) + +Android: +- [Aegis Authenticator](https://play.google.com/store/apps/details?id=com.beemdevelopment.aegis&hl=en&gl=US) +- [Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en&gl=US) +- [Microsoft Authenticator](https://play.google.com/store/apps/details?id=com.azure.authenticator&hl=en&gl=US) + +Some password managers such as 1Password and Bitwarden also have a 2FA authenticator built-in. + +## Setting up 2FA authentication + +If you want to set up 2FA authentication in your Kagi account, first visit the [Account Settings](https://kagi.com/settings?p=user_details) page. Then, click the **Get Started** button. + +![2FA authentication - Get Started](./media/2fa_auth_get_started.png){width=600px data-zoomable} + +On the next screen, a QR code will be displayed. You can scan this QR code from your favorite authenticator app. + +![2FA authentication - QR code](./media/2fa_auth_qr_code.png){width=600px data-zoomable} + +If you are using a desktop app to generate the verification codes, then it might be easier to copy your setup key and paste it in your authenticator app directly. + +As a way to prevent from being locked out from your account, we recommend you download and store your backup codes safely, these can be used to regain access to your account if you lose access to your authenticator app. + +Finally, enter the verification code generated by your authenticator app in the boxes to complete the setup process and then click **Continue**. + +![2FA authentication - Finish setup](./media/2fa_auth_finish_setup.png){width=600px data-zoomable} + +## Sign-in with 2FA authentication + +If you have 2FA authentication enabled in your account, you will prompted to enter your verification code after entering your username and password. + +![2FA authentication - Login](./media/2fa_auth_login.png){width=600px data-zoomable} + +## Disabling 2FA authentication + +If you need to disable 2FA authentication for your account, first visit the [Account Settings](https://kagi.com/settings?p=user_details) page. Then, click the **Remove 2FA** button. + +![2FA authentication - Login](./media/2fa_auth_remove_2fa.png){width=600px data-zoomable}