From 028f4d27ddd889fa8cd0c39d6440cb0ce0855a84 Mon Sep 17 00:00:00 2001 From: smallbun <2689170096@qq.com> Date: Thu, 14 Sep 2023 18:03:10 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20=E7=89=88=E6=9D=83=E5=A3=B0=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 234 +++++++++++------------------------------------------- 1 file changed, 47 insertions(+), 187 deletions(-) diff --git a/README.md b/README.md index 34d1bf8f..72d11df0 100644 --- a/README.md +++ b/README.md @@ -11,59 +11,23 @@ ---- +--------------------------
⭐️ 如果你喜欢 TopIAM，请给它一个 Star，您的支持将是我们前行的动力。
---- +-------------------------- -## 项目介绍 - -**TopIAM** 数字身份管控平台，简称：EIAM（Employee Identity and Access Management）， -用于管理企业内员工账号、权限、身份认证、应用访问，帮助整合部署在本地或云端的内部办公系统、业务系统及三方 SaaS -系统的所有身份，实现一个账号打通所有应用的服务。 - -## 系统架构 +## 版权声明 -![](https://github.com/topiam/eiam/assets/30397655/dc2c2749-e873-4d4d-ba20-43d5db81c6b8) +开源不代表免费，`TOPIAM` 遵循 AGPL-3.0 开源协议发布，并提供技术交流学习，但绝不允许修改后和衍生的代码做为闭源的商业软件发布和销售！ 如果需要将本产品在本地进行任何附带商业化性质行为使用，请联系项目负责人进行商业授权，以遵守 AGPL 协议保证您的正常使用。 -## 核心特性 +我们也提供了商业授权，如果您**需要将本产品进行二次开发、更改并进行任何附带商业化性质行为使用**，请联系我们进行商业授权，以遵守 `AGPL-3.0` 协议保证您的正常使用。 -- 提供统一组织信息管理，多维度建立对应关系，实现在一个平台对企业人员、组织架构、应用信息的高效统一管理。 -- 支持钉钉、飞书、企业微信等身份源集成能力，实现系统和企业OA平台数据联动，以用户为管理基点，结合入职、离职、调岗、兼职等人事事件，关联其相关应用权限变化而变化，保证应用访问权限的安全控制。 -- 支持多因素认证，行为验证码、社交认证，融合认证等机制，保证用户认证安全可靠。 -- 支持微信、微博、QQ等社交认证集成，使企业具有快速纳入互联网化认证能力。 -- 支持 `SAML2`，`OAuth2`，`OIDC`，`CAS`，表单代填等认证协议及机制，实现单点登录功能，预配置大量 SaaS 应用及传统应用模板，开箱即用。 -- 完善的安全审计，详尽记录每一次用户行为，使每一步操作有据可循，实时记录企业信息安全状况，精准识别企业异常访问和潜在威胁的源头。 -- 提供标准`REST`和`SCIM2.0`接口轻松完成机构用户同步，实现企业对于账号生命周期的精细化管理。 -- 开源、安全、自主可控。 +目前在国内 `GPL` 协议**具备合同特征，是一种民事法律行为** ，属于我国《合同法》调整的范围。 `TOPIAM` 项目团队保留诉讼权利。 -## 功能描述 +[相关案例：违反 `GPL` 协议赔偿 50 万，国内首例！](https://mp.weixin.qq.com/s/YQ6sNjbDS-P7BViLZIsaoA) -| 功能模块 | 功能项 | 功能描述 | -| :------- | :----------- | :------------------------------------------------- | -| 账户管理 | 组织与用户 | 支持组织与用户维护。 | -| | 用户组管理 | 支持用户组维护。 | -| | 身份源管理 | 支持通过钉钉、飞书等途径同步用户和组织信息到系统。 | -| 认证管理 | 认证提供商 | 支持配置多种认证源，用户可通过不同方式登录门户。 | -| 应用管理 | OIDC协议应用 | 支持通过OIDC协议进行应用SSO。 | -| | 表单代填应用 | 支持表单代填方式进行应用SSO。 | -| | JWT协议应用 | 支持JWT协议进行应用SSO。 | -| 行为审计 | 用户行为 | 记录企业用户相关操作行为记录。 | -| | 管理员行为 | 记录管理员相关操作记录。 | -| 安全设置 | 通用安全 | 支持通用安全配置，及安全防御策略。 | -| | 密码策略 | 支持配置用户密码全局规则策略。 | -| | 系统管理员 | 负责维护系统用户配置等。 | -| 系统设置 | 消息设置 | 支持配置维护邮件模版、邮件服务、短信服务。 | -| | IP地理库 | 支持配置IP地理库，实现精准IP定位。 | -| | 存储配置 | 支持配置云存储服务，如阿里云、腾讯云、MinIO等。 | -| 系统监控 | 会话管理 | 支持查看系统登录会话，支持回话下线。 | - -## 开源说明 - -一方面希望通过开源加强项 - ---- +> **TopIAM 开源团队拥有对本开源协议的最终解释权。** ## 项目介绍 @@ -77,53 +41,41 @@ ## 核心特性 -- 提供统一组织信息管理，多维度建立对应关系，实现在一个平台对企业人员、组织架构、应用信息的高效统一管理。 -- 支持钉钉、飞书、企业微信等身份源集成能力，实现系统和企业OA平台数据联动，以用户为管理基点，结合入职、离职、调岗、兼职等人事事件，关联其相关应用权限变化而变化，保证应用访问权限的安全控制。 -- 支持多因素认证，行为验证码、社交认证，融合认证等机制，保证用户认证安全可靠。 -- 支持微信、微博、QQ等社交认证集成，使企业具有快速纳入互联网化认证能力。 -- 支持 `SAML2`，`OAuth2`，`OIDC`，`CAS`，表单代填等认证协议及机制，实现单点登录功能，预配置大量 SaaS 应用及传统应用模板，开箱即用。 -- 完善的安全审计，详尽记录每一次用户行为，使每一步操作有据可循，实时记录企业信息安全状况，精准识别企业异常访问和潜在威胁的源头。 -- 提供标准`REST`和`SCIM2.0`接口轻松完成机构用户同步，实现企业对于账号生命周期的精细化管理。 -- 开源、安全、自主可控。 ++ 提供统一组织信息管理，多维度建立对应关系，实现在一个平台对企业人员、组织架构、应用信息的高效统一管理。 ++ 支持钉钉、飞书、企业微信等身份源集成能力，实现系统和企业OA平台数据联动，以用户为管理基点，结合入职、离职、调岗、兼职等人事事件，关联其相关应用权限变化而变化，保证应用访问权限的安全控制。 ++ 支持多因素认证，行为验证码、社交认证，融合认证等机制，保证用户认证安全可靠。 ++ 支持微信、微博、QQ等社交认证集成，使企业具有快速纳入互联网化认证能力。 ++ 支持 `SAML2`，`OAuth2`，`OIDC`，`CAS`，表单代填等认证协议及机制，实现单点登录功能，预配置大量 SaaS 应用及传统应用模板，开箱即用。 ++ 完善的安全审计，详尽记录每一次用户行为，使每一步操作有据可循，实时记录企业信息安全状况，精准识别企业异常访问和潜在威胁的源头。 ++ 提供标准`REST`和`SCIM2.0`接口轻松完成机构用户同步，实现企业对于账号生命周期的精细化管理。 ++ 开源、安全、自主可控。 ## 功能描述 -| 功能模块 | 功能项 | 功能描述 | -| :------- | :----------- | :------------------------------------------------- | -| 账户管理 | 组织与用户 | 支持组织与用户维护。 | -| | 用户组管理 | 支持用户组维护。 | -| | 身份源管理 | 支持通过钉钉、飞书等途径同步用户和组织信息到系统。 | -| 认证管理 | 认证提供商 | 支持配置多种认证源，用户可通过不同方式登录门户。 | -| 应用管理 | OIDC协议应用 | 支持通过OIDC协议进行应用SSO。 | -| | 表单代填应用 | 支持表单代填方式进行应用SSO。 | -| | JWT协议应用 | 支持JWT协议进行应用SSO。 | -| 行为审计 | 用户行为 | 记录企业用户相关操作行为记录。 | -| | 管理员行为 | 记录管理员相关操作记录。 | -| 安全设置 | 通用安全 | 支持通用安全配置，及安全防御策略。 | -| | 密码策略 | 支持配置用户密码全局规则策略。 | -| | 系统管理员 | 负责维护系统用户配置等。 | -| 系统设置 | 消息设置 | 支持配置维护邮件模版、邮件服务、短信服务。 | -| | IP地理库 | 支持配置IP地理库，实现精准IP定位。 | -| | 存储配置 | 支持配置云存储服务，如阿里云、腾讯云、MinIO等。 | -| 系统监控 | 会话管理 | 支持查看系统登录会话，支持回话下线。 | - -## 版权声明 - -开源不代表免费，`TOPIAM` 遵循 AGPL-3.0 开源协议发布，并提供技术交流学习，但绝不允许修改后和衍生的代码做为闭源的商业软件发布和销售！ 如果需要将本产品在本地进行任何附带商业化性质行为使用，请联系项目负责人进行商业授权，以遵守 AGPL 协议保证您的正常使用。 - -我们也提供了商业授权，如果您**需要将本产品进行二次开发、更改并进行任何附带商业化性质行为使用**，请联系我们进行商业授权，以遵守 `AGPL-3.0` 协议保证您的正常使用。 - -目前在国内 `GPL` 协议**具备合同特征，是一种民事法律行为** ，属于我国《合同法》调整的范围。 `TOPIAM` 项目团队保留诉讼权利。 - -[相关案例：违反 `GPL` 协议赔偿 50 万，国内首例！](https://mp.weixin.qq.com/s/YQ6sNjbDS-P7BViLZIsaoA) - -> **TopIAM 开源团队拥有对本开源协议的最终解释权。** +| 功能模块 | 功能项 | 功能描述 | +|:-----|:---------|:---------------------------| +| 账户管理 | 组织与用户 | 支持组织与用户维护。 | +| | 用户组管理 | 支持用户组维护。 | +| | 身份源管理 | 支持通过钉钉、飞书等途径同步用户和组织信息到系统。 | +| 认证管理 | 认证提供商 | 支持配置多种认证源，用户可通过不同方式登录门户。 | +| 应用管理 | OIDC协议应用 | 支持通过OIDC协议进行应用SSO。 | +| | 表单代填应用 | 支持表单代填方式进行应用SSO。 | +| | JWT协议应用 | 支持JWT协议进行应用SSO。 | +| 行为审计 | 用户行为 | 记录企业用户相关操作行为记录。 | +| | 管理员行为 | 记录管理员相关操作记录。 | +| 安全设置 | 通用安全 | 支持通用安全配置，及安全防御策略。 | +| | 密码策略 | 支持配置用户密码全局规则策略。 | +| | 系统管理员 | 负责维护系统用户配置等。 | +| 系统设置 | 消息设置 | 支持配置维护邮件模版、邮件服务、短信服务。 | +| | IP地理库 | 支持配置IP地理库，实现精准IP定位。 | +| | 存储配置 | 支持配置云存储服务，如阿里云、腾讯云、MinIO等。 | +| 系统监控 | 会话管理 | 支持查看系统登录会话，支持回话下线。 | ## 在线演示 -- 管理端：https://eiam-console.topiam.cn ++ 管理端：https://eiam-console.topiam.cn > 体验账号：admin/topiam.cn -- 用户端：https://eiam-portal.topiam.cn ++ 用户端：https://eiam-portal.topiam.cn > 体验账号：portal/topiam.cn ## 技术架构 @@ -135,103 +87,11 @@ ## 安装部署 -- [本地部署](https://eiam.topiam.cn/docs/deployment/deployment-local/) -- [Docker部署](https://eiam.topiam.cn/docs/deployment/deployment-local/) -- [K8S部署](https://eiam.topiam.cn/docs/deployment/deployment-k8s/) -- [更多方式](https://eiam.topiam.cn/docs/deployment/) - -## 用户登记 - -如果您和您的公司或组织使用了 TopIAM 企业身份管控平台 ，非常感谢您的支持与信任，请在此进行登记，您的回复将成为维护者、社区用户和观望者的信心来源。感谢支持 💖 - -**我们会优先支持登记用户的需求及问题反馈。** - -> 登记信息仅用于推广本产品～ - -[点击进行接入登记](https://gitee.com/topiam/eiam/issues/I7SAJK) - -- 浙江智慧江能技术服务股份有限公司 -- 广东省印象华云数据有限公司 -- 宁波甬承电子科技有限公司 -- 山东爱特云翔信息技术有限公司 -- 北京中科生活服务有限公司 -- 四维世景北京(科技)有限公司 - -## 微信公众号 - -欢迎关注 TopIAM 微信公众号，接收产品最新动态。 - -![](https://user-images.githubusercontent.com/30397655/206887629-faf77f3e-1681-4918-99bf-773ef434f088.png) - -## 交流群 - -![](https://eiam.topiam.cn/img/group-qr-code.jpg) - -## 参与贡献 - -我们强烈欢迎有兴趣的开发者参与到项目建设中来，同时欢迎大家对项目提出宝贵意见建议和功能需求，项目正在积极开发，欢迎 PR 👏。 - -强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545) -和 [《如何有效地报告 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) - -## FOSSA Status - -[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftopiam%2Feiam.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftopiam%2Feiam?ref=badge_large) - -## License - -目产品化程度；另一方面希望在社区中吸收更多的实践场景进而继续完善产品，也欢迎大家参与到项目中来。 - -为保证社区繁荣和项目自由健康发展，在开源许可证方面，`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 开源团队拥有对本开源协议的最终解释权。** - -## 在线演示 - -- 管理端：https://eiam-console.topiam.cn - > 体验账号：admin/topiam.cn -- 用户端：https://eiam-portal.topiam.cn - > 体验账号：portal/topiam.cn - -## 技术架构 - -- **后端**：[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/) - -## 安装部署 ++ [本地部署](https://eiam.topiam.cn/docs/deployment/deployment-local/) ++ [Docker部署](https://eiam.topiam.cn/docs/deployment/deployment-local/) ++ [K8S部署](https://eiam.topiam.cn/docs/deployment/deployment-k8s/) ++ [更多方式](https://eiam.topiam.cn/docs/deployment/) -- [本地部署](https://eiam.topiam.cn/docs/deployment/deployment-local/) -- [Docker部署](https://eiam.topiam.cn/docs/deployment/deployment-local/) -- [K8S部署](https://eiam.topiam.cn/docs/deployment/deployment-k8s/) -- [更多方式](https://eiam.topiam.cn/docs/deployment/) ## 用户登记 @@ -239,16 +99,16 @@ **我们会优先支持登记用户的需求及问题反馈。** -> 登记信息仅用于推广本产品～ +>登记信息仅用于推广本产品～ [点击进行接入登记](https://gitee.com/topiam/eiam/issues/I7SAJK) -- 浙江智慧江能技术服务股份有限公司 -- 广东省印象华云数据有限公司 -- 宁波甬承电子科技有限公司 -- 山东爱特云翔信息技术有限公司 -- 北京中科生活服务有限公司 -- 四维世景北京(科技)有限公司 ++ 浙江智慧江能技术服务股份有限公司 ++ 广东省印象华云数据有限公司 ++ 宁波甬承电子科技有限公司 ++ 山东爱特云翔信息技术有限公司 ++ 北京中科生活服务有限公司 ++ 四维世景北京(科技)有限公司 ## 微信公众号