Supertokens

Stay updated on the status of all your company's support tickets.

Customer portal

SuperTokens

Welcome to the world of secure and easy-to-implement authentication solutions with SuperTokens! Whether you're building a new application or looking to enhance an existing one with robust authentication features, SuperTokens offers a flexible, open-source solution that can be tailored to meet your needs. This guide will walk you through the installation process of SuperTokens, ensuring you have a smooth start. Let's dive in!

Before we begin, ensure you have the following:

Node.js installed on your system (version 12.x or later).

A basic understanding of your project's backend framework (e.g., Express.js for Node.js applications).

docker pull supertokens/supertokens-<your-preferred-database>


docker run -p 3567:3567 -d supertokens/supertokens-<your-preferred-database>


Congratulations! You have successfully installed SuperTokens in your application. You're now ready to dive deeper into adding authentication routes, configuring sessions, and customizing authentication flows to suit your application's needs.

Installing SuperTokens is just the beginning. With its flexible architecture and comprehensive documentation, you're well-equipped to build secure and scalable authentication systems. Explore the SuperTokens documentation for detailed guides on implementing various authentication features and customizing your setup. Happy coding!

This article provides a detailed walkthrough of the installation process for SuperTokens, covering various operating systems and environments. It aims to help new users get SuperTokens up and running quickly by addressing common setup challenges and offering solutions.

Installing SuperTokens: A Step-by-Step Guide

Implementing secure and efficient authentication is a critical step in developing any application. SuperTokens simplifies this process, offering a robust and customizable authentication solution. This guide will walk you through creating your first authentication flow with SuperTokens, covering user registration, login, and session management. By the end, you'll have a basic yet powerful authentication system integrated into your application.

Successfully installed SuperTokens Core and the appropriate SDK for your application as described in the "Installing SuperTokens: A Step-by-Step Guide."

Basic knowledge of your application's backend framework (e.g., Express.js for Node.js applications).

// Example backend route for user registration app.post("/auth/signup", async (req, res) => {
    // Use SuperTokens SDK to create a new user// The actual implementation may vary based on the SDK });


// Example backend route for user login app.post("/auth/login", async (req, res) => {
    // Use SuperTokens SDK to authenticate the user and create a session// The actual implementation may vary based on the SDK });


// Example of a protected route app.get("/profile", middleware.verifySession(), (req, res) => {
    // If the session is valid, return profile information res.json({ message: "This is a protected route." });
});


// Example backend route for logout app.post("/auth/logout", middleware.verifySession(), (req, res) => {
    // Use SuperTokens SDK to revoke the session req.session.revokeSession(); res.json({ message: "You have been logged out successfully." });
});


Congratulations! You've successfully implemented your first authentication flow with SuperTokens. This basic setup provides a solid foundation for secure user authentication, which you can further customize and expand based on your application's needs. Explore the SuperTokens documentation for advanced features and customization options to enhance your authentication system.

Aimed at beginners, this article explains how to implement a basic authentication flow using SuperTokens. It includes simple examples and explains the concepts of user registration, login, and session management in an easy-to-understand manner.

Your First Authentication Flow with SuperTokens

The SuperTokens Dashboard is a powerful web-based interface that allows developers and administrators to monitor and manage the authentication aspects of their applications with ease. From tracking active sessions to managing user accounts, the Dashboard offers a comprehensive set of tools designed to simplify the oversight of your application's security. This guide will introduce you to the key features of the SuperTokens Dashboard and show you how to use them effectively.

Before diving into the Dashboard, ensure you have:

Installed SuperTokens Core and integrated it with your application.

Access to the SuperTokens Dashboard, which may require setting up an account or configuring access permissions based on your installation.

The SuperTokens Dashboard is a central component of managing your application's authentication system. By familiarizing yourself with its features and capabilities, you can ensure a secure and efficient user experience. Whether you're monitoring active sessions, managing user accounts, or configuring your SuperTokens setup, the Dashboard provides the tools you need to maintain control over your application's security landscape.

An introductory guide to the SuperTokens Dashboard, explaining its features, how to navigate it, and how to use it for monitoring and managing authentication flows. This article helps new users familiarize themselves with the dashboard's capabilities and how it can aid in their development process.

Getting Started

Installing SuperTokens: A Step-by-Step Guide

Your First Authentication Flow with SuperTokens

Understanding SuperTokens Dashboard