全局 Basic 认证用户组

目录结构

|-- global_basic_auth_groups/
  |-- global_basic_auth_groups.yaml
  |-- ...

YAML 文件中可以包含一个或多个全局基本认证组。

配置说明

参数名数据类型是否必选描述
namestring全局基本认证组的名称,也是该组的唯一标识
labelstring全局基本认证组的标签,用于描述该组
usersarray该组中的用户列表
usernamestring用户名
passwordstring用户密码

配置示例

---
- name: hello
  users:
  - username: 'username1'
    password: 'password1'
  - username: 'username2'
    password: 'password2'
  - username: 'username3'
    password: 'password4'
- name: world
  label: 'group 2'
  users:
  - username: 'username1'
    password: 'password1'
  - username: 'username2'
    password: 'password2'
  - username: 'username3'
    password: 'password4'

此配置定义了两个全局基本认证组,每个组包含三个用户。

使用示例

更新配置到 OpenResty Edge 中:

edge-config https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -l global_basic_auth_groups -i /root/oredge-configs

从 OpenResty Edge 中导出配置:

edge-config -u https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -E -l global_basic_auth_groups

示例中均使用 -l global_basic_auth_groups 来指定只导入/导出全局基本认证组相关的配置。

需要注意的是,出于安全考虑,导出配置时不会导出实际的密码信息。

注意事项

  1. 全局基本认证组是一个全局配置,为了保持与多个本地配置的兼容性,在更新配置时不会执行删除操作。

  2. 在导出配置时,如果未指定导出用户信息,将不会导出用户列表,并会显示警告信息。

  3. 每个全局基本认证组必须有一个唯一的名称。

  4. 导入配置时,用户名和密码不能为空字符串。

  5. 标签字段是可选的,但可以用来为全局基本认证组添加描述信息。

  6. 在导入配置时,工具会先检查配置的有效性,然后再执行添加或更新操作。

相关文档