Skip to content

Commit 82ad8a5

Browse files
authored
chore: add custom domain section (#306)
Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
1 parent 9a01d80 commit 82ad8a5

10 files changed

+469
-3
lines changed

cloud/architecture.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ These environments act as the data plane to serve feature flag data to your appl
4141

4242
Each Flipt environment gets its own unique URL that you use to serve feature flag data to your applications. Our SDKs and API clients use this URL to connect to the Flipt instance in the Flipt Cloud environment.
4343

44+
<Tip>
45+
You can now use your own custom domains with Flipt Cloud to serve feature flag
46+
data to your applications. See the [Custom
47+
Domains](/cloud/features/custom-domains) overview for more information.
48+
</Tip>
49+
4450
## Evaluation
4551

4652
Flipt Cloud supports evaluation for our [client-side SDKs](/integration/client) out of the box. These SDKs are available for many popular programming languages, including JavaScript, TypeScript, Go, Java, Ruby, Python, and more. These client-side SDKs are designed with performance in mind, and store feature flag data in memory to serve feature flag evaluations quickly.

cloud/features/custom-domains.mdx

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: Custom Domains
3+
description: Learn how to use your own custom domains with Flipt Cloud
4+
mode: "wide"
5+
---
6+
7+
<Note>
8+
Custom domains are currently in beta. Contact us at
9+
[support@flipt.io](mailto:support@flipt.io) to get access.
10+
</Note>
11+
12+
## Overview
13+
14+
Flipt Cloud allows you to use your own custom domains for evaluating feature flags against your Flipt Cloud instances. This means you can replace the default `*.flipt.cloud` domain with your own domain (like `features.acme.com`) when making API calls to Flipt.
15+
16+
This is useful if you want to use a domain (or subdomain) that you already own in order to provide a branded experience for your users.
17+
18+
<img
19+
className="block dark:hidden"
20+
src="/images/cloud/features/domains/client-evaluation-cloud-light.svg"
21+
/>
22+
<img
23+
className="hidden dark:block"
24+
src="/images/cloud/features/domains/client-evaluation-cloud-dark.svg"
25+
/>
26+
27+
<Info>
28+
Custom domains are only available on our Team plan and above and incur a small
29+
additional cost per month.
30+
</Info>
31+
32+
## Why Use Custom Domains?
33+
34+
There are a couple of reasons why you might want to use a custom domain with Flipt Cloud.
35+
36+
### Professional Branding & White Labeling
37+
38+
By default when using Flipt Cloud, every environment gets its own subdomain at `{your-environment}-{your-organization}.flipt.cloud`. When configuring our SDKs to evaluate feature flags, this is the domain that you'll use.
39+
40+
For example, if you have an environment called `dev` and an organization called `acme-corp`, the default domain for that environment will be `dev-acme-corp.flipt.cloud`.
41+
42+
Normally this is no big deal, but if you're using Flipt Cloud to power a product that you're selling to your customers, you may want to use your own domain to provide a branded experience. Particularly if you're using Flipt Cloud to power a mobile or browser based product, it's relatively easy for your users to inspect the network requests and see `flipt.cloud` in the request.
43+
44+
By using your own domain, you can provide a more branded experience for your users, making the integration feel more seamless and professional.
45+
46+
Instead of:
47+
48+
```
49+
https://dev-acme-corp.flipt.cloud
50+
```
51+
52+
You can use your own domain or subdomain:
53+
54+
```
55+
https://features.acme.com
56+
```
57+
58+
### Enhanced Security & Compliance
59+
60+
Using custom domains can provide several security benefits:
61+
62+
1. **Domain Allowlisting**: Many organizations maintain strict allowlists of approved domains for outbound network requests. Using your own domain makes it easier to comply with these security policies without having to allowlist `*.flipt.cloud`.
63+
64+
2. **Network Isolation**: Some organizations use internal DNS to route traffic through security appliances or VPNs. Custom domains allow you to configure your DNS to route Flipt traffic through your existing security infrastructure.
65+
66+
3. **Data Privacy**: Using your own domain helps mask the use of third-party services from end users, making it harder for potential attackers to identify which services your application depends on.
67+
68+
## Setting Up Custom Domains
69+
70+
<Tip>
71+
We're working on a guide to walk you through the process of setting up a
72+
custom domain. Check back soon for more details!
73+
</Tip>
74+
75+
Using custom domains with Flipt Cloud is a simple three step process:
76+
77+
1. **Configure the Domain**: Once enabled, you can add your custom domain to your Flipt Cloud environment in the Flipt Cloud UI.
78+
79+
![Environment Domain](/images/cloud/features/domains/environment-domain.png)
80+
81+
2. **Configure the DNS**: You'll need to configure the DNS for your custom domain to point to your existing Flipt Cloud environment.
82+
83+
![DNS Configuration](/images/cloud/features/domains/dns-configuration.png)
84+
85+
3. **Update Your SDKs**: Once the DNS has propagated, you simply need to update your SDKs to use the new domain.
86+
87+
```typescript {2}
88+
const fliptEvaluationClient = await FliptEvaluationClient.init("default", {
89+
url: "https://features.acme.com",
90+
authentication: {
91+
clientToken,
92+
},
93+
});
94+
```
95+
96+
## Limitations
97+
98+
- Custom domains are a paid feature available on Team plans and above
99+
- Custom domains can only be used with Flipt Cloud SDKs for API calls
100+
- The Flipt Cloud UI will continue to use the `*.flipt.cloud` domain

cloud/features/user-management.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Flipt Cloud makes it easy to manage your team members and their permissions. You
88

99
![User Management](/images/cloud/features/users/team.png)
1010

11-
With features like [role-based access control](/cloud/features/rbac), you can ensure that team members have the right level of access to the features they need, while keeping sensitive data secure.
11+
With features like [Role-Based Access Control](/cloud/features/rbac), you can ensure that team members have the right level of access to the features they need, while keeping sensitive data secure.
1212

1313
![Invite Users](/images/cloud/features/users/invite.png)
1414

0 commit comments

Comments
 (0)