应用 Basic 认证组

# 目录结构

|-- basic_auth_groups/
  |-- groups.yaml

每个 yaml 文件包含一个或者多个应用基本认证组的配置。

# 配置说明

每个基本认证组配置是一个包含以下参数的对象：

# users 配置

# 配置示例

---
- name: hello
  label: 'world.'
  users:
  - username: 'username1'
    password: 'password1'
  - username: 'username2'
    password: 'password2'
  - username: 'username3'
    password: 'password3'

此配置定义了一个名为 “hello” 的基本认证组，包含三个用户。

# 使用示例

更新配置到 OpenResty Edge 中：

edge-config https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -l basic_auth_groups -i /root/oredge-configs -d test.com

从 OpenResty Edge 中导出配置：

edge-config -u https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -E -l basic_auth_groups -d test.com

清理 OpenResty Edge 中的配置：

edge-config -u https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -c -l basic_auth_groups -d test.com

示例中均使用 -l basic_auth_groups 来指定只操作应用基本认证组相关的配置。

# 注意事项

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

2. 用户名和密码不能为空或空字符串。

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

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

5. 如果配置中删除了某个用户，工具会自动从认证组中移除该用户。

6. 如果配置中删除了某个认证组，工具会自动从应用中移除该认证组。

7. 在导出配置时，默认不会导出用户信息。如果需要导出用户信息，需要设置 export_users 参数为 True。

8. 出于安全考虑，导出的配置中不会包含实际的密码信息。

# 相关文档

• 在“启用 Basic 认证”动作中使用应用 Basic 认证组
• 全局 Basic 认证组