Guides
Custom Domains & Hosts
Custom domains in OLAF allow you to configure personalized subdomains for your authentication flows, ensuring a seamless and branded user experience. This guide will walk you through managing custom domains and updating host callback URLs.
Managing Custom Domains
The Custom Domains page is located under the Tools & Preferences section in the app’s left menu. Here, you can:
- List all added domains with their current status.
- Search for existing domains for quick access.
- Add new custom domains with API and Dashboard subdomains.
- Check and update DNS records to verify domain ownership.
- Delete existing domains if they are no longer needed.
Add New
To add a new custom domain:
- Navigate to
Tools & Preferences
→Custom Domains
. - Click
Add new
. - Enter your custom domain in the input field.
- The dialog will expand with fields for defining API subdomain and Dashboard subdomain.
Choosing Subdomains
When setting up your API and Dashboard subdomains:
- You can define your own subdomain names.
- OLAF provides suggested subdomain examples to help you decide (e.g., api.yourdomain.com, id.yourdomain.com).
- Ensure that your subdomains match your intended use case.
Once submitted, the domain will appear in the list with a Pending
status until verification is complete.
Updating DNS Records
After adding a domain, you need to configure the correct DNS records with your domain provider.
- Click
DNS Records
next to your added domain. - A dialog will open with instructions on adding three required DNS records:
- TXT Record: Used to verify domain ownership.
- CNAME Record (API Subdomain): Points your API subdomain to OLAF’s infrastructure.
- CNAME Record (Dashboard Subdomain): Redirects your dashboard subdomain to OLAF’s hosted login page.
- Update these records in your domain provider’s settings.
- Click
Verify
in OLAF to check if the DNS entries have propagated.
Once verified, the domain status will change from Pending to Active.
Delete Existing
If a domain is no longer needed, it can be removed:
- Navigate to
Tools & Preferences
→Custom Domains
. - Locate the domain in the list.
- Click Delete to remove it from OLAF.
Warning
Deleting a domain will disable authentication flows associated with it. Ensure you update your applications before removal.
Update Host’s Callback URLs
After verifying a custom domain, you must update your Host’s Callback URLs to enable authentication.
- Navigate to Application Details.
- Open the Hosts Tab.
- Click
Add Callback URL
. - Enter the new callback URL using your custom domain.
- Save the changes.
Now, authentication flows will use your custom domain for login redirection.
Best Practices
- Use subdomains aligned with your organization’s naming conventions to keep URLs intuitive.
- Verify DNS propagation times with your provider before troubleshooting verification failures.
- Regularly review active domains to keep your configuration clean and up to date.