README

Yii 2的Oauth2 + OpenID Connect扩展

Yii2-Oauth2-Server是针对Yii框架2.0应用程序的扩展，它提供了一个基于League OAuth2服务器的Oauth2服务器。该服务器还支持OpenID Connect核心。

📑 内容

入门
试驾
文档
常见问题解答
实现标准
导入/迁移
版本控制 & 变更日志
报告安全问题
目录结构
贡献
鸣谢
许可

🐣 入门

如果您还不熟悉Oauth 2，我们建议您查看OAuth和OpenID Connect图解指南

要求

最低要求的PHP版本是7.4（兼容性测试到包括PHP 8.1）。
最低要求的Yii版本是2.0.49（使用SQLite时为2.0.50）。

安装

安装此扩展的首选方式是通过composer。

composer require rhertogh/yii2-oauth2-server

完整的安装和配置细节可以在以下文档中找到：安装Yii2-Oauth2-Server

🏎️ 试驾

您可以使用Docker运行本地预览实例。

docker run --rm -p 82:80 --name Yii2Oauth2Server ghcr.io/rhertogh/yii2-oauth2-server:master

容器启动后，您可以在localhost:82访问Oauth2服务器。

提示：主机机器上的端口号由-p参数的第一部分指定。如果需要，可以更改该端口号（例如：-p 88:80）。

要访问Docker容器的CLI，您可以运行

docker container exec -it Yii2Oauth2Server bash

📖 文档

文档中有两个主要部分：

使用指南，用于在您的项目中使用Yii2-Oauth2-Server。
开发指南，用于为Yii2-Oauth2-Server做出贡献。

🔮 常见问题解答

这是一个快速常见问题解答，完整版本可以在这里找到：这里。

在哪里可以找到Oauth2端点？

要查看端点的概述和其他配置，您可以运行：./yii oauth2/debug/config

如何查看已配置的客户端？

要查看客户端概览，您可以运行：./yii oauth2/client/list

OAuth2服务器抛出错误，我该怎么办？

请首先查看完整FAQ。如果这不能解决问题，请报告问题。

📒 实现的标准

¹ 通过PHP OAuth 2.0 Server提供。

↘️ 导入/迁移

为了方便从其他项目迁移，Yii2-Oauth2-Server支持从其他项目导入数据。例如从filsh/yii2-oauth2-server

请参阅从其他服务器导入/迁移以获取更多信息。

📜 版本控制 & 更新日志

Yii2-Oauth2-Server遵循语义版本化2.0
请参阅更新日志以获取版本历史信息和升级到新版本的升级说明。

🔎 报告安全问题

如果您发现了安全问题，请直接联系我们。请不要使用问题跟踪器或公开讨论，因为这会带来更多损害而不是帮助。

请注意，作为一个非商业开源项目，我们无法支付赏金。

📂 目录结构

docker/     Docker container definition
docs/       Documentation (for both usage and development)
sample/     Sample app for the server
src/        Yii2-Oauth2-Server source
tests/      Codeception unit and functional tests

🚀 贡献

Yii2-Oauth2-Server是开源的。您可以通过以下方式帮助：

感谢您的贡献！

🎉 致谢

✒️ 许可证

Yii2-Oauth2-Server是免费软件。它根据Apache许可证的条款发布。请参阅LICENSE.md以获取更多信息。

rhertogh / yii2-oauth2-server

维护者

详细信息