Skip to content

For the complete documentation index, see llms.txt. Markdown versions of all docs pages are available by appending .md to any docs URL.

Page as Markdown

Basic authentication

Attaches to:

Route

Basic authentication enables a simple username/password authentication mechanism.

Warning

Basic authentication is not generally recommended for production use. At a minimum, use basic authentication along with TLS encryption.

The htpasswd field specifies the username/password pairs. See the htpasswd documentation. The realm field, optionally, specifies the realm name returned in error responses.

Additionally, authentication can run in two different modes:

  • Strict: A valid username/password pair must be present.
  • Optional (default): If a username/password pair exists, validate it.
    Warning: This allows requests without a username/password pair!
basicAuth:
  mode: strict
  # Generated with `htpasswd -nb -B user1 agentgateway`
  # You can also use:
  # htpasswd:
  #   file: /path/to/htpasswd
  # With inline configuration, $ must be escaped to $$.
  htpasswd: |
    user1:$$2y$$05$$LMZ.8WGNqvagmtJz2Gw6VuiE6khXc2zc0FDTHrfWJyLT66HM8BMAa
  realm: example.com

Now to send requests, include the username and password.

curl http://user1:agentgateway@localhost:3000
Was this page helpful?
Agentgateway assistant

Ask me anything about agentgateway configuration, features, or usage.

Note: AI-generated content might contain errors; please verify and test all returned information.

Tip: one topic per conversation gives the best results. Use the + button in the chat header to start a new conversation.

Switching topics? Starting a new conversation improves accuracy.
↑↓ navigate select esc dismiss

What could be improved?

Your feedback helps us improve assistant answers and identify docs gaps we should fix.

Need more help? Join us on Discord: https://discord.gg/y9efgEmppm

Want to use your own agent? Add the Solo MCP server to query our docs directly. Get started here: https://search.solo.io/.