update: unicloud-private-env.md

docs/unicloud-private-env.md

@@ -78,15 +78,15 @@ uniCloud软件版，作为一个开发框架，仅负责云函数、云对象的
 
 uniCloud软件版分为标准版、企业版两个规格，具体如下：
 
-|				|标准版											|企业版												|
-|--				|--												|--													|
-|**联网激活**		|需要											|不需要<br/>可实现完全内网托管							|
-|**源码报备？？**	|不支持											|支持												|
-|**技术支持**		|1. 官方社区/社群问答 <br/> 2. uniCloud控制台报障	|1. 专有uni-im技术支持群 <br/> 2. 工作时间30分钟内必响应	|
-|**软件授权**		|2万/套											|9.8万/套											|
-|**服务器授权**	|1万/台											|4.9万/台											|
-|**应用授权**		|1000元/个										|1000元/个	|
-|**购买方式**		|[uniCloud控制台](https://unicloud.dcloud.net.cn)在线付款，自助下单|联系bd@dcloud.io沟通合同	|
+|    |标准版           |企业版            |
+|--    |--            |--             |
+|**联网激活**  |需要           |不需要<br/>可实现完全内网托管       |
+|**源码报备？？** |不支持           |支持            |
+|**技术支持**  |1. 官方社区/社群问答 <br/> 2. uniCloud控制台报障 |1. 专有uni-im技术支持群 <br/> 2. 工作时间30分钟内必响应 |
+|**软件授权**  |2万/套           |9.8万/套           |
+|**服务器授权** |1万/台           |4.9万/台           |
+|**应用授权**  |1000元/个          |1000元/个 |
+|**购买方式**  |[uniCloud控制台](https://unicloud.dcloud.net.cn)在线付款，自助下单|联系<bd@dcloud.io>沟通合同 |
 
 说明：每套软件授权，默认含有一个服务器授权、2个应用授权。
 
@@ -103,6 +103,7 @@ uniCloud软件版分为标准版、企业版两个规格，具体如下：
 **操作系统要求**
 
 关键要求：
+
 - 内核版本 >= 4.18
 - glibc >= 2.28
 - gcc >= 8.5
@@ -178,20 +179,16 @@ tar -zxvf [version].tar.gz -C ~/uniCloud
 
 ![](https://web-ext-storage.dcloud.net.cn/unicloud/docs202406031939942.png)
 
-复制服务空间ID，回到你的服务器上，在uniCloud软件版根目录下创建对应的服务空间目录：
+复制服务空间ID，回到你的服务器上，在uniCloud软件版根目录下使用以下命令创建对应的服务空间目录：
 
 ```
 cd ~/uniCloud/
-// 如果spaces目录不存在先创建
-mkdir spaces
-cd spaces
-mkdir [SpaceId]
+./unicloud init-space [服务空间ID]
 ```
 
-// TODO 此处补充初始化命令
-
-你需要根据自己的具体情况，配置mongodb数据库、文件存储、redis等，config.json的完整配置及解释，详见[]()
+./unicloud init-space 命令详细参数[参考](#commands)
 
+你需要根据自己的具体情况，配置mongodb数据库、文件存储、redis等，config.json的完整配置及解释，[详见](#config)
 
 ### 启动服务
 
@@ -205,6 +202,7 @@ cd ~/uniCloud
 接下来，就是开发自己的代码，上传到当前服务器即可。
 
 ### 部署程序包
+
 ### 获取并激活授权
 
 #### 软件授权
@@ -235,8 +233,8 @@ uniCloud软件版运行之前，需要向DCloud注册您的uniCloud软件版，
 
 将下载的授权文件上传uniCloud软件版安装根目录下，并重命名为`LICENSE`，即可完成注册。
 
-
 #### 服务器授权
+
 #### 应用授权
 
 应用授权即授权哪些uni-app客户端可以访问uniCloud软件版，应用授权需要单独购买，
@@ -260,47 +258,78 @@ uniCloud软件版运行之前，需要向DCloud注册您的uniCloud软件版，
 
 ### 运维管理
 
-#### uniCloud软件版操作命令
+#### uniCloud软件版操作命令@commands
 
 > 所有命令，需在uniCloud软件安装根目录下执行
 
 注册uniCloud软件版
 
-```javascript
-./unicloud register // 注册
-./unicloud register --trial // 注册试用
-```
+`./unicloud register`
+
+|参数|类型|默认值|说明|
+|---|---|---|---|
+|`-t, --trial`|Boolean|false|是否注册试用授权|
 
 启动
 
-`./unicloud start -s [服务空间ID]`
+`./unicloud start`
+
+|参数|类型|默认值|说明|
+|---|---|---|---|
+|`-s, --spaceId`|String|-|服务空间ID，为空默认服务空间|
+|`-w, --worker`|Number|服务器 CPU 核数|启动worker数量|
 
 停止
 
-`./unicloud stop -s [服务空间ID]`
+`./unicloud stop`
+
+|参数|类型|默认值|说明|
+|---|---|---|---|
+|`-s, --spaceId`|String|-|服务空间ID，为空默认服务空间|
 
 安装云函数第三方依赖
 
-`./unicloud install -s [服务空间ID]`
+`./unicloud install-deps`
+
+|参数|类型|默认值|说明|
+|---|---|---|---|
+|`-s, --spaceId`|String|-|服务空间ID，为空默认服务空间|
+
+初始化服务空间
+
+`./unicloud init-space`
+
+|参数|类型|默认值|说明|
+|---|---|---|---|
+|`-s, --spaceId`|String|-|服务空间ID，为空默认服务空间|
+|`--storage`|String|local|存储服务类型，目前支持 local、qiniu、aliyun、tencent|
+|`--mongodb`|Boolean|false|创建 MongoDB 配置|
+|`--redis`|Boolean|false|创建 Redis 配置|
 
 初始化数据库
 
-`./unicloud init-database -s [服务空间ID]`
+`./unicloud init-database`
+
+|参数|类型|默认值|说明|
+|---|---|---|---|
+|`-s, --spaceId`|String|-|服务空间ID，为空默认服务空间|
 
 扫描服务器、服务空间、注册状态等信息
 
 `./unicloud scan`
 
+查看 uniCloud 各服务空间运行状态
+
+`./unicloud status`
 
 #### 出网域名白名单
 
 uniCloud软件版的部分业务需要从你的服务器向外网发送请求，需联网的业务包括：
 
-
-|功能	|联网域名	|
-|--	|--	|
-|1. uniCloud软件版联网激活<br/>2. 短信 <br/> 3. 一键登录 <br/> 4. uni-ai <br/> 5. 实人认证 <br/> 	|1. pucoa1.dcloud.net.cn <br/> 2. pucoa2.dcloud.net.cn <br/> 3. pucoabk.dcloud.net.cn	|
-|6. uni-push	|restapi.getui.com	|
+|功能 |联网域名 |
+|-- |-- |
+|1. uniCloud软件版联网激活<br/>2. 短信 <br/> 3. 一键登录 <br/> 4. uni-ai <br/> 5. 实人认证 <br/>  |1. pucoa1.dcloud.net.cn <br/> 2. pucoa2.dcloud.net.cn <br/> 3. pucoabk.dcloud.net.cn |
+|6. uni-push |restapi.getui.com |
 
 若你的服务器开启了防火墙，或限制公网访问，同时又使用了如上业务，则你需要将如上对应域名加入防火墙白名单。
 
@@ -314,9 +343,9 @@ uniCloud软件版内置简单的日志服务，日志分为启动日志与运行
 
 **日志路径**
 
-启动日志放在`${HOMEDIR}/logs/${spaceId}/master`路径下，每次启动的日志独立保存。
+启动日志放在`~/uniCloud/logs/${spaceId}/master`路径下，每次启动的日志独立保存。
 
-运行时日志默认放在`${HOMEDIR}/logs/${spaceId}`路径下，可以修改服务空间配置文件中的`logger.customLogDir`字段来自定义日志目录。
+运行时日志默认放在`~/uniCloud/logs/${spaceId}`路径下，可以修改服务空间配置文件中的`logger.customLogDir`字段来自定义日志目录。
 
 如果想自定义日志路径，可参考如下配置：
 
@@ -337,11 +366,8 @@ uniCloud软件版内置简单的日志服务，日志分为启动日志与运行
 
 运行日志
 
-- `logs/client/cloudfunctions.log` 云函数运行日志。
-- `${spaceId}-web.log` uniCloud 框架运行相关日志。
-- `egg-web.log` uniCloud 基于 Eggjs 框架开发，Eggjs 框架内核、插件日志。
-- `egg-agent.log` Eggjs 多进程模型 agent 进程日志。
-- `common-error.log` uniCloud 中任何错误信息都会写入此文件内。
+- `unicloud.log` 框架及云函数运行日志。
+- `unicloud-error.log` uniCloud 中任何错误信息都会写入此文件内。
 
 **日志切割**
 
@@ -401,19 +427,25 @@ uniCloud软件版服务空间使用 `dcloud` 标识
 }
 ```
 
-你需要根据自己的具体情况，配置mongodb数据库、文件存储、redis等，config.json的完整配置及解释，详见[]()
+你需要根据自己的具体情况，配置mongodb数据库、文件存储、redis等，config.json的完整配置及解释，[详见](#config)
 
 // TODO 补充如上链接。
 
 ### 远程调试
 
-HX中点击远程云函数即可，但远程地址如何配置？
+在本地运行时如果需要连接云端云函数，需要在uniCloud空间中配置云端apiEndpoint后切换云端云函数访问。
+
+![](https://web-ext-storage.dcloud.net.cn/unicloud/docs202407091657999.png)
+
+**注意**
+
+修改 apiEndpoint 后需要重新关联服务空间生效。
 
 ### 构建服务端发行包
 
 由于有uni_modules插件内包含uniCloud云函数等，需要进行uniCloud打包操作，将uni_modules插件内的云函数及数据库schema抽离出来。
 
-在 `uniCloud-dcloud`目录右键“uniCloud软件版”-“打包uniCloud资源”，将会在`uniCloud-dcloud`服务空间目录下生成`dist`目录。
+在 `uniCloud`目录右键“uniCloud软件版”-“打包uniCloud资源”，将会在`uniCloud`服务空间目录下生成`dist`目录。
 
 可以使用git/svn等版本管理工具进行管理，将代码上传至git/svn，在服务器拉取代码后将`uniCloud-dcloud/dist`目录同步到对应服务空间下即可。
 
@@ -421,14 +453,13 @@ HX中点击远程云函数即可，但远程地址如何配置？
 
 上传代码之后需要重新启动服务空间，在uniCloud软件版根目录执行以下命令进行重启操作
 
-```
-./unicloud stop -s [服务空间ID]
-./unicloud start -s [服务空间ID]
+```javascript
+./unicloud stop & ./unicloud start
 ```
 
 建议部署时采用分布式部署方案，即使用2台以上服务器部署可以保证服务的稳定性，在服务重启时也不会中断服务。
 
-## 配置文件
+## 配置文件@config
 
 uniCloud软件版需要单独配置mongodb数据库、文件存储、redis等，所有配置全部在`config.json`中完成。
 
@@ -473,14 +504,13 @@ HBuilderX端开发配置、服务器端线上配置，都通过 config.json实
 }
 ```
 
-
 |参数|类型|默认值|说明|
 |---|---|---|---|
-|default|Boolean|-|是否为默认服务空间，一套uniCloud软件版环境下，只能有一个默认服务空间|
+|default|Boolean|false|仅服务器支持；是否为默认服务空间，一套uniCloud软件版环境下，只能有一个默认服务空间|
 |spaceId|String|-|服务空间ID，可在uniCloud控制台查看|
-|startAsDaemon|Boolean|true|是否在后台运行|
+|startAsDaemon|Boolean|true|仅服务器支持；是否在后台运行|
 |port|Number|7001|端口号，同一台服务器下，各服务空间的端口号不可重复|
-|clientSecret|String|-|客户端通讯密钥|
+|clientSecret|String|-|仅服务器支持；客户端通讯密钥|
 |mongodb|Object|-|mongo数据库连接配置|
 |mongodb.url|String|-|mongo数据库连接|
 |mongodb.database|String|-|数据库名称|
@@ -494,6 +524,10 @@ HBuilderX端开发配置、服务器端线上配置，都通过 config.json实
 |storage.cdnDomain|String|
 |storage.cdnRootPath|String|/storage/file/|cdn根目录|
 |storage.storageSecret|String|-|本地存储服务访问密钥|
+|storage.bucketName|String|-|仅qiniu支持；存储桶名称|
+|storage.domain|String|-|仅qiniu支持；qiniu储存域名（域名地址）|
+|storage.ak|String|-|仅qiniu支持；bucket ak|
+|storage.sk|String|-|仅qiniu支持；bucket sk|
 |logger|Object|-|日志服务配置|
 |logger.customLogDir|String|/private-cloud-env/logs|uniCloud软件版环境日志存储路径|
 |redis|Object|-|redis配置; 如不需要可不配置此字段|