Skip to content

SER-330 Update flow for apex domains #2340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

SER-330 Update flow for apex domains #2340

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eeebf6f
Update flow for apex domains
vermakhushboo Sep 9, 2025
9a1551b
Merge branch 'main' into feat-cname-flattening
vermakhushboo Sep 11, 2025
6453083
Change CAA badge to recommended
vermakhushboo Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/lib/components/domains/cnameTable.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
{/if}
</Layout.Stack>
<Typography.Text variant="m-400">
Add the following record on your DNS provider. Note that DNS changes may take time to
propagate fully.
Add the following record on your DNS provider. Note that DNS changes may take up to 48
hours to propagate fully.
</Typography.Text>
</Layout.Stack>

Expand All @@ -51,6 +51,18 @@
text={$regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME} />
</Table.Cell>
</Table.Row.Base>
<Table.Row.Base {root}>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide if we dont have caa in env var

<Table.Cell {root}>
<Layout.Stack direction="row" alignItems="center" gap="xs">
CAA
<Badge variant="secondary" size="s" content="Optional" />
</Layout.Stack>
</Table.Cell>
<Table.Cell {root}>@</Table.Cell>
<Table.Cell {root}>
<InteractiveText variant="copy" isVisible text={`0 issue "certainly.com"`} />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need this dynamic

</Table.Cell>
</Table.Row.Base>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider making the CAA record value configurable.

The CAA record value is hardcoded to 0 issue "certainly.com". This should ideally be configurable through environment variables or settings, similar to how CNAME values are managed via $regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME.

Consider refactoring to make the CAA value configurable:

 <Table.Row.Base {root}>
     <Table.Cell {root}>
         <Layout.Stack direction="row" alignItems="center" gap="xs">
             CAA
             <Badge variant="secondary" size="s" content="Optional" />
         </Layout.Stack>
     </Table.Cell>
     <Table.Cell {root}>@</Table.Cell>
     <Table.Cell {root}>
-        <InteractiveText variant="copy" isVisible text={`0 issue "certainly.com"`} />
+        <InteractiveText variant="copy" isVisible text={$regionalConsoleVariables._APP_DOMAIN_CAA_RECORD || `0 issue "certainly.com"`} />
     </Table.Cell>
 </Table.Row.Base>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<Table.Row.Base {root}>
<Table.Cell {root}>
<Layout.Stack direction="row" alignItems="center" gap="xs">
CAA
<Badge variant="secondary" size="s" content="Optional" />
</Layout.Stack>
</Table.Cell>
<Table.Cell {root}>@</Table.Cell>
<Table.Cell {root}>
<InteractiveText variant="copy" isVisible text={`0 issue "certainly.com"`} />
</Table.Cell>
</Table.Row.Base>
<Table.Row.Base {root}>
<Table.Cell {root}>
<Layout.Stack direction="row" alignItems="center" gap="xs">
CAA
<Badge variant="secondary" size="s" content="Optional" />
</Layout.Stack>
</Table.Cell>
<Table.Cell {root}>@</Table.Cell>
<Table.Cell {root}>
<InteractiveText
variant="copy"
isVisible
text={$regionalConsoleVariables._APP_DOMAIN_CAA_RECORD || `0 issue "certainly.com"`}
/>
</Table.Cell>
</Table.Row.Base>
🤖 Prompt for AI Agents 
In src/lib/components/domains/cnameTable.svelte around lines 54 to 65 the CAA
record value is hardcoded to `0 issue "certainly.com"`; make it configurable by
reading the CAA value from the same config source used for CNAMEs (e.g. a
regionalConsoleVariables entry or an environment-derived prop), provide a
sensible default if unset, and pass that variable into the InteractiveText
component instead of the literal string; ensure the prop or store is
typed/validated and update any parent component or initialization to supply the
configurable CAA value.

