维护手册.md · wxdx110/myinfo_server

# 一、项目结构
```
../myinfo_server
├── cluster.js *启动多线程*
├── config  *对外配置文件*   
│   └── default.json *myinfo、mongodb配置*
├── data *项目所需配置*
│   ├── clients.json *客户端配置*
│   └── template.json *myinfo person配置*
├── dist *生成的打包文件*
│   └── bundle.js
├── docker-compose.yml
├── Dockerfile
├── LICENSE
├── logs *日志文件*
│   ├── out.log
│   └── out.log.2018-09-24
├── myinfo_server.pdf
├── node_modules *项目依赖包*
├── npm-debug.log
├── package.json *项目初始化配置*
├── pm2.json 
├── README.md *项目说明文档*
├── service.js 
├── src *源码*
│   ├── api.js
│   ├── app.js
│   ├── data.js
│   ├── emitter.js
│   ├── logger.js
│   ├── model.js
│   ├── security.js
│   └── test.js
├── ssl *证书文件*
│   ├── stg-auth-signing-public.pem
│   └── stg-myinfo-2018.pem
├── start.sh *项目启动脚本*
├── stop.sh  *项目关闭脚本*
├── webpack.config.js *项目打包配置*
├── 安装手册.md
└── 维护手册.md
```
# 二、详细说明
- 本系统采用nodeJs 编写,数据存储采用mongodb，项目运行环境依赖nodeJs及mongodb（*安装步骤详见install.js*）
## 1、config目录
### 1)、default.json 文件说明

- oauth  *oauth 2.0相关配置*

| 配置项 | 配置项说明 | 当前配置 |  
| ------- | ------ | ----- |
|tokenSecret|对用户授权加密 |tokenSecret|
|stateSecret|对clientId、templateId、state进行加密的密钥 |stateSecret|
|expire|授权有效时间（秒）|300|

- mongodb *mongodb配置*

| 配置项 | 配置项说明 | 当前配置 |  
| ------- | ------ | ----- |
|url|链接地址|mongodb://localhost:27017|
|db|数据库名|myinfo|

- 其他配置

| 配置项 | 配置项说明 | 当前配置 |  
| ------- | ------ | ----- |
|logLevel|日志级别|info|
|content|上下文根|""|
|proxy|网络代理|""|
|timeout|超时时间|30|

## 2、data目录
### 1）、clients.json

| 配置项 | 配置项说明 | 当前配置 |  
| ------- | ------ | ----- |
|clientId|客户端Id| application2|
|clientSecret|客户端数据加密密钥|secret2|
|redirectUrl|客户端回调地址|http://localhost:3000/callback|
|purpose|说明请求数据的目的。这将在请求同意时向人员显示|demonstrating MyInfo APIs|

### 2)、 template.json

- creditcard:

- smartsaver:

| 配置项 | 配置项说明 | 当前配置 |  
| ------- | ------ | ----- |
| privateKey | 私钥证书（放置在项目ssl目录下，目录名称不需要更改只更改证书名称就可以） | ./ssl/stg-myinfo-2018.pem |
|publicKey|公钥证书（放置在项目ssl目录下，目录名称不需要更改只更改证书名称就可以）|./ssl/stg-auth-signing-public.pem|
|clientId|客户端ID(AppId)|STG2-MYINFO-SELF-TEST|
|clientSecret|客户端密钥|44d953c796cccebcec9bdc826852857ab412fbe2|
|redirectUrl|回调地址（将localhost:3001改称生产域名）|http://localhost:3001/callback|
|realmUrl|授权领域使用第一级别域名（https://cloud.bankofchina.com）|http://localhost:3001|
|authLevel|等级（无需更改生产只能使用L2等级）|L2|
|authApiUrl|访问myinfo auth Api的URL |https://myinfosgstg.api.gov.sg/dev/v1/authorise|
|tokenApiUrl|访问myinfo token Api的URL |https://myinfosgstg.api.gov.sg/dev/v1/token|
|personApiUrl|访问myinfo authpi的URL 无需更改|https://myinfosgstg.api.gov.sg/test/v2/person|
|attributes|要从myinfo获取person数据的数据项|name,sex,race,nationality,dob,email,mobileno,regadd,housingtype,hdbtype,marital,edulevel,assessableincome,hanyupinyinname,aliasname,hanyupinyinaliasname,marriedname,cpfcontributions,cpfbalances|
 
