SuperTokens

SuperTokens

  • Docs
  • Discord
  • Blog

›Quick setup

SIDEBAR_REPLACE_DOC_About this recipe

  • About this recipe

Quick setup

  • Video tutorial
  • Frontend
  • Backend
  • Core

    • Self Hosted setup with Docker
    • Self Hosted setup without Docker
    • Managed Service

    Database Setup

    • If using MySQL
    • If using PostgreSQL
    • Rename database tables

SIDEBAR_REPLACE_DOC_About appInfo

  • About appInfo

Common customizations

  • Redirect To Auth Screen
  • Sign Out
  • SignUp Form

    • Prerequisite
    • Adding Extra Fields
    • Adding / Modifying field validators
    • Built in providers
    • Custom providers
    • Terms of service & Privacy policy links
    • Show Sign Up by default

    SignIn Form

    • Prerequisite
    • Adding / Modifying field validators
    • Built in providers
    • Custom providers
    • Password managers
  • Embed Sign In / Up form in a page
  • Post signin / signup callbacks
  • User Roles

    • Assigning roles to users
    • Assigning roles to a session
    • Reading roles in an API
    • Reading roles in the frontend
    • Updating roles in a session

    Reset Password

    • About
    • Customising the reset password email
    • Embed in a page

    Email Verification

    • Enable email verification
    • Customising the email sent
    • Embed in a page
    • Post email verification

    Sessions

    • About
    • Storing data in a session
    • Session Verification in API
    • Revoking a session manually
    • Change session timeout
    • Checking if a session exists on the frontend
    • Get user information on the frontend
    • Handling session expiry
    • Securing a website route / component
    • Fetching sessions for a user
    • Update JWT Payload
    • Update Session Data
    • Multiple API endpoints
    • Cookies and Https
    • Cookie Consent
    • Share sessions across sub domains
    • Anti CSRF
    • Same site cookies
    • JWT Signing key rotation
    • Access token blacklisting
    • Using in an iframe
    • Customizing Error Handling

    Styling

    • Changing Colours
    • Changing Style via CSS
    • Disable use of shadow DOM

    Changing base path

    • Website Base Path
    • API Base Path
  • User Pagination
  • Core

    • Adding API Keys
    • Tuning Performance
    • Logging

    Core CLI

    • Overview
    • Start
    • List
    • Stop
    • Uninstall

Advanced customizations

  • Overview
  • React component override

    • About
    • How to use

    Frontend functions override

    • About
    • How to use

    Backend functions override

    • About
    • How to use

    APIs override

    • About
    • How to use
    • Disabling APIs

    Frontend hooks

    • Pre API Hook
    • Handle Event Hook
    • Redirection Callback Hook

NextJS

  • About
  • 1. Configuration
  • 2. Showing Login UI
  • 3. Adding auth APIs
  • 4. Protecting a website route
  • 5. Session verification

    • 5a. Session verification in an API call
    • 5b. Session verification in getServerSideProps
  • 6. Next steps

Serverless Deployment

    With Netlify

    • About
    • 1. Frontend Setup
    • 2. Backend config
    • 3. Exposing Auth APIs
    • 4. Session verification / Building your APIs
    • 5. Next steps

    With AWS Lambda

    • About
    • 1. Frontend Setup
    • 2. Backend config
    • 3. Exposing Auth APIs
    • 4. Setting Up API Gateway & CORS
    • 5. Session verification / Building your APIs
    • 6. Next steps

Testing

  • Testing with Postman

SIDEBAR_REPLACE_DOC_SDK Reference

  • SDK Reference

SIDEBAR_REPLACE_DOC_API Reference

  • API Reference

Video tutorial

For framework specific implementation (like Next.js), please skip this section and go directly to the section with the name of your framework.

  • 0:00 Introduction
  • 0:26 Documentation navigation
  • 0:40 Frontend init
  • 1:45 Frontend routing
  • 2:38 Protect a website route
  • 3:38 Backend init
  • 4:53 Adding backend APIs & CORS
  • 5:52 Testing login
  • 6:14 Fetching user info on the frontend & signout
  • 7:34 Testing sign in with Google
← About this recipeFrontend →