diff --git a/sources/platform/console/images/console-account-two-factor-disabled.png b/sources/platform/console/images/console-account-two-factor-disabled.png new file mode 100644 index 000000000..fac86e9e5 Binary files /dev/null and b/sources/platform/console/images/console-account-two-factor-disabled.png differ diff --git a/sources/platform/console/images/console-account-two-factor-enabled.png b/sources/platform/console/images/console-account-two-factor-enabled.png new file mode 100644 index 000000000..ed20c8c37 Binary files /dev/null and b/sources/platform/console/images/console-account-two-factor-enabled.png differ diff --git a/sources/platform/console/images/console-email-verification-page.png b/sources/platform/console/images/console-email-verification-page.png new file mode 100644 index 000000000..e304ed403 Binary files /dev/null and b/sources/platform/console/images/console-email-verification-page.png differ diff --git a/sources/platform/console/images/console-forgotten-password-page.png b/sources/platform/console/images/console-forgotten-password-page.png new file mode 100644 index 000000000..10bda8327 Binary files /dev/null and b/sources/platform/console/images/console-forgotten-password-page.png differ diff --git a/sources/platform/console/images/console-reset-password-page.png b/sources/platform/console/images/console-reset-password-page.png new file mode 100644 index 000000000..269e765c5 Binary files /dev/null and b/sources/platform/console/images/console-reset-password-page.png differ diff --git a/sources/platform/console/images/console-setup-two-factor-auth-key.png b/sources/platform/console/images/console-setup-two-factor-auth-key.png new file mode 100644 index 000000000..dd69814a9 Binary files /dev/null and b/sources/platform/console/images/console-setup-two-factor-auth-key.png differ diff --git a/sources/platform/console/images/console-sign-in-form.png b/sources/platform/console/images/console-sign-in-form.png new file mode 100644 index 000000000..71b6afaf9 Binary files /dev/null and b/sources/platform/console/images/console-sign-in-form.png differ diff --git a/sources/platform/console/images/console-sign-in-methods-section.png b/sources/platform/console/images/console-sign-in-methods-section.png new file mode 100644 index 000000000..6519b4f7f Binary files /dev/null and b/sources/platform/console/images/console-sign-in-methods-section.png differ diff --git a/sources/platform/console/images/console-sign-up-form.png b/sources/platform/console/images/console-sign-up-form.png new file mode 100644 index 000000000..d0045f7ee Binary files /dev/null and b/sources/platform/console/images/console-sign-up-form.png differ diff --git a/sources/platform/console/images/console-two-factor-app-setup.png b/sources/platform/console/images/console-two-factor-app-setup.png new file mode 100644 index 000000000..204bfcee4 Binary files /dev/null and b/sources/platform/console/images/console-two-factor-app-setup.png differ diff --git a/sources/platform/console/images/console-two-factor-auth-disable.png b/sources/platform/console/images/console-two-factor-auth-disable.png new file mode 100644 index 000000000..3e0f74c10 Binary files /dev/null and b/sources/platform/console/images/console-two-factor-auth-disable.png differ diff --git a/sources/platform/console/images/console-two-factor-authentication.png b/sources/platform/console/images/console-two-factor-authentication.png new file mode 100644 index 000000000..fbdbd6e1b Binary files /dev/null and b/sources/platform/console/images/console-two-factor-authentication.png differ diff --git a/sources/platform/console/images/console-two-factor-recovery-settings-request.png b/sources/platform/console/images/console-two-factor-recovery-settings-request.png new file mode 100644 index 000000000..fc3b64b7b Binary files /dev/null and b/sources/platform/console/images/console-two-factor-recovery-settings-request.png differ diff --git a/sources/platform/console/images/console-two-factor-recovery-settings-revealed.png b/sources/platform/console/images/console-two-factor-recovery-settings-revealed.png new file mode 100644 index 000000000..1898d6f39 Binary files /dev/null and b/sources/platform/console/images/console-two-factor-recovery-settings-revealed.png differ diff --git a/sources/platform/console/images/console-two-factor-recovery-setup.png b/sources/platform/console/images/console-two-factor-recovery-setup.png new file mode 100644 index 000000000..1ab27f471 Binary files /dev/null and b/sources/platform/console/images/console-two-factor-recovery-setup.png differ diff --git a/sources/platform/console/images/console-two-factor-use-recovery-code.png b/sources/platform/console/images/console-two-factor-use-recovery-code.png new file mode 100644 index 000000000..11d536b15 Binary files /dev/null and b/sources/platform/console/images/console-two-factor-use-recovery-code.png differ diff --git a/sources/platform/console/index.md b/sources/platform/console/index.md index be32054bb..f5b1aae1d 100644 --- a/sources/platform/console/index.md +++ b/sources/platform/console/index.md @@ -10,17 +10,65 @@ slug: /console --- -## Sign Up +## Sign-up -To use Apify Console, you need to create an Apify account. [Sign up here](https://console.apify.com/sign-up). +To use Apify Console, you first need to create an account. To create it please go to the [sign-up page](https://console.apify.com/sign-up). +At the moment we support 3 different methods of creating an account: -![apify-console-sign-up](./images/console-signup.png) +![Apify Console sign-up form](./images/console-sign-up-form.png) -## Log In +### Email and password -After signing up, you need to log in using your Apify account. +This is the most common way of creating an account. You just need to provide your email address and a password. The password needs to be at least 8 characters, should not be your email address, and should either contain special characters or be long enough to be secure. The password field has a strength indicator below it that will tell you if your password is strong enough. -![apify-console-login](./images/console-login.png) +After you click the **Sign up** button, we will send you a verification email. The email contains a link that you need to click on or copy to your browser to proceed to automated email verification. After we verify your email, you will proceed to Apify Console. + +:::info CAPTCHA +We are using Google reCaptcha to prevent spam accounts. Usually, you will not see it, but if Google evaluates your browser as suspicious, they will ask you to solve a reCaptcha before we create your account and send you the verification email. +::: + +If you did not receive the email, you can visit the [sign-in page](https://console.apify.com/sign-in). There, you will either proceed to our verification page right away, or you can sign in and will be redirected afterward. On the verification page, you can click on the **Resend verification email** button to send the email again. + +![Apify Console email verification page](./images/console-email-verification-page.png) + +### Google or GitHub + +If you do not want to create a new password for Apify Console, you can also use your Google or GitHub account to sign up. To do that, click the **Sign up with Google** or **Sign up with GitHub** buttons. You will proceed to the corresponding authentication page, where you must sign in and authorize Apify to access your account. Then, when you come back to Apify Console, we will create your account. + +If you used Google to sign up, there is no verification step after this, and you can start using Apify Console right away. +On the other hand, if you used GitHub to create your account and your GitHub account does not have a verified email, we will ask you to verify your email address before you can start using Apify Console. The process works the same as the process for email and password authentication. + +If you already have an account in Apify Console connected to Google or GitHub, clicking on these buttons on the sign-up page will not create a new account but will directly sign you in. + +## Sign-in + +To sign in to your account, please go to the [sign-in page](https://console.apify.com/sign-in). +There, you can use any of the authentication methods you have set up for your account. If you have multiple authentication methods, you can choose which one you want to use by using the corresponding button or form. + +If you sign in through email and password and have two-factor authentication enabled on your account, you will proceed to the two-factor authentication page after you enter your password. There, you will need to enter the code from your authenticator app to sign in. +If you do not have two-factor authentication enabled, you will be directly redirected to Apify Console. + +![Apify Console sign-in form](./images/console-sign-in-form.png) + +### Forgotten password + +In case you forgot your password, you can click on the **Forgot your password?** link, which will redirect you to the [forgot password page](https://console.apify.com/forgot-password). There, you will need to enter your email address and click on the **Reset password** button. We will then send an email to the address connected to your account with a link to the password reset page, which will allow you to change your password. + +![Apify Console forgotten password page](./images/console-forgotten-password-page.png) + +## Adding different authentication methods + +After you create your account, you might still want to use the other authentication methods. To do that, go to your [account settings](https://console.apify.com/account/settings) and scroll down to the **Login** section. There, you will see all available authentication methods and their configuration. + +![Apify Console sign-in methods section on account page](./images/console-sign-in-methods-section.png) + +## Resetting your password + +This section also allows you to reset your password if you ever forget it. To do that, click the **Send email to reset password** button. +We will then send an email to the address connected to your account with a link to the password reset page. +After you click on the link (or copy it to your browser), you will proceed to a page where you can set up a new password. + +![Apify Console reset password page](./images/console-reset-password-page.png) ## Homepage overview diff --git a/sources/platform/console/two-factor-authentication.md b/sources/platform/console/two-factor-authentication.md new file mode 100644 index 000000000..7e412b5bd --- /dev/null +++ b/sources/platform/console/two-factor-authentication.md @@ -0,0 +1,101 @@ +--- +title: Two-factor authentication +description: Learn about Apify Console's two-factor authentication process and how to set it up. +sidebar_position: 5 +category: platform +slug: /console/two-factor-authentication +--- + +**Learn about Apify Console's account two-factor authentication process and how to set it up.** + +--- + +If you use your email and password to sign in to Apify Console, you can enable two-factor authentication for your account. This will add an extra layer of security to your account and prevent anyone who gains access to your password from signing in to your account. + +## Setting up two-factor authentication + +To set up two-factor authentication, go to your [account settings](https://console.apify.com/account/settings) and scroll down to the **Two-factor authentication** section. Currently, there is only one option, which is the **Authenticator app**. If you have two-factor authentication already enabled, there will be a label **enabled** next to it. + +![Apify Console two-factor authentication section](./images/console-account-two-factor-disabled.png) + +If it's not enabled, click on the **Enable** button. You should see the two-factor setup view. + +### Authenticator app setup + +![Apify Console setup two-factor authentication - app](./images/console-two-factor-app-setup.png) + +In this view, you can use your favorite authenticator app to scan the QR code. We recommend using Google Authenticator ([Google Play Store](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en_US)/[Apple App Store](https://apps.apple.com/us/app/google-authenticator/id388497605)) or [Authy](https://authy.com/)([Google Play Store](https://play.google.com/store/apps/details?id=com.authy.authy)/[Apple App Store](https://itunes.apple.com/us/app/authy/id494168017) but any other authenticator app should work as well. + +You can also set up your app/browser extension manually without the QR code. To do that, click on the **Setup key** link below the QR code. This view with the key will pop up: + +![Apify Console setup two-factor authentication - key](./images/console-setup-two-factor-auth-key.png) + +A new pop-up window will appear where you can copy the two-factor `secret` key, which you can use in your authenticator app to set up the account. You can also use this key to set up your authenticator app on multiple devices. + +After you scan the QR code or set up your app manually, the app will generate a code that you need to enter into the **Verify the code from the app** field. After you enter the code, click on the **Continue** button to get to the next step of the setup process. + +### Recovery settings + +![Apify Console setup two-factor authentication - recovery codes](./images/console-two-factor-recovery-setup.png) + +In this step, you will see 16 recovery codes. If you ever lose access to your authenticated app, you will be able to use these codes to access the Apify Console. We recommend saving these codes in a safe place; ideally, you should store them in a secure password manager or print them out and keep them separate from your device. + +Under the recovery codes, you will find two fields for your recovery information. These two fields are what the support team will ask you to provide in case you lose access to your authenticator app and also to your recovery codes. We will never use the phone number for anything other than to verify your identity and help you regain access to your account, only as a last resort. Ideally, the personal information you provide will be enough to verify your identity. Always provide both the kind of personal information you provide and the actual information. + +:::info Personal information +What kind of personal information you provide is completely up to you. It does not even have to be personal, as long as it's secure and easy to remember. For example, it can be the name of your pet, the name of your favorite book, some secret code, or anything else. Keep in mind who has access to that information. While you can use the name of your pet, if you share information about your pet on public social media, it's not a good choice because anyone on the internet can access it. The same goes for any other information you provide. +::: + +You will not be able to enable the two-factor authentication until you click on the **Download** / **Copy** buttons or copy the codes manually. After you do that, the **Continue** button will light up, and you can click on it to enable the two-factor authentication. The authentication process will then enable the two-factor authentication for your account and show a confirmation. + +### Confirmation + +When you close the setup process, you should see that your two-factor authentication is enabled in the account settings. + +![Apify Console two-factor authentication section enabled](./images/console-account-two-factor-enabled.png) + + +## Verification after sign-in + +After you enable two-factor authentication, the next time you attempt to sign in, you'll need to enter a code before you can get into the Apify Console. To do that, open your authenticator app and enter the code for your Apify account into the **Code** field. After you enter the code, click on the **Verify** button, and if the provided code is correct, you will proceed to Apify Console. + +![Apify Console two-factor authentication form](./images/console-two-factor-authentication.png) + +## Using recovery codes + +In case you lose access to your authenticator app, you can use the recovery codes to sign in to your account. To do that, click on the **recovery code or begin 2FA account recovery** link below the **Verify** button. This will redirect you to a view similar to the current one, but instead of code from the authenticator app, you will need to enter one of the 16 recovery codes you received during the setup process. + +If the provided recovery code is correct, you will proceed to Apify Console, the same as if you provided the code from the authenticator app. After gaining access to Apify Console, we recommend going to the [account settings](https://console.apify.com/account/settings), disabling the two-factor authentication there, and then enabling it again with the new authenticator app. + +:::info Removal of recovery codes +When you successfully use a recovery code, we remove the code from the original list as it's no longer possible to use it again. If you use all of your recovery codes, you will not be able to sign in to your account with them anymore, and you will need to either use your authenticator app or contact our support to help you regain access to your account. +::: + + +![Apify Console two-factor authentication with recovery code form](./images/console-two-factor-use-recovery-code.png) + +## Disabling two-factor authentication + +If you no longer want to use the two-factor authentication or lose access to your authenticator app, you can disable the two-factor authentication in your [account settings](https://console.apify.com/account/settings). To do that, scroll down to the **Two-factor authentication** section and click on the **Disable** button. We will ask you to enter either your verification code from the authenticator app or, if you do not have access to it anymore, you can use one of your recovery codes. After entering the code, click on the **Remove app** button to verify the provided code. If it's valid, it will disable the two-factor authentication and remove the configuration from your account. + +After you disable the two-factor authentication you will be able to sign in to your account without providing the verification code. + +![Apify Console disable two-factor authentication modal](./images/console-two-factor-auth-disable.png) + +## What to do when you get locked out + +If you lose access to your authenticator app and do not have any recovery codes left, or you lost them as well, you will not be able to sign in to your account. In this case, you will need to contact our support. To do that, you can either send us an email to [support@apify.com](mailto:support@apify.com?subject='Locked%20out%20of%20account%20with%202FA%20enabled') or you can go to the [sign-in page](https://console.apify.com/sign-in) and sign in with your email and password. Then, on the two-factor authentication page, click on the **recovery code or begin 2FA account recovery** link. On the two-factor recovery page, click on the **Contact our support** link. This link will open up our online chat, and our support team can help you from there. + +For our support team to help you recover your account, you will need to provide them with the personal information you have configured during the two-factor authentication setup. If you provide the correct information, the support team will help you regain access to your account. + +:::caution +The support team will not give you any clues about the information you provided; they will only verify if it is correct. +::: + +You can always check what information you provided by going to your [account settings](https://console.apify.com/account/settings), scrolling down to the **Two-factor authentication** section, and clicking on the **Recovery settings** button, then you should see a view like this: + +![Apify Console recovery settings modal request](./images/console-two-factor-recovery-settings-request.png) + +After you enter a verification code from your authenticator app, you will see the recovery settings you provided during the two-factor authentication setup. + +![Apify Console recovery settings modal response](./images/console-two-factor-recovery-settings-revealed.png)