## 3、dist 目录
- bundle.js *打包后的项目文件*
## 4、logs
- 项目日志文件
## 5、node_modules
-  项目依赖包
## 6、src
- 项目源码
## 7、ssl
- myinfo通讯公私钥证书文件
## 8、cluster.js 
- 启用多线程
## 9、start.sh
- 项目启动脚本
## 10、stop.sh
- 项目停止脚本
# 二、系统检查及维护  
## <a id = "server_start_stop" >1、查看myinfo_server运行状况 </a>
### 1)、系统的启动与停止
- 跳转到myinfo_server项目根目录
- 启动服务  ./start.sh
- 停止服务  ./stop.sh
### 2)、查看系统状况  
- 使用命令 ps -ef | grep myinfo_server 检查项目运行状况    
- - 进程中存在 myinfo_server/cluster.js字样的进程表示服务正在运行。 
- - 如找不到该字样的进程则表示服务没有启动,需要<a href="#server_start_stop">启动服务</a>
- 查看系统日志 cd myinfo目录下的logs目录查看

## 2、查看mongdb运行状况
### 1)、<a id = "mongodb_start_stop" >数据库的启动与停止</a>
- cd /usr/local/mongodb/bin   
- 启动mongodb服务 执行  ./mongod &
- 停止mongodb服务 执行 ./mongod --shutdown   
### 2)、维护及状态查询
- 使用命令 ps -ef | grep mongod   查看mongodb运行状况&  
- - 进程中存在./mongod 字样的进程表示mongodb服务正在运行。
- - 如找不到该字样的进程则表示服务没有启动 需要去<a href="#mongodb_start_stop">启动服务</a>
- cd /usr/local/mongodb/bin    执行 ./mongo 进入数据库操作终端
- 在终端执行 show dbs 查看数据存储状况
- 在终端执行 exit 退出
## 3、查看nginx 运行状况
### 1）、<a id= "nginx_start_stop" >nginx 的启动与停止  </a>
- cd /usr/local/nginx
- 检查nginx配置文件是否正确
- - /usr/local/nginx/sbin/nginx -t -c /usr/local/nginx/conf/nginx.conf
- 启动nginx服务
- -  /usr/local/nginx/sbin/nginx -c /usr/local/nginx/conf/nginx.conf
- 停止nginx 服务
- - ps -ef|grep nginx 查看进程号,执行 kill -9 <进程号> 停止进程
- 重启nginx服务
- - /usr/local/nginx/sbin/nginx -s reload  
### 2)、 维护及状态查询
- 使用命令 ps -ef|grep nginx 查看nginx运行状况
- - 进程中存在 nginx 字样的进程表示nginx服务正在运行。
- - 如找不到该字样的进程则表示服务没有启动 需要去<a href="#nginx_start_stop">启动服务器</a>
## 4、常见问题
### 1)、页面出现404  
- 该问题可能受两方面因素影响  
- - 1、<a href="#server_start_stop">检查服务是否启动。</a>
- - 2、dmz区代理配置问题
    - 解决方案：检查dmz区ngix配置，配置文件为/usr/local/nginx/conf/nginx.conf
- - 3、项目上下文根配置错误
    -  解决方案： 通过配置 config/default.json中"content"选项来配置上下文根。

wxdx110/myinfo_server

简介

发行版

贡献者

近期动态

wxdx110/myinfo_server .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

wxdx110/myinfo_server