Set up Basic Auth
The documentation only applies to instances deployed on Alokai@Edge.
Basic Authentication (Basic Auth) lets you protect your instance with a username and password. It is useful for restricting access to staging environments, development previews, or internal projects before going live.
Configurationri:link
General behavior
- You can add multiple credentials (username + password pairs).
- Basic Auth can be enabled or disabled at any time.
- Without at least one credential, Basic Auth cannot be enabled.
- Credentials can be edited or removed after being added.
- Enabling Basic Auth also affects Commerce Intelligence and Performance Audits — automated audits cannot run while Basic Auth is active.
Basic Auth & IP allow listri:link
When Basic Auth and the IP access list are enabled simultaneously:
- For addresses on the IP allow list, Basic Auth is not required.
Basic Auth & CDNri:link
CDN works only for instances that don't use Basic Auth, since authentication headers prevent caching.
When Basic Auth is active:
- All requests must include valid credentials (username + password), except for requests coming from IPs on the Allowed list.
- Responses are served directly from the origin – no CDN caching applies.
- Performance audits cannot be conducted, since automated tools cannot bypass authentication.
When Basic Auth is disabled:
- If CDN was previously enabled, caching will work again.