MaxKey 单点登录系统技术文档

【免费下载链接】MaxKey Dromara 🗝️MaxKey单点登录认证系统是业界领先的IAM-IDaas身份管理和认证产品，遵循 Apache License, Version 2.0 开源免费，支持OAuth2.x、OpenID Connect、SAML2.0、CAS、JWT、SCIM等SSO标准协议，基于RBAC统一权限控制，实现用户生命周期管理，开源、安全、合规、自主可控。 项目地址: https://gitcode.com/dromara/MaxKey

1. 安装指南

1.1 系统要求

• JDK: v17+
• 数据库: MySQL 8.4.2+
• 操作系统: Windows/Linux/Docker/宝塔面板

1.2 下载安装包

从官方网站下载最新版本(v4.1.8)安装包

1.3 安装步骤

1. 数据库准备:

   • 创建MySQL数据库
   • 执行初始化SQL脚本

2. 应用部署:

   • 解压安装包至目标目录
   • 配置数据库连接参数(application.properties)
   • 配置Redis连接(如使用)

3. 启动服务:

   • Windows: 运行startup.bat
   • Linux: 执行startup.sh

2. 使用说明

2.1 管理员登录

• 默认管理员账号: admin
• 初始密码: 安装时设置
• 首次登录需修改密码

2.2 用户管理

• 支持手动添加用户
• 支持LDAP/AD域用户同步
• 支持SCIM 2.0协议的用户同步

2.3 应用管理

1. 添加应用
2. 配置认证协议(OAuth2/SAML/JWT等)
3. 分配访问权限

2.4 认证方式配置

• 基础认证: 用户名/密码
• 多因素认证: 短信/TOPT/邮件
• 社交账号登录: 微信/QQ/钉钉等

3. API使用文档

3.1 认证协议支持

协议类型	端点路径	说明
OAuth 2.0	/oauth2/authorize	授权端点
	/oauth2/token	令牌端点
SAML 2.0	/saml2/idp/SSO	SAML单点登录端点
CAS	/cas/login	CAS协议登录端点
SCIM 2.0	/scim/v2/Users	用户管理端点

3.2 REST API示例

获取用户信息(需OAuth2令牌)

GET /api/v1/users/{userId}
Authorization: Bearer {access_token}

创建应用

POST /api/v1/apps
Content-Type: application/json

{
  "appName": "示例应用",
  "appProtocol": "OAuth2",
  "appSecret": "your_secret_key"
}

4. 项目安装方式

4.1 标准安装

1. 下载war包或可执行jar
2. 部署至Tomcat或直接运行
3. 访问http://localhost:8080/maxkey

4.2 Docker安装

docker pull maxkeytop/maxkey:latest
docker run -d -p 8080:8080 maxkeytop/maxkey

4.3 宝塔面板安装

1. 通过宝塔应用商店搜索MaxKey
2. 一键安装并配置
3. 通过面板管理服务

4.4 集群部署

1. 配置共享Redis集群
2. 部署多个MaxKey实例
3. 配置负载均衡

5. 安全配置建议

1. 定期更换数据库密码
2. 启用HTTPS加密传输
3. 配置IP访问限制
4. 开启操作日志审计
5. 定期备份关键数据

6. 常见问题处理

1. 启动失败: 检查JDK版本是否为17+
2. 数据库连接问题: 验证数据库配置和网络连通性
3. 认证失败: 检查应用密钥和回调URL配置
4. 性能问题: 建议配置Redis缓存会话数据

【免费下载链接】MaxKey Dromara 🗝️MaxKey单点登录认证系统是业界领先的IAM-IDaas身份管理和认证产品，遵循 Apache License, Version 2.0 开源免费，支持OAuth2.x、OpenID Connect、SAML2.0、CAS、JWT、SCIM等SSO标准协议，基于RBAC统一权限控制，实现用户生命周期管理，开源、安全、合规、自主可控。 项目地址: https://gitcode.com/dromara/MaxKey