Basic Auth Middleware

Note

• Examples under each key are only to be used as a placement guide
• See the Full Examples section for complete examples.
• Upstream documentation for this middleware can be found here

Appears in

• .Values.middlewares.$name.data

Tip

• See available middleware keys here.
• This options apply only when type: basic-auth.

---

users

Define the users

Note

If this is set, the secret key must not be set.

Key	middlewares.$name.data.users
Type	list of map
Required	✅
Helm tpl	❌
Default	-

Example

middlewares:
  middleware-name:
    data:
      users:
        - username: some-username
          password: some-password

---

users[].username

Define the username

Key	middlewares.$name.data.users.username
Type	string
Required	✅
Helm tpl	❌
Default	-

Example

middlewares:
  middleware-name:
    data:
      users:
        - username: some-username
          password: some-password

---

users[].password

Define the password

Key	middlewares.$name.data.users.password
Type	string
Required	✅
Helm tpl	❌
Default	-

Example

middlewares:
  middleware-name:
    data:
      users:
        - username: some-username
          password: some-password

---

secret

Define the secret

Note

If this is set, the users key must not be set.

Key	middlewares.$name.data.secret
Type	string
Required	✅
Helm tpl	❌
Default	-

Example

middlewares:
  middleware-name:
    data:
      secret: some-secret

---

Full Examples

middlewares:
  middleware-name1:
    enabled: true
    type: basic-auth
    data:
      users:
        - username: some-username
          password: some-password
  middleware-name2:
    enabled: true
    type: basic-auth
    data:
      secret: some-secret