update: unicloud-private-env.md

docs/unicloud-private-env.md

@@ -49,11 +49,11 @@ uni云开发软件版，作为一个开发框架，仅负责云函数、云对
 
 **系统最低配置**
 
-CPU >= 4核
+CPU >= 1核
 
-内存 >= 4G
+内存 >= 2G
 
-硬盘 >= 40G
+硬盘 >= 20G
 
 **操作系统要求**
 
@@ -137,7 +137,7 @@ tar -zxvf [version].tar.gz -C /uniCloud
 
 ### 注册 uni云开发软件版
 
-uni云开发软件版安装完成后，需要像DCloud注册您的uni云开发软件版，注册成功后才可以正常运行。
+uni云开发软件版运行之前，需要向DCloud注册您的uni云开发软件版，注册成功后才可以正常运行。
 
 每个账号每年(自然年)可以有5次注册试用版机会，单次试用时长为14天。
 
@@ -190,7 +190,7 @@ uni云开发软件版安装完成后，需要像DCloud注册您的uni云开发
 
 注册uni云开发软件版
 
-```
+```javascript
 ./unicloud register // 注册
 ./unicloud register --trial // 注册试用
 ```
@@ -238,57 +238,92 @@ mkdir [SpaceId]
 在你的服务空间目录下创建`config.json`配置文件，文件内容如下：
 
 ```json
