diff --git a/README.md b/README.md index 2ad5a050..f1a1fdfb 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ -------------------------- -
⭐️ 如果你喜欢 TopIAM，请给它一个 Star，您的支持将是我们前行的动力。
+
⭐️ 如果你喜欢 TopIAM，请给它一个 Star，您的支持将是我们前行的动力，项目正在积极开发，欢迎共建 👏🏻。
-------------------------- @@ -23,9 +23,12 @@ 用于管理企业内员工账号、权限、身份认证、应用访问，帮助整合部署在本地或云端的内部办公系统、业务系统及三方 SaaS 系统的所有身份，实现一个账号打通所有应用的服务。 -## 系统架构 +## 产品价值 -![](https://github.com/topiam/eiam/assets/30397655/dc2c2749-e873-4d4d-ba20-43d5db81c6b8) +传统企业 IT +大多采用烟囱式建设方式，各系统独立建设账号体系、权限体系，当企业团队人数达到数十人至数百人时，由于系统数量多，在账户、密码、权限管理上会出现瓶颈。员工入职、离职，转岗都需要进行账号权限分配等此类管理，操作低效、功能重复、价值低，员工需要记录多套系统密码，容易出现安全问题，导致数据外泄。用户身份认证安全存疑，敏感系统缺乏严格的身份认证机制。 + +`EIAM` 提供一套集中式账号、权限、认证、应用、审计等，帮助企业打通身份数据孤岛，实现用户全生命周期，实现一个账号打通所有应用的服务，强化企业安全体系，提升组织管理效率，助力企业数字化转型升级。 ## 核心特性 @@ -38,40 +41,114 @@ + 提供标准`REST`和`SCIM2.0`接口轻松完成机构用户同步，实现企业对于账号生命周期的精细化管理。 + 开源、安全、自主可控。 -## 功能描述 -| 功能模块 | 功能项 | 功能描述 | -|:-----|:---------|:---------------------------| -| 账户管理 | 组织与用户 | 支持组织与用户维护。 | -| | 用户组管理 | 支持用户组维护。 | -| | 身份源管理 | 支持通过钉钉、飞书等途径同步用户和组织信息到系统。 | -| 认证管理 | 认证提供商 | 支持配置多种认证源，用户可通过不同方式登录门户。 | -| 应用管理 | OIDC协议应用 | 支持通过OIDC协议进行应用SSO。 | -| | 表单代填应用 | 支持表单代填方式进行应用SSO。 | -| | JWT协议应用 | 支持JWT协议进行应用SSO。 | -| 行为审计 | 用户行为 | 记录企业用户相关操作行为记录。 | -| | 管理员行为 | 记录管理员相关操作记录。 | -| 安全设置 | 通用安全 | 支持通用安全配置，及安全防御策略。 | -| | 密码策略 | 支持配置用户密码全局规则策略。 | -| | 系统管理员 | 负责维护系统用户配置等。 | -| 系统设置 | 消息设置 | 支持配置维护邮件模版、邮件服务、短信服务。 | -| | IP地理库 | 支持配置IP地理库，实现精准IP定位。 | -| | 存储配置 | 支持配置云存储服务，如阿里云、腾讯云、MinIO等。 | -| 系统监控 | 会话管理 | 支持查看系统登录会话，支持回话下线。 | +## 页面展示 + +> 仅展示部分UI页面 + ++ 管理端 + +![](https://user-images.githubusercontent.com/30397655/205442813-c5664670-aa12-4415-aa66-dadcddd04109.jpg) + +![](https://user-images.githubusercontent.com/30397655/206887727-2e6449a9-b75a-46f8-9fab-f215e2d26a38.png) + +![](https://user-images.githubusercontent.com/30397655/206887777-d1e6d138-8ab8-4d9b-87f6-08ea497a374e.png) + +![](https://user-images.githubusercontent.com/30397655/206887895-8c204839-9a74-4167-87f3-a131a528d444.png) + +-------------------------- + ++ 门户端 + +![](https://user-images.githubusercontent.com/30397655/206888201-93b1b261-40a6-4e83-b04c-8589da5f2f8a.jpg) ## 在线演示 + 管理端：https://eiam-console.topiam.cn - > 体验账号：console/topiam.cn + 用户端：https://eiam-portal.topiam.cn - > 体验账号：portal/topiam.cn + +> 注意：演示环境已屏蔽敏感权限和相关操作 + +## 开源说明 + +一方面希望通过开源加强项目产品化程度；另一方面希望在社区中吸收更多的实践场景进而继续完善产品，也欢迎大家参与到项目中来。 + +为保证社区繁荣和项目自由健康发展，在开源许可证方面，`TopIAM` 选择采用 `AGPL-3.0` 开源协议，`AGPL-3.0` 是 OSI +批准的许可证，符合自由和开源软件的所有标准，**开源永远是我们的初心与核心，我们将始终不渝的坚持去做这件事，我们相信在社区的推动下，这件事我们一定会做的更好**。 + +或许很多开发者对此协议抱有一些疑问，开源社区目前也有很多采用 `AGPL-3.0` 协议的开源软件，例如 `MongoDB`、`Grafana`、`Loki` +等，维基百科还专门有一份列表列出了哪些[开源项目](https://en.wikipedia.org/wiki/Category:Software_using_the_GNU_AGPL_license) +采用了 `AGPL-3.0` 开源协议。 + +`AGPL-3.0` 协议有一个非常关键的点，即对修改上游开源项目代码后的二次分发版本必须也要开源，协议限制的是部分企业想 `Folk` +开源项目代码后进行闭源商业分发，跟上游开源项目的维护团队进行直接的商业竞争，如果仅仅只是企业内部自己使用而不进行任何层面修改，用户大可不必担心 `AGPL-3.0` +协议带来的限制， 这些条件旨在鼓励和希望修改软件的第三方也为项目和社区做出贡献。我们认为这是一种更公平的前进方式，我们相信这将有助于我们建立更强大的社区。 + +简单来讲：如果您修改了 `TopIAM` 项目源代码，那么您必须将这些修改贡献给社区，**绝不允许修改后和衍生的代码做为闭源的商业软件发布和销售**。 + +我们也提供了商业授权，如果您**需要将本产品进行二次开发、更改并进行任何附带商业化性质行为使用** +，请联系我们进行商业授权，以遵守 `AGPL-3.0` 协议保证您的正常使用。 + +除此之外，我们也会酌情接受根据个人或企业需求的定制化开发。 + +目前在国内 `GPL` 协议**具备合同特征，是一种民事法律行为** ，属于我国《合同法》调整的范围。 `TopIAM` 项目团队保留诉讼权利。 + +[相关案例：违反 `GPL` 协议赔偿 50 万，国内首例！](https://mp.weixin.qq.com/s/YQ6sNjbDS-P7BViLZIsaoA) + +> **TopIAM 开源团队拥有对本开源协议的最终解释权。** ## 技术架构 -- **后端**：[Spring Boot](https://spring.io/projects/spring-boot/) 、[Spring Security](https://spring.io/projects/spring-security/) -- **前端**：[React.js](https://react.dev/) 、[Ant Design](https://ant.design) -- **中间件**：[MySQL](https://www.mysql.com/) 、[Redis](https://redis.io/)、[ElasticSearch](https://www.elastic.co/cn/elasticsearch/)、[RabbitMQ](https://www.rabbitmq.com/) -- **基础设施**：[Docker](https://www.docker.com/) +前端技术栈：`ES6`、`React`、`TypeScript`、`UmiJS`、`Axios`、`Ant Design`； + +后端技术栈：`JDK17`、`Spring Boot`、`Spring Data`、`Spring Security`、`Elasticsearch`、`Redis`、`MySQL`； + +## 模块说明 + +``` +eiam +├── eiam-alert -- 报警模块 +├── eiam-application -- 应用模块 +├ ├── eiam-application-all -- 应用聚合模块 +├ ├── eiam-application-core -- 应用核心模块 +├ ├── eiam-application-cas -- cas应用模块 +├ ├── eiam-application-form -- form应用模块 +├ ├── eiam-application-jwt -- jwt应用模块 +├ ├── eiam-application-oidc -- oidc应用模块 +├ ├── eiam-application-saml2 -- saml2应用模块 +├── eiam-audit -- 日志审计模块 +├── eiam-authentication -- 身份认证模块 +├ ├── eiam-authentication-all -- 身份认证聚合模块 +├ ├── eiam-authentication-core -- 身份认证核心模块 +├ ├── eiam-authentication-dingtalk -- 钉钉身份认证模块 +├ ├── eiam-authentication-feishu -- 飞书身份认证模块 +├ ├── eiam-authentication-qq -- qq身份认证模块 +├ ├── eiam-authentication-wechat -- 微信身份认证模块 +├ ├── eiam-authentication-wechatwork -- 企业微信身份认证模块 +├ ├── eiam-authentication-sms -- 短信身份认证模块 +├ ├── eiam-authentication-mfa -- MFA身份认证模块 +├── eiam-common -- 公共模块 +├── eiam-console -- 控制台服务 +├── eiam-core -- 核心模块 +├── eiam-identity-source -- 身份源模块 +├ ├── eiam-identity-source-all -- 身份源聚合模块模块 +├ ├── eiam-identity-source-core -- 身份源对接核心模块 +├ ├── eiam-identity-source-dingtalk -- 钉钉身份源模块 +├ ├── eiam-identity-source-wechatwork -- 企业微信身份源模块 +├ ├── eiam-identity-source-feishu -- 飞书身份源模块 +├── eiam-openapi -- OpenAPI服务 +├── eiam-portal -- 门户端服务 +├── eiam-protocol -- 协议模块 +├ ├── eiam-protocol-all -- 协议聚合模块 +├ ├── eiam-protocol-core-- 协议核心模块 +├ ├── eiam-protocol-cas -- cas协议模块 +├ ├── eiam-protocol-form -- form协议模块 +├ ├── eiam-protocol-jwt -- jwt协议模块 +├ ├── eiam-protocol-oidc -- oidc协议模块 +├ ├── eiam-protocol-saml2 -- saml2协议模块 +├── eiam-support -- support模块 +└── eiam-synchronizer -- 同步服务 +``` ## 快速启动 @@ -84,18 +161,17 @@ git clone https://gitee.com/topiam/eiam.git ### 配置参数 application.yml文件依次修改以下配置 - * database 配置 * redis 配置 * elasticsearch 配置 -> 项目使用 [liquibase](https://www.liquibase.org/) 管理数据库，新建`eiam_develop`数据库 不需要手动创建表结构，服务启动后，会自动创建表结构。 +>项目使用 [liquibase](https://www.liquibase.org/) 管理数据库，新建`eiam_develop`数据库 不需要手动创建表结构，服务启动后，会自动创建表结构。 ### 启动项目 * eiam-openapi (必选) * eiam-console (必选) -* eiam-protal (必选) +* eiam-portal (必选) * eiam-synchronizer（可选） > 项目启动没有依赖顺序 @@ -106,26 +182,20 @@ application.yml文件依次修改以下配置 ![](https://user-images.githubusercontent.com/30397655/208237130-5655a8a4-b528-45d3-ad7c-4295b9f7d42d.png) -## 微信公众号 + +## 联系我们 + +如果您在 `TopIAM` 产品上的任何想法、意见建议，商务上的合作需求，请扫码添加下方微信进一步沟通。 + +![](https://user-images.githubusercontent.com/30397655/205442835-cfcfbf2e-eefb-4e9f-8f36-72d91c240896.jpg) 欢迎关注 TopIAM 微信公众号，接收产品最新动态。 ![](https://user-images.githubusercontent.com/30397655/206887629-faf77f3e-1681-4918-99bf-773ef434f088.png) -## 微信交流群 +## 加入社群 -如果您想加入我们的开源交流群，请扫码添加下方微信，拉您入群，请您在询问前尽可能全面的描述您的情况，例如： - -+ 当前使用的系统版本 -+ 当前使用的浏览器类型 -+ 详细的问题描述 -+ 问题的截图说明 - -![](https://user-images.githubusercontent.com/30397655/205442835-cfcfbf2e-eefb-4e9f-8f36-72d91c240896.jpg) - -## QQ交流群 - -![](https://github.com/topiam/eiam/assets/30397655/3983edc4-5b74-4210-8a4c-dbc03df46da7) +![](https://user-images.githubusercontent.com/30397655/217441678-f6499558-77d6-422d-92a4-13a439c0faa6.jpg) ## 参与贡献 @@ -135,10 +205,36 @@ application.yml文件依次修改以下配置 和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393) ，更好的问题更容易获得帮助。 -## Star History - -[![Star History Chart](https://api.star-history.com/svg?repos=topiam/eiam&type=Date)](https://star-history.com/#topiam/eiam&Date) - ## License license + +## 捐赠支持 + +如果您觉得我们的开源项目对您有帮助，那就请项目开发者们来一杯咖啡☕️吧！当前我们接受来自于**微信**、**支付宝**或者**码云** +的捐赠，请在捐赠时备注自己的昵称或附言。 + +您的捐赠将用于支付该项目的一些费用支出，并激励开发者们更好的推动项目的发展，同时欢迎捐赠**公网服务器** +用于提高开发基础设施环境及在线演示系统体验。 + +![](https://user-images.githubusercontent.com/30397655/205442840-1b54a95c-3d11-4542-ae51-040f849b26aa.jpg) + + +## 常见错误 + +1、项目启动：java.lang.IllegalArgumentException: topiam.server.console-public-base-url must be configured! + +解决方案：application.yml 配置文件中需要对报错的信息地址进行完善 +- console-public-base-url (后台前端服务域名，可配置IP+端口） +- portal-public-base-url (门户前台服务域名，可配置IP+端口） +- openapi-public-base-url (后台服务域名，可配置IP+端口） +- synchronizer-public-base-url (同步认证源服务域名，可配置IP+端口） + +2、提示 cn.topiam.employee.common.entity.* 相关包缺失 + +因项目用到了 `QueryDSL` 查询框架，需要进行编译。 + +解决方案： +- 使用命令 `mvn compile`之后，自动生成代码，对应的代码目标在target/generated-sources目录下。 +- 通过 IDEA 选中其目录，Mark Directory as -> generated sources root 。 +- 通过 IDEA 工具类中File -> Invalidate Caches 清理缓存(可选操作)