From a9fabb08f5e1bd1f79103f05836fc16cf923764f Mon Sep 17 00:00:00 2001
From: chenruilong <chen1195849487@hotmail.com>
Date: Tue, 5 Mar 2024 20:01:53 +0800
Subject: [PATCH] update unicloud-private-env.md

---
 docs/unicloud-private-env.md | 77 +++++++++++++++++++++++++++++-------
 1 file changed, 63 insertions(+), 14 deletions(-)

diff --git a/docs/unicloud-private-env.md b/docs/unicloud-private-env.md
index f5c0d90..d53fcb1 100644
--- a/docs/unicloud-private-env.md
+++ b/docs/unicloud-private-env.md
@@ -13,29 +13,77 @@ uniCloud 私有化环境基于 Linux 物理机来构建的，在部署时需要
 
 ### 环境包下载
 
-下载私有云环境包(zip文件)后，上传至服务器，并解压到指定的目录。
+请先联系`DCloud`工作人员申请私有云环境，待工作人员创建完私有云环境后。
 
-环境包可联系`DCloud`工作人员获取。
+您可在 uniCloud 控制台切换到“私有云环境”页面，查看您的私有云环境。
 
-### 生成 license
+![](https://web-ext-storage.dcloud.net.cn/unicloud/docs202403051519770.png)
 
-下载获取硬件ID工具到服务器
+按图示下载私有云环境包(.tar.gz文件)后，上传至服务器并解压至合适的目录下。
 
-`https://web-ext-storage.dcloud.net.cn/unicloud/private/tools/get-hardware-id`
+```
+mkdir unicloud-private
+tar -zxvf [version].tar.gz -C unicloud-private
+```
+
+![](https://web-ext-storage.dcloud.net.cn/unicloud/docs202403051530127.png)
+
+### 获取环境Key (必须)
+
+> 环境 Key 是 uniCloud 私有化环境运行的必要文件
+>
+> 请确保环境 Key 与 环境一一对应，请勿复制错误
+
+在 uniCloud 控制台找到对应环境，点击“复制环境Key，在私有化服务根目录下新建文件，
+将复制的环境 Key 保存为 “key.txt”。
+
+![](https://web-ext-storage.dcloud.net.cn/unicloud/docs202403051539516.png)
+
+**注意**
+
+保存时请勿在文件末尾添加\n换行符，如果自动添加可执行以下命令移除换行符
+```
+vim key.txt
+
+:set bin noeol
+:wq
+```
+末尾存在\n换行符时，可能导致 uniCloud 私有云服务无法运行
+
+### 获取 license (必须)
+
+> license 授权将与服务器进行绑定，一台服务器仅可以绑定一个 license 授权
+>
+> 如您有分布式部署需求请联系`DCloud`工作人员
+
+1. 下载获取硬件ID工具到服务器
+
+`wget https://web-ext-storage.dcloud.net.cn/unicloud/private/tools/get-hardware-id`
 
 执行`./get-hardware-id`, 获取到硬件ID
 
-将获取到的硬件ID发送给 DCloud 生成 license 文件
+将获取到的硬件ID发送给 `DCloud` 生成 license 文件
+
+待 license 生成后，可在 uniCloud 控制台，点击“查看服务器凭证”查看。
+
+![](https://web-ext-storage.dcloud.net.cn/unicloud/docs202403051554539.png)
 
-将生成后的 license.txt 文件放置私有云环境根目录下即可
+复制凭证后，在私有化服务根目录下新建文件，将复制的凭证保存为 license.txt”。
 
-### 环境包下载和解压
+**注意**
 
-下载私有云环境包后，上传至服务器，并解压到指定的目录。环境包可联系`DCloud`工作人员获取。
+保存时请勿在文件末尾添加\n换行符，如果自动添加可执行以下命令移除换行符
+```
+vim license.txt
+
+:set bin noeol
+:wq
+```
+末尾存在\n换行符时，可能导致 uniCloud 私有云服务无法运行
 
-### 私有化环境启动/停止
+### 4. 私有化环境启动/停止
 
-> 在私有云环境根目录运行以下命令
+> 所有命令请在私有云环境根目录运行
 
 启动
 
@@ -45,12 +93,12 @@ uniCloud 私有化环境基于 Linux 物理机来构建的，在部署时需要
 
 `./unicloud stop -s [服务空间ID]`
 
-
 ### 创建及配置服务空间
 
 #### 创建服务空间目录
 
-在`私有云环境根目录/spaces`目录下创建目录，并将目录命名为SpaceId。spaceId可在[uniCloud控制台](https://unicloud.dcloud.net.cn/)查看。
+在`私有云环境根目录/spaces`目录下创建目录，并将目录命名为SpaceId。
+spaceId可在[uniCloud控制台](https://unicloud.dcloud.net.cn/)查看。
 
 #### 上传云函数及数据库schema文件
 
@@ -60,11 +108,12 @@ uniCloud 私有化环境基于 Linux 物理机来构建的，在部署时需要
 
 在服务空间目录下新增`config.json`配置文件。配置文件内容如下：
 
-```json
+```js
 //下方为配置示例，如拷贝此内容切记去除注释
 {
   "default": true, //是否为默认服务空间，一套私有云环境下，只能有一个默认服务空间
   "spaceId": "pvt-xxx",//私有云服务空间编号，可在uniCloud控制台查看
+  "startAsDaemon": true, // 是否在后台运行; 默认 true
   "port": 7001, //端口号，可自定义，同一台服务器下，各服务空间的端口号不可重复
   "clientSecret": "ba461799-fde8-429f-8cc4-4b6d306e2339",//客户端通讯密钥
   "mongodb": { //mongo数据库连接配置
-- 
GitLab