codewave-openclaw-installer 1.0.0

package/skills/smart-customer-service/docs/codewave/30./345/272/224/347/224/250/347/224/237/345/221/275/345/221/250/346/234/237/347/256/241/347/220/206/100./345/272/224/347/224/250/345/257/274/345/207/272/344/270/216/351/203/250/347/275/262/30./345/272/224/347/224/250/345/257/274/345/207/272/351/225/234/345/203/217/345/271/266/351/203/250/347/275/262.md

@@ -0,0 +1,581 @@
+# 应用导出镜像并部署
+
+## 1. 功能概述
+
+当应用不需要二次开发、仅需要快速部署到其他环境，可以在可视化开发界面导出应用的镜像，并在其他环境中部署。
+
+## 2. 具体操作
+
+### 2.1 前提条件
+
+1. 作为应用开发者登陆平台。
+2. 创建、编辑应用并成功发布应用。
+
+> 发布应用时应用能够自动拉取镜像，建议导出镜像前先验证发布成功，否则代码将实时生成，可能导致导出速度比较慢。
+
+### 2.2 镜像导出
+
+1.  进入可视化开发界面，单击顶部 " 更多 " 按钮，然后在下拉框中单击导出和部署，选择导出应用。
+
+    <img src="../assets/jxdc_202407111038_1.png" class="imgStyle" style="" />
+
+2.  选择导出应用。
+
+    - 环境选择建议选择已经成功发布并验证过的环境。
+    - 导出方式选择制品，制品形式选择源码。
+    - 根据实际需求选择是否勾选”应用导出成功后自动生成备份记录“。
+    - 如果是对sql有变更，在导出页面里，会增加“导出增量SQL“的选项。
+
+    <img src="../assets/jxdc_202407111038_2.png" class="imgStyle" style="width:500px;" />
+
+3.  单击导出，浏览器会下载一个压缩包到本地。
+
+    <img src="../assets/jxdc_202407111038_3.png" class="imgStyle" style="" />
+
+4.  解压压缩包，得到相关镜像、配置文件、全量sql文件。解压后文件目录参考如下：
+
+    mge\_export目录：
+
+    - image: docker镜像压缩包
+
+    - db: sql文件
+    - config：配置文件，包括定时器配置
+
+    <img src="../assets/jxdc_202407111038_4.png" class="imgStyle" style="" />
+                
+### 2.3 部署
+
+> 下述文档中{xxxxx}花括号包起来的部分均指代变量，需要在执行时自行替换。
+
+#### 2.3.1 上传压缩包文件到指定服务器
+
+##### 2.3.1.1 ssh连接服务器
+
+1. 这里我们推荐使用SSH登陆Linux实例，在登陆前您需要知晓服务器的管理员账号和密码。
+2. 在终端中输入并执行以下命令链接Linux服务器。
+
+   * username 即为前提条件中获得的默认帐号。
+   * hostname or IP address 为您的 Linux 实例公网 IP 或自定义域名。
+
+   ```
+   ssh <username>@<hostname or IP address>
+   ```
+
+   > 如果您的本地电脑为 Mac OS 系统，需先打开系统自带的终端（Terminal），再执行命令。
+   > 如果您的本地电脑为 Linux 系统，可直接执行命令。
+   > 如果您的本地电脑为 Windows 10 或 Windows Server 2019 系统，需先打开命令提示符（CMD），再执行命令。
+   >
+   
+3. 输入已获取的密码，按 Enter，即可完成登录。
+
+   ![0](../assets/yydcjxbbs_update5.png)
+4. 登陆成功后我们可以发现终端的前缀路径由桌面改成了云服务器的名称，我们可以输入以下指令来查看当前路径下的文件。
+
+   ```
+   ls
+   ```
+
+   ![0](../assets/yydcjxbbs_update6.png)
+
+   > 由于演示的是一个全新的服务器，故在该路径下目前没有任何文件。
+   >
+
+##### 2.3.1.2 新建一个文件夹
+
+为了方便管理，我们在当前服务器路径下新建一个目录deploy，在终端输入以下指令即可。
+
+```
+mkdir deploy
+```
+
+![0](../assets/yydcjxbbs_update7.png)
+
+##### 2.3.1.3 使用scp将解压目录上传至服务器
+
+上传文件目录到服务器需要我们另开一个终端，在新开的终端下输入以下指令以上传目录到服务器中。
+
+```
+scp -r <filepath> <username>@<IP address>:<path/>
+```
+
+* filepath 为待上传的文件目录地址，需要确保该路径下没有中文。
+* @:为您的 Linux 实例公网 IP以及对应上传的目录。
+
+以下是在示例中输入的内容，点击Enter后，文件即上传到了指定目录下。
+
+![0](../assets/yydcjxbbs_update8.png)
+
+##### 2.3.1.4 服务器窗口，进入新建的文件夹
+
+切换至之前的终端，输入以下命令切换至上一步骤示例中上传的指定目录下。
+
+```
+cd deploy/
+cd image_export/
+```
+
+再输入ls，查看该路径下的文件，可以发现应用部署包都已经成功上传了。
+
+![0](../assets/yydcjxbbs_update9.png)
+
+#### 2.3.2 初始化数据库
+
+需进入到db目录。
+
+![0](../assets/yydcjxbbs_update10.png)
+
+应用的数据库初始化脚本为db/{数据库类型}.sql，比如db/mysql.sql、db/oracle.sql。
+
+下面以mysql为例:
+
+```
+-- 先建库，这里根据实际情况执行
+create database lcap_test;
+
+-- 执行初始化脚本
+-- 利用source命令，或者直接粘贴sql执行
+
+source mysql.sql
+```
+
+> 创建数据库后，如果遇到数据导入不成功的问题，可能是用户的数据库配置不满足导入数据的需求。可以尝试以UTF-8编码存储数据，即在建立数据库时执行 create database lcap_test CHARACTER SET utf8;
+
+    ![0](../assets/yydcjxbbs_update11.png)
+
+#### 2.3.3 修改配置文件
+
+需进入到config目录。
+
+![0](../assets/yydcjxbbs_update12.png)
+
+下载的源码配置默认和所选环境(开发或生产)一致，独立部署时一般需要修改部分配置项。
+
+* 开发环境对应的配置文件为/src/main/resources/application-dev.yml。
+* 生产环境对应的配置文件为/src/main/resources/application-online.yml。
+
+下面列出几个常见的需要修改的配置项：
+
+* spring.datasource.url：指定数据库的地址。
+* spring.datasource.username：指定连接数据库的用户名。
+* spring.datasource.password：指定连接数据库的密码。
+* lcp.authCenter.enable：是否开发用户中心认证功能，默认true。
+* lcp.nuims：nuims用户中心服务地址。
+* logging.file.path：应用日志输出路径。
+* connector：连接器配置。包含文件存储配置，其中default_fileStorage_connection代表默认的文件存储配置。
+
+当应用中使用了有数报表时还需要修改下述配置项：
+
+* lcp.report.host: 有数报表服务地址。
+* lcp.report.tokenKey: 有数报表服务token。
+* lcp.report.domainId: 有数报表所在域ID。
+* lcp.report.projectId: 有数报表所在项目ID。
+* lcp.report.reportIdMap: 有数报表ID在开发环境和目标环境的映射关系。
+* lcp.report.componentIdMap: 有数报表使用的组件ID在开发环境和目标环境的映射关系。
+
+<details>
+          <summary title="点击查看页面相关操作说明：" style="font-weight: bold; color: #679CF8; cursor: pointer;">
+            点击展开查看完整的配置说明
+          </summary>
+
+> 通常情况下，大部分配置项不需要修改，仅需修改部署步骤中说明的配置即可。
+
+```
+management: # spring boot actuator相关配置
+  server:
+    port: 9090 #actuator管理端口
+  metrics:
+    export:
+      prometheus:
+        enabled: true # 是否开启prometheus
+    tags:
+      application: ${spring.application.id}
+  endpoints:
+    web: # actuator的rest接口配置
+      base-path: /management #基础路径
+      exposure:
+        include: # actuator对外开放的功能，还有很多可以网上搜索，下面列举了四个，应用部署后[域名]:9090/management/health即可访问
+        - health
+        - prometheus
+        - beans
+        - metrics
+
+logging:
+  file:
+    # 用户日志输出路径
+    path: ${user.home}
+  path: ${logging.file.path}
+spring:
+  mvc:
+    # 静态资源访问路径模式,示例表示任意路径下的静态资源都会被处理
+    static-path-pattern: /**
+  resources:
+    # 指定了三个静态资源的位置
+    static-locations[0]: classpath:/static/
+    static-locations[1]: classpath:/static/assets/
+    static-locations[2]: classpath:/static/packages/
+  main:
+    # 禁用懒加载，启动时会立即初始化所有bean
+    lazy-initialization: false
+  application:
+    # 应用程序名称
+    name: exporttest
+    # 应用程序唯一标识符
+    id: 8e679dbb-4dd5-424c-9890-bac0327d99ee
+  liquibase:
+    # 禁用liquibase,(一个数据库版本控制工具)
+    enabled: false
+  initDatabase:
+    # 禁用数据库初始化,启动时不会执行数据库初始化操作
+    enabled: false
+  quartz:
+    # 禁用quartz调度框架
+    enabled: false
+  devtools:
+    restart:
+      # 代码变化时应用程序不会自动重启
+      enabled: false
+    livereload:
+      # 前端资源变化时不会自动刷新浏览器
+      enabled: false
+  datasource:
+    # 设置数据源类型为HikariDataSource
+    type: com.zaxxer.hikari.HikariDataSource
+    # 设置jdbc的驱动
+    driver-class-name: com.mysql.cj.jdbc.Driver
+    # 数据库地址
+    url: jdbc:mysql://59.111.104.252:3306/defaulttenant-dev-exporttest-fOp3u0?useUnicode=true&characterEncoding=utf8&useSSL=false&useLegacyDatetimeCode=false&serverTimezone=Asia/Shanghai&nullCatalogMeansCurrent=true&zeroDateTimeBehavior=CONVERT_TO_NULL
+    # 数据库账号
+    username: defau_OESmq_user
+    # 数据库密码
+    password: ''
+    # 指定连接超时时间3秒
+    connection-timeout: 3000
+    hikari:
+      # 连接池名称
+      poolName: Hikari
+      # 禁用自动提交
+      auto-commit: false
+      data-source-properties:
+        # 启用预编译语句缓存
+        cachePrepStmts: true
+        # 预编译语句缓存的大小
+        prepStmtCacheSize: 250
+        # 预编译语句sql代码的最大长度
+        prepStmtCacheSqlLimit: 2048
+        # 启用服务端的预编译语句
+        useServerPrepStmts: true
+  servlet:
+    multipart:
+      # 文件上传的最大大小
+      max-file-size: 50MB
+      # 请求的最大大小
+      max-request-size: 50MB
+  messages:
+    # 国际化消息资源文件
+    basename: i18n/messages
+  profiles:
+    # 加载application-auth.yml文件
+    include: auth
+mybatis:
+  # 指定mybatis的映射文件位置
+  mapper-locations: classpath:mappings/**/*Mapper.xml
+  # 自定义类型处理器的包路径
+  type-handlers-package: com.defaulttenant.exporttest.repository.handler
+  configuration:
+    # 数据库厂商标识
+    database-id: mysql
+    # 默认枚举类型处理器
+    default-enum-type-handler: com.defaulttenant.exporttest.repository.handler.AutoEnumTypeHandler
+    # 指定mybatis的日志实现为标准输出
+    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
+server:
+  # 应用程序端口号
+  port: 8080
+  compression:
+    # 启用服务器响应压缩
+    enabled: true
+    # 指定需要压缩的mime类型
+    mime-types: text/html,text/xml,text/plain,text/css, application/javascript, application/json
+    # 响应超过这个大小才会进行压缩
+    min-response-size: 1024
+lcp:
+  # 雪花算法nodeId(默认不需要)
+  snowflakeNodeId: null
+  authCenter:
+    # 是否开启用户中心认证功能
+    enable: true
+    address: http://nuims.low-code:8081/nuims
+    host: nuims.low-code
+    security:
+      lockMilliseconds: 900000
+      maxFailureTimes: 5
+  flowUrl: http://api.gateway.lowcode/gateway/bpms
+  gatewayUrl: ''
+  audit:
+    enable: true
+    address: http://platform-audit.service.163.org
+  # 指定页面的index文件
+  uiResourceAddress: /client.js
+  gatewayType: light
+  # 禁用response响应日志
+  logResponse: false
+  # 开启request请求日志
+  logRequest: true
+  # quartz调度相关的表
+  quartzTables: 
+    SIMPROP_TRIGGERS: NC7B0634_SIMPROP_TRIGGERS
+    BLOB_TRIGGERS: NC7B0634_BLOB_TRIGGERS
+    TRIGGERS: NC7B0634_TRIGGERS
+    SIMPLE_TRIGGERS: NC7B0634_SIMPLE_TRIGGERS
+    LOCKS: NC7B0634_LOCKS
+    CRON_TRIGGERS: NC7B0634_CRON_TRIGGERS
+    FIRED_TRIGGERS: NC7B0634_FIRED_TRIGGERS
+    CALENDARS: NC7B0634_CALENDARS
+    JOB_DETAILS: NC7B0634_JOB_DETAILS
+    SCHEDULER_STATE: NC7B0634_SCHEDULER_STATE
+    PAUSED_TRIGGER_GRPS: NC7B0634_PAUSED_TRIGGER_GRPS
+  report:
+    # 有数报表服务地址
+    host: ''
+    # 有数报表服务token
+    tokenKey: ''
+    # 有数报表所在区域id
+    domainId: null
+    # 有数报表所在项目id
+    projectId: null
+    # 有数报表id在开发环境和目标环境的映射关系
+    reportIdMap: {}
+    # 有数报表使用的组件ID在开发环境和目标环境的映射关系
+    componentIdMap: {}
+  # nuims用户中心服务地址
+  nuims: http://nuims.low-code:8081
+  # 私钥
+  private: null
+  # 端配置
+  frontends:
+    pc:
+      name: pc
+      path: /
+      title: PC端
+      type: pc
+    m:
+      name: m
+      path: /m
+      title: H5端
+      type: h5
+upload:
+  # 未使用
+  base-path: app
+file:
+  # 指定以下类型强制下载文件
+  types: text/plain;text/html;text/css;application/javascript
+# 逻辑鉴权开关
+logicAuthFlag: false
+auth:
+  pass:
+    # 密码盐值(默认登陆组件)
+    salt: $2a!@#$%^&*()_+
+  token:
+    # jwt签名密钥(默认登陆组件、lcap-auth依赖库使用)
+    secret: 23df79c4786498f
+    # token过期时间(默认登陆组件, lcap-auth依赖库内使用的是常量)
+    expire: 86400
+  # 认证相关插件
+  plugin:
+    list:
+      Normal:
+        category: main
+  types: Normal
+  Normal: '{"category":"main"}'
+# 外部接口网关地址
+gw:
+  app:
+    addr:
+      lowcode: http://lcap.low-code:22988
+      nuims: http://nuims.low-code:8081
+lcap:
+  domain:
+    package:
+      # 数据结构包名
+      structure: com.defaulttenant.ghug.domain.structure
+      # 匿名数据结构包名
+      anonymous_structure: com.defaulttenant.ghug.domain.structure.anonymous
+      # 实体包名
+      entities: com.defaulttenant.ghug.domain.entities
+      # 枚举包名
+      enumeration: com.defaulttenant.ghug.domain.enumeration
+custom:
+  api:
+    # ui资源基础路径,会替换static/index.html中的${uiBasePath}
+    context-path: /
+  system:
+    # 使用用户所在时区
+    time-zone: user
+# 文件存储相关配置
+fileStorage:
+  lcap_default_connection: '{"refConnection":"","defaultConnection":true,"title":"系统文件存储"}'
+# 连接器相关配置，详情请参考连接器定义
+connector:
+  #默认的文件存储
+  default_fileStorage_connection:
+    accessKey: AAAAAAAAAAAAA
+    secretKey: AAAAAAAAAAAAA
+    bucket: codewave
+    privateBucket: 'true'
+    endpoint: oss-cn-beijing.aliyuncs.com
+    pathStyleAccessEnabled: 'false'
+    cdnAddress: null
+  #额外添加的文件存储方式
+  myLocalStorage:
+    accessKey: AAAAA
+    secretKey: AAAAA
+    bucket: AAAAA
+    privateBucket: 'false'
+    endpoint: AAAAA
+    pathStyleAccessEnabled: 'false'
+    cdnAddress: null
+    sinkPath: local;D:/myfiles
+  redis:
+    address: 172.29.0.12
+    port: '16379'
+    password: '123456'
+    database: '0'
+# 依赖库相关的配置，开头为 extensions.xxx,详情请参考依赖库定义
+extensions.libraryDemo_redis.custom:
+  redisHost: 172.29.0.12
+  redisPort: '16379'
+  redisPassword: '123456'
+  redisSentinelMaster: ''
+  redisSentinelNodes: ''
+  redisSentinelPassword: ''
+```
+
+</details>
+
+
+#### 2.3.4 加载镜像
+
+进入image 使用docker load命令加载docker镜像压缩包。
+
+```
+docker load -i {docker镜像文件名}
+
+如：docker load -i hello.tar.gz
+```
+
+之后即可看到加载后的docker镜像，也可以通过docker images查看。
+
+![0](../assets/yydcjxbbs_update13.png)
+
+#### 2.3.5 启动服务
+
+启动服务的前提条件：
+
+1. sql已执行。
+2. 配置文件修改。
+3. 镜像已加载。
+
+启动服务的命令如下：
+
+```
+docker run --name {容器名} -i -p 8080:8080 --mount type=bind,source={config目录地址},target=/config -d {docker加载后的镜像名}
+
+示例：docker run --name exportdemo -i -p 8080:8080 --mount type=bind,source=/root/deploy/image_export/config,target=/config  -d exportdemo:1675996801568
+```
+
+* 日志挂载
+
+若要对日志进行输出，则需要在服务器创建日志目录，如/root/deploy/image_export/logs，并挂载到/root/logs。
+
+![0](../assets/yydcjxbbs_update14.png)
+
+```
+--mount type=bind,source=/root/deploy/image_export/logs,target=/root/logs
+```
+
+* 端口暴露
+
+默认情况下，端口暴露为8080。
+
+如果需要修改端口，需要修改配置文件里的配置。
+
+```
+server: port: 8080
+```
+
+另外启动时，需要修改端口映射。
+
+如将 server.port 改为 9001 那启动命令为：
+
+```
+docker run -p 9001:9001
+```
+
+* 启动服务
+
+  ![0](../assets/yydcjxbbs_update15.png)
+
+接着可以通过docker ps -a 命令查看容器情况。
+
+![0](../assets/yydcjxbbs_update16.png)
+
+一般来说，超过30s，容器仍处于UP状态情况，则表示服务启动。
+
+#### 2.3.6 访问服务
+
+另外需要在阿里云服务器上开放8080端口或者自定义端口，参考[https://developer.aliyun.com/article/701181](https://developer.aliyun.com/article/701181)。
+
+一般访问部署节点的8080端口(默认端口，可修改配置文件)即可，比如浏览器访问http://{ip}:8080。
+
+![0](../assets/yydcjxbbs_update17.png)
+
+![0](../assets/yydcjxbbs_update18.png)
+
+## 3. 补充说明
+
+### 3.1 导入数据库数据
+
+您可以按需选择是否需要将CodeWave平台应用中的数据库数据导入到独立部署环境。若应用是用户私有用户认证，至少需要导入用户和权限相关的数据。
+
+#### 3.1.1 场景描述
+
+本节将以导出CodeWave应用中用户和权限相关的数据为例，介绍如何导出应用数据。
+
+#### 3.1.2 具体操作
+
+1. 进入**应用详情**页的**基本信息**选项卡，点击**登录**访问对应环境的数据库WebSQL。
+
+   ![0](../assets/yydcjxbbs_update19.png)
+2. 点击**导出**按钮，然后点击**添加任务**按钮。
+
+   ![0](../assets/yydcjxbbs_update20.png)
+3. 在弹窗中搜索"LCAP"并全选搜索结果，点击确定。
+
+   ![0](../assets/yydcjxbbs_update21.png)
+4. 将导出的数据使用SQL等方式导入到目标数据库中。
+
+
+<div style="text-align: right;font-size: 14px;">
+    <span style="color: rgb(78, 110, 142);">创建人：</span>
+    <span style="color: rgb(118, 118, 118);">有鲤</span>
+    <span style="color: rgb(78, 110, 142);margin: 0 0 0 40px;">更新时间：</span>
+    <span style="color: rgb(118, 118, 118);">2024年11月13日</span>
+</div>
+
+<style>
+
+  /* 折叠块加边框、背景色、边距 */
+  details {
+      border: 1px solid #679CF8; /* 添加边框 */
+      border-radius: 6px;
+      background-color: #F8FCFF; /* 添加底色 */
+      padding: 10px 10px 10px 40px;
+      /* 可选：设置默认背景色，如果需要的话 */
+  }
+
+  /* 折叠块标题不需要内边距 */
+  details summary {  
+    margin: 0 0 0 -20px;
+  }
+
+</style>