管理員友好的用戶管理伺服器(帶有密鑰和 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 專案! ?