Skip to content
Sign In

Overview

Accounts and sign-in

Create an account with Google, GitHub, or an email address, and sign in to manage organisations and instances.

One account gets you into SurrealDB Studio, where you manage organisations and instances.

An account needs no payment details. The free instance type carries no charge, so you can deploy before you add a payment method.

To create an account or to sign in, open studio.surrealdb.com and continue to the authentication page.

Three methods are available. Use the same method every time. If you sign up with Google and later sign in by email on the same address, you create a second account. The first account is not recovered.

MethodWhat happensSuited to
GoogleYou authorise SurrealDB on Google's own sign-in pageTeams already on Google Workspace
GitHubYou authorise SurrealDB on GitHub's own sign-in pageDevelopers already signed in to GitHub
Email and passwordYou set a password, then confirm the address from a verification linkAnyone who prefers not to link a third-party account
Important

Google and GitHub sign-in uses OAuth2. The provider's own page collects your password, so SurrealDB never receives it. SurrealDB requests your email address and name only. After you authorise the connection, the provider returns a token that confirms your identity.

Two-factor authentication configured with Google or GitHub also applies to your SurrealDB account, because the provider verifies you before returning you to SurrealDB. For an account that signs in with an email address and password, add an authenticator app instead. See Two-step verification for more.

With Google or GitHub:

  1. Select Sign up with Google or Sign up with GitHub.

  2. Choose your account in the provider's window.

  3. Allow the requested permissions.

Studio signs you in as soon as the provider returns.

With email:

  1. Select Sign up with Email.

  2. Enter your email address.

  3. Set a password.

  4. Open the verification link sent to your inbox to confirm the address.

  1. Open studio.surrealdb.com.

  2. Select the method you registered with: Continue with Google, Continue with GitHub, or Sign in with Email.

  3. Complete any two-factor step the provider asks for.

To reset a forgotten email password, select Forgot password? on the authentication page. Follow the instructions sent to your address.

An account created through Google or GitHub has no SurrealDB password to reset. Recover the provider account instead.

Each person needs their own account. Invite colleagues to the organisation instead of sharing credentials. Separate accounts let each member hold a different role, and let you remove someone without changing a password the rest of the team uses. See Members and roles.

For automation, use a token from surrealctl rather than an interactive account.

  1. Create an organisation to hold your instances and billing.

  2. Deploy an instance.

  3. Connect to it from SurrealDB Studio, the CLI, an SDK, or over HTTP.

Was this page helpful?