supertokens-core README

The project's README from github.com/supertokens/supertokens-core. As one markdown file: README.md.

SuperTokens banner

Open-Source auth provider

chat on Discord Docker pull stats

Add secure login and session management to your apps. SDKs available for popular languages and front-end frameworks e.g. Node.js, Go, Python, React.js, React Native, Vanilla JS, etc.

Architecture Diagram Supertokens architecture is optimized to add secure authentication for your users without compromising on user and developer experience

Three building blocks of SuperTokens architecture

  1. Frontend SDK: Manages session tokens and renders login UI widgets
  2. Backend SDK: Provides APIs for sign-up, sign-in, signout, session refreshing, etc. Your Frontend will talk to these APIs
  3. SuperTokens Core: The HTTP service for the core auth logic and database operations. This service is used by the Backend SDK

Features

Click here to get started

Learn more

If you like our project, please :star2: this repository! For feedback, feel free to join our Discord, or create an issue on this repo

🚀 What is SuperTokens?

SuperTokens is an open-core alternative to proprietary login providers like Auth0 or AWS Cognito. We are different because we offer:

Philosophy

Authentication directly affects the UX, dev experience, and security of any app. We believe that current solutions cannot optimize for all three "pillars", leading to many applications hand-rolling their own auth. This not only leads to security issues but is also a massive time drain.

We want to change that - we believe the only way is to provide a solution that has the right level of abstraction gives you maximum control, is secure, and is simple to use - just like if you build it yourself, from scratch (minus the time to learn, build, and maintain).

We also believe in the principle of least vendor lock-in. Your having full control of your user's data means that you can switch away from SuperTokens without forcing your existing users to logout, reset their passwords, or in the worst case, sign up again.

Click here to see the demo app.

Documentation

The docs can be seen on our website.

There is more information about SuperTokens on the GitHub wiki section.

🏗️ Architecture

Please find an architecture diagram here

For more information, please visit our GitHub wiki section.

☕ Why Java?

⌨️ User Management Dashboard

Oversee your users with the SuperTokens User Management Dashboard

List users

List all the users who have signed up to your application.

List SuperTokens users

Manage users

Manage users by modifying or deleting their sessions, metadata, roles and account info.

Manage users

🔥 SuperTokens vs others

Please find a detailed comparison chart on our website

🛠️ Building from source

Please see our wiki for instructions.

👥 Community

If you think this is a project you could use in the future, please :star2: this repository!

Contributors (across all SuperTokens repositories)


Rishabh Poddar

Advait Ruia

Bhumil Sarvaiya

Joel Coutinho

Rakesh UP

Mufassir Kazi

Nemi Shah

Rohit Bhatia

Madhu Mahadevan

Aidar Nugmanoff

Arnav Dewan

NkxxkN

LordChadiwala

Luiz Soares

Sudipto Ghosh

Fabricio20

metallicmonkey

Vidhyanshu Jain

Domenico Luciani

Enzo Batrov

Eloïse Isautier

Ákos Resch

Chotu Chaudhary

Tomáš Horáček

Sam Bauch

Alexey Tylindus

Gus Fune

chenkaiC4

Marek Dulowski

Piyushh Bhutoria

Eric Dobbertin

Kyle Dodson

Ralph Lawrence

Christopher Kapic

Hanzyusuf

Mihály Lengyel

Cerino O. Ligutom III

nadilas

Vasile Catana

Jay Mistry

Jacob Marshall

miketromba

Oleg Vdovenko

Siddharth

xuatz

Yoway Buorn

Ronit Panda

Anugrah Singhal

Jeremy Eastham

Assaf Yacobi

Sattvik Chakravarthy

Olivier Pichon

Siddhant Varma

renyijiu

Isaiah Thomason

Utsav Barnwal

Saurabh Ghatnekar

supertokens-core (supertokens/supertokens-core)

Searching Database…

这是什么?SuperTokens 是一个开源的认证服务,可以为你的应用添加安全的登录和会话管理——它是 Auth0、Firebase Auth 和 AWS Cognito 这类专有服务的开源替代方案(开放核心模式)。
这个仓库是整套认证系统,还是只是其中一部分?只是其中一部分:这是 SuperTokens Core,即保存核心认证逻辑和数据库操作的 HTTP 服务。一套完整的方案还需要一个前端 SDK 和一个后端 SDK,它们都与这个服务通信。
怎么把它跑起来?下载二进制文件或 Docker 镜像——发行包里已经内置了 JDK——然后像其他 HTTP 微服务一样运行它。从源码构建的方法在项目 wiki 上有说明。
我的应用需要添加什么才能连接它?一个后端 SDK(Node.js、Go、Python 等)加上一个前端 SDK(React.js、React Native、Vanilla JS 等)——前端负责会话令牌和登录界面,后端负责与核心服务通信。
它真的免费使用吗,还是有什么限制?核心永久免费,对用户数量没有任何限制。它是一个开放核心(open-core)项目,所以像企业级 SSO 这样的企业版附加功能是额外提供的,但服务本身完全免费。
我用户的数据会存在哪里?存在你自己的基础设施上:核心部署在本地环境,配合你自己的数据库,因此你对用户数据拥有 100% 的控制权,以后想换掉它也不用强迫用户重新登录或注册。
它开箱支持哪些登录方式?免密码登录、社交账号登录、邮箱加密码、手机号加密码,此外还有会话管理、多因素认证、带企业级 SSO 的多租户、用户角色以及微服务认证。
核心为什么用 Java 编写,会不会很占资源?团队选择 Java 是因为它生态成熟、类型系统强大,而且二进制文件自带 JDK,你完全不用自己管理。内存占用很低,因为会话校验在后端 SDK 里完成,不需要请求核心服务——一个实例就能支持几万名用户——而且还计划支持 GraalVM,把内存占用降低 95%。
注册的用户能在什么地方管理吗?可以——用户管理仪表盘(User Management Dashboard)可以列出所有注册到你应用的用户,并支持修改或删除他们的会话、元数据、角色和账户信息来进行管理。
试用它必须换掉我整套认证方案吗?不用。各项功能是有意解耦的:你可以只用登录功能、只用会话管理,或者两者都用——SuperTokens 甚至可以与 Auth0 等其他登录服务配合,只提供会话管理集成。
Size
819.5 MB
Stars
15.3K
Age
6y
Commits · 90 Days