Skip to content

Commit d9e330e

Browse files
authored
Merge pull request #1 from brainpodnl/feat/custom-domains-docs
feat: add custom domains documentation
2 parents 5e37b72 + 7eb4b3a commit d9e330e

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

src/custom_domains.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
order: 5
3+
hide_menu: false
4+
---
5+
# Custom domains
6+
7+
Every route on Brainpod comes with a unique hostname under `*.prod.brainpod.io`. While these work great for testing and internal services, you'll likely want to use your own domain for production applications.
8+
9+
Custom domains let you serve your apps from any domain you own. When you add a custom domain to a route, we provision a TLS certificate and configure routing for that domain. Point your DNS to Brainpod, and we handle the rest automatic TLS certificates, traffic routing, and renewals.
10+
11+
## Adding a Custom Domain
12+
13+
To add a custom domain to your route:
14+
15+
1. Create or edit your route in the dashboard
16+
2. Add your domain (e.g., `api.example.com` or `www.example.com`) to the route configuration
17+
3. Deploy the route changes
18+
4. Navigate to the Domains page in your dashboard
19+
5. Find your domain and copy the DNS target (CNAME value) provided
20+
6. Go to your DNS provider's control panel
21+
7. Add the appropriate DNS records pointing to the target (see DNS Configuration below)
22+
8. Return to the Domains page to monitor verification status
23+
24+
The Domains page shows all your custom domains with their verification states and DNS records. Once your DNS records are updated and propagating, we automatically provision a TLS certificate. This typically takes a few minutes but can take longer depending on DNS propagation times.
25+
26+
## DNS Configuration
27+
28+
To configure DNS for your custom domain, create a CNAME record pointing to the DNS target provided in the Domains page. This is typically something like your-route.prod.brainpod.io.
29+
30+
```
31+
www.example.com. CNAME your-route.prod.brainpod.io.
32+
```
33+
34+
CNAME records automatically follow any infrastructure changes on our side, so you won't need to update them if our routing changes.
35+
36+
## Multiple Custom Domains
37+
38+
A single route can have multiple custom domains. This is useful when you want several domains pointing to the same application—for example, `www.example.com` and `app.example.com`, or multiple brand domains.
39+
40+
To add multiple domains, simply add each domain when creating or editing your route configuration. After deploying, configure DNS records for each domain separately in your DNS provider.
41+
42+
Each domain gets its own TLS certificate and verification status on the Domains page. All domains on a route use the same routing rules and point to the same apps.
43+
44+
## Next Steps
45+
- [Resources](resources.md) — Learn about apps and routes
46+
- [Getting Started](getting-started.md) — Deploy your first application

0 commit comments

Comments
 (0)