lakhansamani/authorizer

Authorizer

镜像概述和主要用途

Authorizer 是一个开源的认证和授权解决方案，适用于各类应用程序。它允许你使用自己的数据库，完全控制用户信息。你可以自托管 Authorizer 实例，并连接到多种数据库（目前支持 11+ 种数据库，包括 Postgres、MySQL、SQLite、SQLServer、YugaByte、MariaDB、PlanetScale、CassandraDB、ScyllaDB、MongoDB、ArangoDB）。

核心功能和特性

主要功能

• ✅ 使用电子邮件ID和密码登录/注册
• ✅ 安全会话管理
• ✅ 电子邮件验证
• ✅ 兼容 OAuth2 和 OpenID 的 API
• ✅ 安全更新个人资料的 API
• ✅ 通过电子邮件实现忘记密码流程
• ✅ 社交登录（Google、Github、***、LinkedIn、Apple，更多即将支持）
• ✅ 基于角色的访问控制
• ✅ 带魔法链接的无密码登录
• ✅ 多因素认证
• ✅ 电子邮件模板
• ✅ Webhooks

路线图

• VueJS SDK
• Svelte SDK
• React Native SDK
• Flutter SDK
• Android 原生 SDK
• iOS 原生 SDK
• Golang SDK
• Python SDK
• PHP SDK
• WordPress 插件
• Kubernetes Helm Chart
• Local Stack 支持
• AMI 镜像
• Digital Ocean Droplet 部署
• Azure 部署
• Render 部署
• 使用 Fly.io 进行边缘部署
• 基于手机号和 OTP SMS 的无密码登录

使用场景和适用范围

• 需要自托管认证系统的应用程序
• 希望完全控制用户数据的企业或开发者
• 需要多种登录方式（***密码、社交登录、无密码登录等）的应用
• 需要实现基于角色访问控制的系统
• 需要符合 OAuth2 和 OpenID 标准的认证服务

详细使用方法和配置说明

快速开始

步骤 1：获取 Authorizer 实例

部署生产环境实例

使用以下一键部署选项部署生产就绪的 Authorizer 实例：

使用源码部署

本指南帮助你在生产环境使用前评估 Authorizer，包括在本地或独立模式下安装 Authorizer 服务器的说明。

前提条件

• 操作系统：Linux、macOS 或 Windows
• Go (Golang) >= v1.15

项目设置

1. Fork https://github.com/authorizerdev/authorizer 仓库（如果有权限访问仓库，可跳过此步骤）
2. 克隆仓库：git clone https://github.com/authorizerdev/authorizer.git 或使用步骤 1 中的 fork 地址
3. 进入目录：cd authorizer
4. 创建环境文件：cp .env.sample .env（所有支持的环境变量见https://docs.authorizer.dev/core/env/%EF%BC%89
5. 构建仪表盘：make build-dashboard
6. 构建应用：make build-app
7. 构建服务器：make clean && make

   注意：如果没有 https://www.ibm.com/docs/en/aix/7.2?topic=concepts-make-command%EF%BC%8C%E5%8F%AF%E8%BF%9B%E5%85%A5 server 目录使用 go build 命令构建。这种情况下，需要在 dashboard 和 app 目录手动使用 npm run build 构建。

8. 运行二进制文件：./build/server

使用二进制文件部署

通过 https://github.com/authorizerdev/authorizer/releases 下载适用于以下操作系统的二进制文件：

• Mac OSX
• Linux

下载并解压

• 从https://github.com/authorizerdev/authorizer/releases%E4%B8%8B%E8%BD%BD%E5%AF%B9%E5%BA%94%E6%93%8D%E4%BD%9C%E7%B3%BB%E7%BB%9F%E7%9A%84%E4%BA%8C%E8%BF%9B%E5%88%B6%E5%8C%85

  注意：Windows 用户建议使用 Docker 镜像运行 Authorizer。

• 使用以下命令解压：
  Mac / Linux:

  sh
  tar -zxf AUTHORIZER_VERSION -c authorizer
  

• 进入目录：

  sh
  cd authorizer
  

启动 Authorizer

• 运行以下命令启动：
  Mac / Linux 用户：

  sh
  ./build/server
  

  注意：Mac 用户可能需要授予执行权限，命令：xattr -d com.apple.quarantine build/server

步骤 2：设置实例

• 在浏览器中打开 Authorizer 实例端点
• 使用安全密码注册为管理员
• 从 Authorizer 仪表盘配置环境变量（更多信息见https://docs.authorizer.dev/core/env/%EF%BC%89

  注意：DATABASE_URL、DATABASE_TYPE 和 DATABASE_NAME 只能通过平台环境变量配置。

注意事项

• 社交登录需要相应平台的密钥和密钥
• 如需验证用户，需要 SMTP 服务器及用于发送邮件的***地址和密码（系统会发送验证链接，验证后才能访问）

  注意：可禁用邮件验证以允许开放注册，但不建议用于生产环境（可能导致他人使用他人***注册）

• 如需持久化用户会话，需要 Redis URL（Railway 应用除外）。未配置 Redis 时，会话将在实例运行期间保持。为提高授权请求/中间件响应速度，建议将 Redis 部署在与 Authorizer 服务器相同的基础设施/网络中。

测试

测试说明见https://github.com/authorizerdev/authorizer/blob/main/.github/CONTRIBUTING.md#testing

集成到网站

以下示例演示如何使用 @authorizerdev/authorizer-js CDN 版本，快速为网站添加登录功能。也可使用 @authorizer-js 的 ES 模块版本或框架特定版本（如 @authorizerdev/authorizer-react）。

在 HTML 文件中复制以下代码

注意：将代码中的 AUTHORIZER_URL 替换为你的 Authorizer URL，可修改登出按钮组件。

html
<script src="https://unpkg.com/@authorizerdev/authorizer-js/lib/authorizer.min.js"></script>

<script type="text/javascript">
	const authorizerRef = new authorizerdev.Authorizer({
		authorizerURL: `YOUR_AUTHORIZER_INSTANCE_URL`,
		redirectURL: window.location.origin,
		clientID: 'YOUR_CLIENT_ID', // 从 Authorizer 仪表盘获取客户端 ID
	});

	// 根据应用使用按钮选择器
	const logoutBtn = document.getElementById('logout');
	logoutBtn.addEventListener('click', async function () {
		await authorizerRef.logout();
		window.location.href = '/';
	});

	async function onLoad() {
		const res = await authorizerRef.authorize({
			response_type: 'code',
			use_refresh_token: false,
		});
		if (res && res.access_token) {
			// 可在此处使用用户信息，例如：
			const user = await authorizerRef.getProfile({
				Authorization: `Bearer ${res.access_token}`,
			});
			const userSection = document.getElementById('user');
			const logoutSection = document.getElementById('logout-section');
			logoutSection.classList.toggle('hide');
			userSection.innerHTML = `Welcome, ${user.email}`;
		}
	}
	onLoad();
</script>