authcompanion2
4.0.0-beta.1
管理员友好的用户管理服务器（带有密钥和 JWT）- 用于无缝、安全地集成用户身份验证。
有用的链接：文档 |变更日志 |演示网站 |关注乳齿象
AuthCompanion 旨在满足 Web 应用程序最常见的身份验证和用户管理需求。
使用 AuthC，您可以：
| 登录屏幕 | 注册屏幕 |
|---|---|
 |  |
以下说明将启动默认服务器以探索这些功能。
前置要求：
如果您还没有这样做，请克隆存储库，并使用以下命令安装依赖项：
$ npm install准备好后，使用默认设置启动服务器！
$ npm start启动服务器（使用默认配置）：
$ docker run -it -p 3002:3002 --name AuthCompanion ghcr.io/authcompanion/authcompanion2:main还可以使用 docker-compose.yml
如果您只是第一次尝试 AuthC，则默认配置将起作用。请参阅配置指南，详细了解如何为其他环境配置服务器。
准备好后，请阅读启动指南，了解有关在生产中设置 AuthC 的更多信息。
用于用户身份验证的 Web 表单：使用预构建和可自定义的 Web 表单，供应用程序用户执行以下操作：使用其凭据登录、注册帐户、更新其个人资料以及发出忘记的密码。
用于管理用户配置文件的管理仪表板：通过自助服务仪表板修改用户的配置文件信息 - 所有帐户信息都存储在 SQLite 数据库中。
用户帐户恢复：使用“忘记密码”流程恢复用户对其帐户的访问权限，该流程通过电子邮件发送特殊链接，以帮助用户快速恢复其帐户。
无密码流程：使用密钥简化用户的登录和注册，并使用移动设备、USB 安全密钥或计算机对用户进行身份验证。
可扩展平台： AuthC 支持插件系统，可以轻松添加新功能来满足您的更多身份验证需求。
Authcompanion 提供用于用户身份验证的内置 Web 表单，包括登录和注册页面。
用户使用 AuthC 的 Web 表单进行身份验证后，我们会将其传递到您的 Web 应用程序。
有关 AuthC Web 表单的完整列表，请参阅 Web 表单指南。
管理仪表板是一种工具，允许管理员或应用程序所有者管理其 Web 应用程序的用户。它提供了一系列功能，管理员可以使用它们来创建、编辑和删除用户帐户；一切都通过友好直观的界面进行。
查看文档中的管理仪表板以了解如何访问它：管理。
最好的学习方式是实践；这里有几种入门方法。
您可以使用 demo.authcompanion.com 上公开提供的演示，也可以在本地启动服务器。
AuthC 附带预构建的 Web 表单，可帮助您快速将用户身份验证与您的 Web 应用程序集成。
在 AuthC 服务器运行的情况下（在前面的步骤中），首先使用以下 Web 表单注册帐户：http://localhost:3002/v1/web/register
接下来，使用您刚刚在以下 Web 表单中使用电子邮件和密码创建的帐户登录：http://localhost:3002/v1/web/login。服务器响应包含一个访问令牌，供在对后端 API 进行身份验证时使用，并将用户重定向到应用程序的主页。
使用通过管理指南找到的凭据登录管理仪表板，并通过更改用户的电子邮件（或类似字段）来更新您在上一步中创建的用户配置文件。
查看集成指南，了解前端应用程序和后端 Web 服务如何与 AuthC 交互。
RESTful 身份验证 API 为 Web 表单提供支持，用户可以通过该表单对您的 Web 应用程序进行身份验证。请务必注意，仅 Web 表单并不能涵盖用户的每个身份验证流程。例如：刷新过期的访问令牌除了使用 Web From 之外还需要与 AuthC 的 API 进行交互。
有关身份验证 API 的更多信息，请查看此处的文档：Auth API
管理 API 可帮助管理员管理其 Web 应用程序的用户。它提供了一系列功能，管理员可以通过这些功能以编程方式创建、编辑和删除用户帐户。管理 API 也由管理仪表板本机使用。
有关管理 API 的更多信息，请查看此处的文档：管理 API
AuthCompanion 根据 Big Time Public License 获得许可。这些条款允许您出于非商业目的以及在小型企业中免费使用和共享该软件，同时还保证以公平、合理和非歧视的条款为大型企业提供付费许可。
为标志设计喝彩 - Timothy Reeder (Github)
原型的繁重工作和不断的灵感 - Teddy Schmitz (Github)
将 AuthCompanion 这个有用的助手带入您的下一个 Web 项目！ ？
