6 Star 38 Fork 30

EdgeGallery / user-mgmt

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

User Management 用户管理

License

用户管理模块为EdgeGallery平台提供了用户注册与登录、密码找回、帐号中心、用户列表管理、邮箱和手机验证等功能。

角色定义

用户管理模块定义了用户的角色与权限模型,包括:

  • 租户 系统内的普通用户,可以创建项目/上传App等操作,租户之间数据不能相互访问。

  • 管理员 系统管理员,可以对系统的应用数据进行管理和维护操作。

  • 访客 直接访问Portal时,默认是访客权限,只能浏览各平台的基本功能,不能做创建、编辑和删除等操作。

  • 超级管理员 系统内置一个默认用户:admin,作为平台的超级管理员。该用户可以管理其他用户,对平台已注册的所有用户进行统一管理,停用/启用用户,设置用户权限。

新注册的用户,默认是“租户”权限。“管理员”权限只能由超级管理admin在用户列表管理功能中,为租户提权获得。

主要特性

用户管理模块提供的主要特性可以点击查看:用户管理模块特性设计

本地运行User Management服务

User Management对外提供restful接口,基于开源ServiceComb微服务框架进行开发,并且集成了Spring Boot框架。能够在本地直接编译运行启动微服务,方便使用者进行本地调试。

  • 环境搭建与配置

    1.环境准备: 需要安装的工具及下载地址如下表所示。

    Name Version Link
    OpenJDK1.8 1.8.0 download
    MavApache Maven 3.6.3 download
    IntelliJ IDEA Community download
    Servicecomb Service-Center 1.3.2 download
    Postgres 10 or above download
    Redis 3.2.100 or above download

    2.源码下载: 使用 git clone 或者下载压缩包的形式将User Management源代码下载到本地,默认master分支。 首先需要下载依赖的父pom工程并编译:

    git clone https://gitee.com/edgegallery/eg-parent.git
    mvn install

    然后下载当前User Management工程:

    git clone https://gitee.com/edgegallery/user-mgmt.git

    3.ServiceCenter配置: User Management使用了开源的ServiceComb框架进行开发,服务在启动时会自动注册到指定的ServiceCenter,ServiceCenter会为服务提供注册与发现能力,供其他微服务进行调用。

    在启动User Management前需要先在本地启动ServiceCenter。

    • 首先下载ServiceCenter,如Windows系统可以选择Windows的[Binary]版本,下载完成后解压;

    • 双击运行start-service-center.bat和start-frontend.bat即可在本地启动ServiceCenter和可视化面板,浏览器访问 http://127.0.0.1:30103 进行查看,ServiceCenter默认启动端口为30100;

    • 本地运行User Management服务,需要增加如下环境变量以连接SC(Service Center,即服务中心):

      SC_ADDRESS:连接SC的地址。本地运行的SC默认为:http://127.0.0.1:30100

    4.PostgreSQL数据库配置: User Management使用了开源的PostgreSQL数据库存储用户的信息,本地运行时需要先安装PostgreSQL。

    • 推荐参考此处安装和启动PostgreSQL,建议选择9.6或以上版本;

    • 使用文件/src/main/resources/usermgmtdb.sql初始化数据库表结构;

    • 使用文件/src/main/resources/usermgmtdb-data.sql初始化默认用户信息;

    • 本地运行User Management服务,需要增加如下环境变量以连接数据库:

      POSTGRES_IP:连接数据库的IP。本地运行的数据库,一般使用环回IP即可:127.0.0.1
    
      POSTGRES_PORT:连接数据库的端口。可以不配置,采取默认端口5432
    
      POSTGRES_USERNAME:数据库用户名
    
      POSTGRES_PASSWORD:数据库密码

    5.Redis数据库配置: User Management使用了Redis数据库存储图形验证码、手机/邮箱验证码,本地运行时需要先安装Redis。

    • 推荐参考此处安装和启动Redis

    • 本地运行User Management服务,需要增加如下环境变量以连接Redis:

      REDIS_IP:连接Redis的IP。本地运行的Redis,一般使用环回IP即可:127.0.0.1
    
      REDIS_PORT:连接Redis的端口。可以不配置,采取默认端口6379
    
      REDIS_PASSWORD:连接Redis的密码。如果没有为Redis设置密码,可以不配置

    6.业务平台Client配置: User Management作为单点登录的Auth Server,各业务平台作为Auth Client。针对需要在本地运行的业务平台,User Management还需要增加对应该业务平台Client的配置信息。

    • 如果本地需要运行AppStore,User Management需要配置如下环境变量:
      OAUTH_APPSTORE_CLIENT_ID:AppStore业务平台的ClientID,配置为固定值appstore-fe。也可以不配置该变量,默认为appstore-fe
    
      OAUTH_APPSTORE_CLIENT_SECRET:AppStore业务平台的Client Secret,自行定义即可,但要注意AppStore业务平台运行时设置的Client Secret要与这里保持一致。
    
      OAUTH_APPSTORE_CLIENT_URL:连接AppStore业务平台的URL,如http://x.x.x.x:30091
    
      OAUTH_APPSTORE_CLIENT_ACCESS_URL:该配置是为代理访问模式定义的变量。正常访问模式下,与OAUTH_APPSTORE_CLIENT_URL保持一致即可
    • 类似的,如果本地要运行Developer、Mecm、ATP等平台,参考上述配置说明增加相应的环境变量配置。每个平台对应的环境变量名称请参考配置文件/src/main/resources/application.yaml中的oauth2.clients部分。
  • 拷贝前端资源

    当前工程为User Management的后台,需要拷贝前端资源到后台工程的资源目录下。

  • 本地运行

    运行/src/main/java/org/edgegallery/user/auth/MainServer.java文件中的main函数就能启动User Management。

    启动成功后,可以单独访问User Management的界面:

    http://x.x.x.x:8067/index.html

Kubernetes环境部署

您还可以把User Management服务制作成Docker镜像部署在Linux环境和Kubernetes集群中运行。

请参考helm_charts项目

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

user management back end 展开 收起
Java 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/edgegallery/user-mgmt.git
git@gitee.com:edgegallery/user-mgmt.git
edgegallery
user-mgmt
user-mgmt
master

搜索帮助