tesseral 的安装和配置教程

项目基础介绍

Tesseral 是一个开源的认证基础设施，专为B2B SaaS（软件即服务）业务设计。它是一个多租户、API优先的服务，旨在在云上运行。Tesseral 不是一个绑定到特定语言或框架的认证库；它可以与任何技术栈一起工作。

主要编程语言

该项目主要使用 Go 语言开发。

关键技术和框架

• 多租户架构
• API优先的设计
• 支持多种认证方式，如魔法链接、社交登录、SAML单点登录、SCIM目录同步等
• 角色基础访问控制（RBAC）
• 多因素认证（MFA）
• 支持Passkeys/WebAuthn和认证器应用（TOTPs）
• API密钥管理
• 用户邀请和实时Webhooks

准备工作

在开始安装和配置 Tesseral 前，请确保您已经满足了以下条件：

1. 安装了 Go 语言环境
2. 安装了 Node.js 和 npm，因为前端集成可能需要它们
3. 准备了一个用于安装 Tesseral 的项目目录

安装步骤

步骤 1：克隆项目

首先，您需要从 GitHub 上克隆 Tesseral 项目。

git clone https://github.com/tesseral-labs/tesseral.git
cd tesseral

步骤 2：安装依赖

安装项目依赖，这可能包括后端和前端依赖。

# 安装后端依赖
go mod tidy

# 安装前端依赖（如果需要）
cd path/to/frontend
npm install

步骤 3：配置环境

根据项目需求，配置 .env 文件。

# 复制 .env.example 文件为 .env
cp .env.example .env

# 根据您的需求编辑 .env 文件

步骤 4：启动服务

启动后端服务。

go run .

如果项目中有前端部分，您可能还需要启动前端服务。

# 在前端目录中
npm start

步骤 5：集成 SDK

根据您使用的框架，集成对应的 Tesseral SDK。

前端集成

例如，如果您使用 React，您可以按照以下步骤集成 Tesseral SDK。

npm install @tesseral/tesseral-react

# 在您的 React 应用中
import { TesseralProvider } from '@tesseral/tesseral-react';
// ...

<TesseralProvider publishableKey="your_publishable_key">
  <App />
</TesseralProvider>

后端集成

例如，如果您使用 Flask，您可以按照以下步骤集成 Tesseral SDK。

from flask import Flask
from tesseral_flask import access_token_claims, require_auth

app = Flask(__name__)

app.before_request(require_auth(publishable_key="your_publishable_key"))

@app.route("/api/hello", methods=["GET"])
def hello():
    email = access_token_claims().user.email
    return f"hello, {email}"

if __name__ == "__main__":
    app.run(debug=True, port=5050)

请确保替换 "your_publishable_key" 为您项目实际的发布密钥。

按照以上步骤操作后，您应该能够成功安装和配置 Tesseral。