-//下方为配置示例，如拷贝此内容切记去除注释
 {
-  "default": true, //是否为默认服务空间，一套uni云开发软件版环境下，只能有一个默认服务空间
-  "spaceId": "pvt-xxx",//DCloud服务空间编号，可在uniCloud控制台查看
-  "startAsDaemon": true, // 是否在后台运行; 默认 true
-  "port": 7001, //端口号，可自定义，同一台服务器下，各服务空间的端口号不可重复
-  "clientSecret": "xxx",//客户端通讯密钥
-  "mongodb": { //mongo数据库连接配置
-    "url": "mongodb://username:password@127.0.0.1:7001",//mongo数据库连接
-    "database": "test", //数据库名称
-    "maxPoolSize": 30, //最大连接数
-    "minPoolSize": 10 //最小连接数
+  "default": true,
+  "spaceId": "pvt-xxx",
+  "startAsDaemon": true,
+  "port": 7001,
+  "clientSecret": "xxx",
+  "mongodb": {
+    "url": "mongodb://username:password@127.0.0.1:7001",
+    "database": "test",
+    "maxPoolSize": 30,
+    "minPoolSize": 10
   },
-  "storage": {//存储服务配置，如项目未使用存储服务可不配置此项
-    "provider": "local",//服务商 支持local:本地存储 aliyun: 阿里云存储服务 tencent:腾讯云存储服务 qiniu:七牛云
-    "dir": "file/upload", //文件上传目录
- "bucket": "",//存储桶名称，本地存储无需配置此项
-    "cdnProtocol": "http://",//cdn协议 支持 http https
-    "cdnDomain": "127.0.0.1:7001",//cdn域名
-    "cdnRootPath": "/storage/file/",//cdn根目录
-    "storageSecret": "xxxxxxxxxx",//本地存储服务访问密钥
+  "storage": {
+    "provider": "local",
+    "dir": "file/upload",
+    "bucket": "",
+    "cdnProtocol": "http://",
+    "cdnDomain": "127.0.0.1:7001",
+    "cdnRootPath": "/storage/file/",
+    "storageSecret": "xxxxxxxxxx",
   },
-  "logger": { //日志服务配置
-    "customLogDir": "/private-cloud-env/logs" //uni云开发软件版环境日志存储路径
+  "logger": {
+    "customLogDir": "~/logs"
   },
-  "redis": {//redis库配置，如项目未使用redis服务可不配置此项
-    "host": "127.0.0.1",//redis连接
-    "port": 6379,//端口号
-    "password": ""//密码
+  "redis": {
+    "host": "127.0.0.1",
+    "port": 6379,
+    "password": ""
   },
-  "spaceSecret": { //服务空间通讯配置
- "secretKeyId": "xxxx", //SpaceKeyID，可在uniCloud控制台查看
- "secretKey": "xxx" //SpaceSecret ，可在uniCloud控制台查看
+  "spaceSecret": {
+    "secretKeyId": "xxxx",
+    "secretKey": "xxx"
   }
 }
 ```
 
+|参数|类型|默认值|说明|
+|---|---|---|---|
+|default|Boolean|-|是否为默认服务空间，一套uni云开发软件版环境下，只能有一个默认服务空间|
+|spaceId|String|-|服务空间ID，可在uniCloud控制台查看|
+|startAsDaemon|Boolean|true|是否在后台运行|
+|port|Number|7001|端口号，同一台服务器下，各服务空间的端口号不可重复|
+|clientSecret|String|-|客户端通讯密钥|
+|mongodb|Object|-|mongo数据库连接配置|
+|mongodb.url|String|-|mongo数据库连接|
+|mongodb.database|String|-|数据库名称|
+|mongodb.maxPoolSize|Number|30|最大连接数|
+|mongodb.minPoolSize|Number|10|最小连接数|
+|storage|Object|-|存储服务配置|
+|storage.provider|String|local|服务商 支持local:本地存储 aliyun: 阿里云存储服务 tencent:腾讯云存储服务 qiniu:七牛云|
+|storage.dir|String|file/upload|文件上传目录|
+|storage.bucket|String|-|存储桶名称，本地存储无需配置此项|
+|storage.cdnProtocol|String|http|cdn协议 支持 http https|
+|storage.cdnDomain|String|
+|storage.cdnRootPath|String|/storage/file/|cdn根目录|
+|storage.storageSecret|String|-|本地存储服务访问密钥|
+|logger|Object|-|日志服务配置|
+|logger.customLogDir|String|/private-cloud-env/logs|uni云开发软件版环境日志存储路径|
+|redis|Object|-|redis配置; 如不需要可不配置此字段|
+|redis.host|String|-|redis连接host|
+|redis.port|Number|6379|端口号|
+|redis.password|String|-|密码|
+|spaceSecret|Object|-|服务空间通讯配置|
+|spaceSecret.secretKeyId|String|-|SpaceKeyID，可在uniCloud控制台查看|
+|spaceSecret.secretKey|String|-|SpaceSecret ，可在uniCloud控制台查看|
+
 如项目中使用了存储服务，则还需额外增加存储服务的配置项。既在服务空间目录下创建`file`目录，并在`file`目录下增加`permission.json`配置文件。配置文件内容如下：
 
 ```json
-//下方为配置示例，如拷贝此内容切记去除注释
 {
   "*": {
-    "read": true, //读权限
-    "update": false,//修改权限
-    "create": true,//创建权限
-    "delete": "auth.uid == resource.uid"//删除权限
+    "read": true,
+    "update": false,
+    "create": true,
+    "delete": "auth.uid == resource.uid"
   }
 }
 ```
 
+|参数|类型|默认值|说明|
+|---|---|---|---|
+|read|Boolean|-|读权限|
+|update|Boolean|-|修改权限|
+|create|Boolean|-|创建权限|
+|delete|String|-|删除权限|
+
 ### 使用HBuilerX开发调试
 
 #### 安装uni云开发软件版插件
@@ -309,16 +344,15 @@ uni云开发软件版服务空间使用 `dcloud` 标识
 
 如果项目内不存在`dcloud`服务空间，请在项目根目录右键-创建uniCloud环境，选择 `DCloud`创建即可。
 
-`dcloud`服务空间文件夹全名为`uniCloud-dcloud`
+#### 本地调试配置
 
-在 `uniCloud-dcloud` 目录右键即可关联`dcloud`服务空间。
+在项目中的`uniCloud`目录右键-uni云开发软件版-创建本地调试配置文件，即可生成`config.json`配置文件。
 
-#### 配置数据库链接
+![](https://web-ext-storage.dcloud.net.cn/unicloud/docs202406261208673.png)
 
-在项目中的`uniCloud目录`下新建`config.json`文件，并按需添加配置项。
+配置内容如下所示
 
 ```json
-//下方为配置示例，如拷贝此内容切记去除注释
 {
  "mongodb": { //mongo库连接配置
    "url": "mongodb://username:password@127.0.0.1:7001",//mongo库连接地址
@@ -328,27 +362,16 @@ uni云开发软件版服务空间使用 `dcloud` 标识
    "host": "127.0.0.1",//host
    "port": 6379, //端口号
    "password": "password"//密码
- }
-}
-```
-
-#### 配置文件存储
-
-本地调试支持本地存储、OSS、COS、七牛云存储，
-参考以下示例配置存储调试。
-
-```json
-//下方为配置示例，如拷贝此内容切记去除注释
-{
+ },
  "storage": {//存储服务配置，如项目未使用存储服务可不配置此项
     "provider": "local",//服务商 支持local:本地存储 aliyun: 阿里云存储服务 tencent:腾讯云存储服务 qiniu:七牛云
     "dir": "file/upload", //文件上传目录
- "bucket": "",//存储桶名称，本地存储无需配置此项
+    "bucket": "",//存储桶名称，本地存储无需配置此项
     "cdnProtocol": "http://",//cdn协议 支持 http https
     "cdnDomain": "127.0.0.1:7001",//cdn域名
     "cdnRootPath": "/storage/file/",//cdn根目录
     "storageSecret": "xxxxxxxxxx",//本地存储服务访问密钥
-  },
+  }
 }
 ```
 
@@ -364,7 +387,7 @@ uni云开发软件版服务空间使用 `dcloud` 标识
 
 在 `uniCloud-dcloud`目录右键“uni云开发软件版”-“打包uniCloud资源”，将会在`uniCloud-dcloud`服务空间目录下生成`dist`目录。
 
-可以使用git/svn等版本管理工具进行管理，将代码上传至git/svn，在服务器拉取代码，在服务器上将`uniCloud-dcloud/dist`同步到对应服务空间目录下即可。
+可以使用git/svn等版本管理工具进行管理，将代码上传至git/svn，在服务器拉取代码后将`uniCloud-dcloud/dist`目录同步到对应服务空间下即可。
 
 也可以单独对`dist`目录打包zip并上传到服务器对应的服务空间目录下解压即可。