</Table.Root>
<Layout.Stack gap="s" direction="row" alignItems="center">
<Icon icon={IconInfo} size="s" color="--fgcolor-neutral-secondary" />
Expand Down
48 changes: 35 additions & 13 deletions src/lib/components/domains/recordTable.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,26 @@
Alert
} from '@appwrite.io/pink-svelte';
import { regionalConsoleVariables } from '$routes/(console)/project-[region]-[project]/store';
import { isASubdomain } from '$lib/helpers/tlds';
export let domain: string;
export let verified = undefined;
export let variant: 'cname' | 'a' | 'aaaa';
export let service: 'sites' | 'general' = 'general';
interface Props {
domain: string;
verified?: boolean;
variant: 'cname' | 'a' | 'aaaa';
service?: 'sites' | 'general';
onNavigateToNameservers?: () => void;
}
let {
domain,
verified = undefined,
variant,
service = 'general',
onNavigateToNameservers = undefined
}: Props = $props();
let subdomain = domain?.split('.')?.slice(0, -2)?.join('.');
const isSubDomain = $derived.by(() => isASubdomain(domain));
function setTarget() {
switch (variant) {
Expand Down Expand Up @@ -44,8 +57,8 @@
{/if}
</Layout.Stack>
<Typography.Text variant="m-400">
Add the following record on your DNS provider. Note that DNS changes may take time to
propagate fully.
Add the following record on your DNS provider. Note that DNS changes may take up to 48
hours to propagate fully.
</Typography.Text>
</Layout.Stack>

Expand All @@ -62,16 +75,25 @@
<InteractiveText variant="copy" isVisible text={setTarget()} />
</Table.Cell>
</Table.Row.Base>
<Table.Row.Base {root}>
<Table.Cell {root}>
<Layout.Stack direction="row" alignItems="center" gap="xs">
CAA
<Badge variant="secondary" size="s" content="Optional" />
</Layout.Stack>
</Table.Cell>
<Table.Cell {root}>@</Table.Cell>
<Table.Cell {root}>
<InteractiveText variant="copy" isVisible text={`0 issue "certainly.com"`} />
</Table.Cell>
</Table.Row.Base>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider making the CAA record value configurable.

Similar to the comment in cnameTable.svelte, the CAA record value should be configurable rather than hardcoded.

Consider using a configuration variable:

 <Table.Cell {root}>
-    <InteractiveText variant="copy" isVisible text={`0 issue "certainly.com"`} />
+    <InteractiveText variant="copy" isVisible text={$regionalConsoleVariables._APP_DOMAIN_CAA_RECORD || `0 issue "certainly.com"`} />
 </Table.Cell>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<Table.Row.Base {root}>
<Table.Cell {root}>
<Layout.Stack direction="row" alignItems="center" gap="xs">
CAA
<Badge variant="secondary" size="s" content="Optional" />
</Layout.Stack>
</Table.Cell>
<Table.Cell {root}>@</Table.Cell>
<Table.Cell {root}>
<InteractiveText variant="copy" isVisible text={`0 issue "certainly.com"`} />
</Table.Cell>
</Table.Row.Base>
<Table.Row.Base {root}>
<Table.Cell {root}>
<Layout.Stack direction="row" alignItems="center" gap="xs">
CAA
<Badge variant="secondary" size="s" content="Optional" />
</Layout.Stack>
</Table.Cell>
<Table.Cell {root}>@</Table.Cell>
<Table.Cell {root}>
<InteractiveText
variant="copy"
isVisible
text={$regionalConsoleVariables._APP_DOMAIN_CAA_RECORD || `0 issue "certainly.com"`}
/>
</Table.Cell>
</Table.Row.Base>

</Table.Root>
<Layout.Stack gap="s" direction="row" alignItems="center">
{#if variant === 'cname'}
{#if variant === 'cname' && !isSubDomain}
<Alert.Inline>
If your domain uses CAA records, ensure certainly.com is authorized — otherwise, SSL
setup may fail. A list of all domain providers and their DNS setting is available <Link
variant="muted"
external
href="https://appwrite.io/docs/advanced/platform/custom-domains">here</Link
>.
Since <Badge variant="secondary" size="s" content={domain} /> is an apex domain, CNAME
record is only supported by certain providers. If yours doesn't, please verify using
<Link variant="muted" on:click={onNavigateToNameservers}>nameservers</Link> instead.
</Alert.Inline>
{:else}
<Typography.Text variant="m-400" color="--fgcolor-neutral-secondary">
Expand Down
2 changes: 1 addition & 1 deletion src/routes/(console)/organization-[organization]/domains/domain-[domain]/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
Navigate to your domain provider and update the nameservers to <InlineCode
code="ns1.appwrite-dns.com"
size="s" /> and <InlineCode code="ns2.appwrite-dns.com" size="s" />.
Note that DNS changes may take time to propagate fully.
Note that DNS changes may take up to 48 hours to propagate fully.
</span>
<svelte:fragment slot="actions">
<Button
Expand Down
12 changes: 7 additions & 5 deletions ...]-[project]/functions/function-[function]/domains/add-domain/verify-[domain]/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
import Wizard from '$lib/layout/wizard.svelte';
import { base } from '$app/paths';
import { writable } from 'svelte/store';
import { isASubdomain } from '$lib/helpers/tlds';
import NameserverTable from '$lib/components/domains/nameserverTable.svelte';
import RecordTable from '$lib/components/domains/recordTable.svelte';
import { regionalConsoleVariables } from '$routes/(console)/project-[region]-[project]/store';
Expand All @@ -29,11 +28,10 @@

const ruleId = page.url.searchParams.get('rule');
const domainId = page.url.searchParams.get('domain');
const isSubDomain = $derived.by(() => isASubdomain(page.params.domain));

let selectedTab = $state<'cname' | 'nameserver' | 'a' | 'aaaa'>('nameserver');
$effect(() => {
if ($regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME && isSubDomain) {
if ($regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME) {
selectedTab = 'cname';
} else if (!isCloud && $regionalConsoleVariables._APP_DOMAIN_TARGET_A) {
selectedTab = 'a';
Expand Down Expand Up @@ -124,7 +122,7 @@
<Layout.Stack gap="xl">
<div>
<Tabs.Root variant="secondary" let:root>
{#if isSubDomain && !!$regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME && $regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME !== 'localhost'}
{#if !!$regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME && $regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME !== 'localhost'}
<Tabs.Item.Button
{root}
on:click={() => (selectedTab = 'cname')}
Expand Down Expand Up @@ -162,7 +160,11 @@
{#if selectedTab === 'nameserver'}
<NameserverTable domain={page.params.domain} {verified} />
{:else}
<RecordTable domain={page.params.domain} {verified} variant={selectedTab} />
<RecordTable
domain={page.params.domain}
{verified}
variant={selectedTab}
onNavigateToNameservers={() => (selectedTab = 'nameserver')} />
{/if}
<Divider />
<Layout.Stack direction="row" justifyContent="flex-end">
Expand Down
12 changes: 7 additions & 5 deletions ...sole)/project-[region]-[project]/settings/domains/add-domain/verify-[domain]/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
import Wizard from '$lib/layout/wizard.svelte';
import { base } from '$app/paths';
import { writable } from 'svelte/store';
import { isASubdomain } from '$lib/helpers/tlds';
import NameserverTable from '$lib/components/domains/nameserverTable.svelte';
import RecordTable from '$lib/components/domains/recordTable.svelte';
import { regionalConsoleVariables } from '$routes/(console)/project-[region]-[project]/store';
Expand All @@ -29,12 +28,11 @@

const ruleId = page.url.searchParams.get('rule');
const domainId = page.url.searchParams.get('domain');
const isSubDomain = $derived.by(() => isASubdomain(page.params.domain));

let selectedTab = $state<'cname' | 'nameserver' | 'a' | 'aaaa'>('nameserver');

$effect(() => {
if ($regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME && isSubDomain) {
if ($regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME) {
selectedTab = 'cname';
} else if (!isCloud && $regionalConsoleVariables._APP_DOMAIN_TARGET_A) {
selectedTab = 'a';
Expand Down Expand Up @@ -126,7 +124,7 @@
<Layout.Stack gap="xl">
<div>
<Tabs.Root variant="secondary" let:root>
{#if isSubDomain && !!$regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME && $regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME !== 'localhost'}
{#if !!$regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME && $regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME !== 'localhost'}
<Tabs.Item.Button
{root}
on:click={() => (selectedTab = 'cname')}
Expand Down Expand Up @@ -164,7 +162,11 @@
{#if selectedTab === 'nameserver'}
<NameserverTable domain={page.params.domain} {verified} />
{:else}
<RecordTable domain={page.params.domain} {verified} variant={selectedTab} />
<RecordTable
domain={page.params.domain}
{verified}
variant={selectedTab}
onNavigateToNameservers={() => (selectedTab = 'nameserver')} />
{/if}
<Divider />
<Layout.Stack direction="row" justifyContent="flex-end">
Expand Down
9 changes: 4 additions & 5 deletions ...ject-[region]-[project]/sites/site-[site]/domains/add-domain/verify-[domain]/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,18 @@
import Wizard from '$lib/layout/wizard.svelte';
import { base } from '$app/paths';
import { writable } from 'svelte/store';
import { isASubdomain } from '$lib/helpers/tlds';
import RecordTable from '$lib/components/domains/recordTable.svelte';
import NameserverTable from '$lib/components/domains/nameserverTable.svelte';
import { regionalConsoleVariables } from '$routes/(console)/project-[region]-[project]/store';

let { data } = $props();

const ruleId = page.url.searchParams.get('rule');
const isSubDomain = $derived.by(() => isASubdomain(page.params.domain));

let selectedTab = $state<'cname' | 'nameserver' | 'a' | 'aaaa'>('nameserver');

$effect(() => {
if ($regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME && isSubDomain) {
if ($regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME) {
selectedTab = 'cname';
} else if (!isCloud && $regionalConsoleVariables._APP_DOMAIN_TARGET_A) {
selectedTab = 'a';
Expand Down Expand Up @@ -123,7 +121,7 @@
<Layout.Stack gap="xl">
<div>
<Tabs.Root variant="secondary" let:root>
{#if isSubDomain && !!$regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME && $regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME !== 'localhost'}
{#if !!$regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME && $regionalConsoleVariables._APP_DOMAIN_TARGET_CNAME !== 'localhost'}
<Tabs.Item.Button
{root}
on:click={() => (selectedTab = 'cname')}
Expand Down Expand Up @@ -165,7 +163,8 @@
{verified}
service="sites"
variant={selectedTab}
domain={page.params.domain} />
domain={page.params.domain}
onNavigateToNameservers={() => (selectedTab = 'nameserver')} />
{/if}
<Divider />
<Layout.Stack direction="row" justifyContent="flex-end">
Expand Down
3 changes: 2 additions & 1 deletion ...es/(console)/project-[region]-[project]/sites/site-[site]/domains/retryDomainModal.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,8 @@
{verified}
service="sites"
variant={selectedTab}
domain={selectedProxyRule.domain} />
domain={selectedProxyRule.domain}
onNavigateToNameservers={() => (selectedTab = 'nameserver')} />
{/if}

<svelte:fragment slot="footer">
Expand Down