diff --git a/docs/unicloud-private-env.md b/docs/unicloud-private-env.md index 23208416d29a19bb95fbc443296ce1ddd658e293..b7da7fd308c92cda8740c655a62ff44c81999b7d 100644 --- a/docs/unicloud-private-env.md +++ b/docs/unicloud-private-env.md @@ -42,6 +42,36 @@ uniCloud软件版,作为一个开发框架,仅负责云函数、云对象的 2. uniCloud软件版内置的定制`node.js`版本为`16.20.2` ::: + +### 系统要求 + +**系统最低配置** + +CPU >= 4核 + +内存 >= 4G + +硬盘 >= 40G + +**操作系统要求** + +> 要求内核版本 >= 4.18, glibc >= 2.28 + +RHEL >= 8.1 或更高版本 + +Ubuntu >= 20.04 或更高版本 + +CentOS >= 8.5 或更高版本 (官方已停止维护,不推荐作为生成环境使用) + +**Linux 安装先决条件** + +- gcc >= 8.5 或更高版本 + +可以通过 Linux 包管理工具安装: + +- CentOS、RHEL: `sudo yum install gcc` +- Ubuntu: `sudo apt-get install gcc` + ### 获取安装软件 uniCloud软件版是付费软件,你需要先发邮件到`bd@dcloud.io`,通过商务采购后才能获得。 @@ -65,7 +95,7 @@ uniCloud软件版的license是和服务器硬件绑定的,激活软件之前 - 将扫描结果发给DCoud商务经理,由DCloud侧生成`LICENSE`文件 - 将`LICENSE`文件上传至`/uniCloud/`目录下 -### 启动/关闭软件 +### 软件操作命令 > 所有命令请在软件版环境根目录运行 @@ -77,6 +107,10 @@ uniCloud软件版的license是和服务器硬件绑定的,激活软件之前 `./unicloud stop -s [服务空间ID]` +安装云函数第三方依赖 + +`./unicloud install -s [服务空间ID]` + ## 开发指南 @@ -279,3 +313,49 @@ sudo firewall-cmd --reload - uni-push业务API域名 - - restapi.getui.com + +### 日志 + +uniCloud 私有云内置了完善的日志服务支持,日志分为启动日志与运行日志。 + +启动日志是记录 uniCloud 启动期间的所有输出日志,包括启动失败的错误日志。 + +运行日志是在 uniCloud 运行期间记录框架的输出日志和云函数输出日志。 + +#### 日志路径 + +启动日志放在`${HOMEDIR}/logs/${spaceId}/master`路径下,每次启动的日志独立保存。 + +运行时日志默认放在`${HOMEDIR}/logs/${spaceId}`路径下,可以修改服务空间配置文件中的`logger.customLogDir`字段来自定义日志目录。 + +如果想自定义日志路径,可参考如下配置: + +```json + { + "logger": { + "customLogDir": "/your/custom/dir/path" + } + } +``` + +#### 日志分类 + +启动日志 + +- `master-stdout.log` 标准输出日志,包含启动时所有日志。 +- `master-stderr.log` 标准错误日志,启动时如遇到启动失败/异常,错误日志将写入此文件中,方便根据此日志排查问题。 + +运行日志 + +- `logs/client/cloudfunctions.log` 云函数运行日志。 +- `${spaceId}-web.log` uniCloud 框架运行相关日志。 +- `egg-web.log` uniCloud 基于 Eggjs 框架开发,Eggjs 框架内核、插件日志。 +- `egg-agent.log` Eggjs 多进程模型 agent 进程日志。 +- `common-error.log` uniCloud 中任何错误信息都会写入此文件内。 + +#### 日志切割 + +启动日志按照每次启动进行自动切割。 + +运行日志是按天切割,在每日`00:00`按照`.log.YYYY-MM-DD`文件名进行切割。 +