Skip to content

应用配置

通过设置 project.yaml 中的 parameters 字段,可以声明自定义配置项,这些配置项会显示在应用设置页面中,供用户配置。

支持三种类型的配置项:

  • 字符串类型
  • 数字类型
  • 密码类型
  • 路径类型

配置示例:

yaml
parameters:
    # 配置项标识
  - key: ACCOUNT
    # 配置项类型,支持 string(字符串), number(数字), path(路径), password(密码)
    type: string
    # 是否必填
    required: true
    # 配置后是否支持再修改
    changeable: true
    # 配置项展示信息(多语言)
    i18n:
      en-US:
        # 配置项名称
        name: Login Account
        # 配置项描述(补充说明,填写规范等)
        description: 6-8 characters
      zh-CN:
        name: 登录账号
        description: 长度6-8位

配置项的值可以在应用运行时通过环境变量获取,环境变量的名称为配置项的 key。 用户可以在应用设置页面中修改配置项的值,修改之后需要重启应用才能生效。 如果配置项不支持修改,可以在声明配置项时设置 changeablefalse