Skip to content

Update custom domain publishing approach #3917

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

Merged
backspace merged 21 commits into from
Jan 29, 2026
Merged

Update custom domain publishing approach #3917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
828469c
Change override to use permissions over user
backspace Jan 28, 2026
d2e64bf
Add teal paper domain
backspace Jan 28, 2026
c0aec22
Merge remote-tracking branch 'origin/main' into server/override-publi…
backspace Jan 28, 2026
d240409
Add UI for override
backspace Jan 28, 2026
f2c65a2
Fix import order
backspace Jan 28, 2026
e30523e
Change mapping to use base realm URL
backspace Jan 28, 2026
9e9655e
Fix lint errors
backspace Jan 28, 2026
10d8835
Add environment variable for more overrides
backspace Jan 28, 2026
9696704
Add variable to host config
backspace Jan 28, 2026
43c21de
Fix types in parsing
backspace Jan 28, 2026
1fa17f1
Extract handling into contained helper
backspace Jan 28, 2026
54da3b0
Fix lint error
backspace Jan 28, 2026
f49235e
Update colours of override warning
backspace Jan 28, 2026
4be20c6
Add lint autofix
backspace Jan 28, 2026
9aa4efc
Merge branch 'main' into server/override-publish-cs-10117
backspace Jan 29, 2026
fab1e03
Update handling on both sides
backspace Jan 29, 2026
b18f115
Add formatting autofix
backspace Jan 29, 2026
b41e9b9
Fix type error
backspace Jan 29, 2026
2237359
Merge remote-tracking branch 'origin/main' into server/override-publi…
backspace Jan 29, 2026
13975e5
Add formatting autofixes
backspace Jan 29, 2026
a522c04
Move overrides entirely into environment variables
backspace Jan 29, 2026
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
176 changes: 176 additions & 0 deletions packages/host/app/components/operator-mode/publish-realm-modal.gts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ import {
import { not } from '@cardstack/boxel-ui/helpers';
import { IconX, Warning as WarningIcon } from '@cardstack/boxel-ui/icons';

import { ensureTrailingSlash } from '@cardstack/runtime-common';
import { getPublishedRealmDomainOverrides } from '@cardstack/runtime-common/constants';

import ModalContainer from '@cardstack/host/components/modal-container';
import PrivateDependencyViolationComponent from '@cardstack/host/components/operator-mode/private-dependency-violation';
import WithLoadedRealm from '@cardstack/host/components/with-loaded-realm';
Expand Down Expand Up @@ -221,6 +224,65 @@ export default class PublishRealmModal extends Component<Signature> {
return config.publishedRealmBoxelSiteDomain;
}

// TODO: Remove with CS-9061 once published realm domain overrides are removed.
private getPublishedRealmOverrideUrl(
publishedRealmURL: string | null,
): string | null {
let overrideDomain = getPublishedRealmDomainOverrides(
config.publishedRealmDomainOverrides,
)[ensureTrailingSlash(this.currentRealmURL)];
if (!overrideDomain) {
return null;
}

if (!publishedRealmURL) {
return null;
}

let overriddenURL = new URL(publishedRealmURL);
overriddenURL.host = overrideDomain;
Comment on lines +242 to +243
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot Jan 29, 2026

Choose a reason for hiding this comment

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

P2 Badge Parse override host before assigning to URL.host

The override value is fed directly into URL.host, but overrides can come from env JSON and the server-side parser explicitly accepts full URLs (e.g. https://whitepaper.boxel.ai). If the override includes a scheme, overriddenURL.host = overrideDomain produces a malformed URL like https://https/, which then shows a broken URL in the modal and causes publish requests to fail for those overrides. Consider parsing/normalizing the override string to hostname/port (or stripping scheme) before assigning it to host.

Useful? React with 👍 / 👎.

return ensureTrailingSlash(overriddenURL.toString());
}

get customSubdomainOverrideUrl() {
let publishedRealmURL =
this.claimedDomainPublishedUrl ??
this.buildPublishedRealmUrl(
`${this.customSubdomainDisplay}.${this.customSubdomainBase}`,
);
return this.getPublishedRealmOverrideUrl(publishedRealmURL);
}

get shouldShowCustomSubdomainOverride() {
return (
!!this.customSubdomainOverrideUrl &&
this.realm.canWrite(this.currentRealmURL)
);
}

get isCustomSubdomainOverrideSelected() {
if (!this.customSubdomainOverrideUrl) {
return false;
}
return this.selectedPublishedRealmURLs.includes(
this.customSubdomainOverrideUrl,
);
}

get isCustomSubdomainOverridePublished() {
if (!this.customSubdomainOverrideUrl) {
return false;
}
return this.hostModeService.isPublished(this.customSubdomainOverrideUrl);
}

get customSubdomainOverrideLastPublishedTime() {
if (!this.customSubdomainOverrideUrl) {
return null;
}
return this.getFormattedLastPublishedTime(this.customSubdomainOverrideUrl);
}

get customSubdomainDisplay() {
if (this.claimedDomain) {
return this.claimedDomain.subdomain;
Expand Down Expand Up @@ -458,6 +520,20 @@ export default class PublishRealmModal extends Component<Signature> {
}
}

@action
toggleCustomSubdomainOverride(event: Event) {
const overrideUrl = this.customSubdomainOverrideUrl;
if (!overrideUrl) {
return;
}
const input = event.target as HTMLInputElement;
if (input.checked) {
this.addPublishedRealmUrl(overrideUrl);
} else {
this.removePublishedRealmUrl(overrideUrl);
}
}

private addPublishedRealmUrl(url: string) {
if (!this.selectedPublishedRealmURLs.includes(url)) {
this.selectedPublishedRealmURLs = [
Expand Down Expand Up @@ -619,6 +695,13 @@ export default class PublishRealmModal extends Component<Signature> {
return this.getPublishErrorForUrl(this.claimedDomainPublishedUrl);
}

get publishErrorForCustomSubdomainOverride() {
if (!this.customSubdomainOverrideUrl) {
return null;
}
return this.getPublishErrorForUrl(this.customSubdomainOverrideUrl);
}

ensureInitialSelectionsTask = restartableTask(
async (claim: ClaimedDomain | null = null) => {
await this.realm.ensureRealmMeta(this.currentRealmURL);
Expand Down Expand Up @@ -1027,6 +1110,99 @@ export default class PublishRealmModal extends Component<Signature> {
</div>
{{/if}}
</div>

{{#if this.shouldShowCustomSubdomainOverride}}
{{#let this.customSubdomainOverrideUrl as |overrideUrl|}}
{{#if overrideUrl}}
<div class='domain-option'>
<input
type='checkbox'
id='custom-subdomain-override-checkbox'
class='domain-checkbox'
checked={{this.isCustomSubdomainOverrideSelected}}
{{on 'change' this.toggleCustomSubdomainOverride}}
data-test-custom-subdomain-override-checkbox
disabled={{this.isUnpublishingAnyRealms}}
/>
<label
class='option-title'
for='custom-subdomain-override-checkbox'
>Custom Domain Override</label>
<div class='domain-details'>
<WithLoadedRealm
@realmURL={{this.currentRealmURL}}
as |realm|
>
<RealmIcon @realmInfo={{realm.info}} class='realm-icon' />
</WithLoadedRealm>
<div class='domain-url-container'>
<span class='domain-url'>{{overrideUrl}}</span>
{{#if this.isCustomSubdomainOverridePublished}}
<div class='domain-info'>
{{#if this.customSubdomainOverrideLastPublishedTime}}
<span class='last-published-at'>Published
{{this.customSubdomainOverrideLastPublishedTime}}</span>
{{/if}}
<BoxelButton
@kind='text-only'
@size='extra-small'
@disabled={{this.isUnpublishingRealm overrideUrl}}
class='unpublish-button'
{{on 'click' (fn @handleUnpublish overrideUrl)}}
data-test-unpublish-custom-subdomain-override-button
>
{{#if (this.isUnpublishingRealm overrideUrl)}}
<LoadingIndicator />
Unpublishing…
{{else}}
<Undo2
width='11'
height='11'
class='unpublish-icon'
/>
Unpublish
{{/if}}
</BoxelButton>
</div>
{{else}}
<span class='not-published-yet'>Not published yet</span>
{{/if}}
</div>
</div>
{{#if this.isCustomSubdomainOverridePublished}}
<BoxelButton
@as='anchor'
@kind='secondary-light'
@size='small'
@href={{overrideUrl}}
@disabled={{this.isUnpublishingAnyRealms}}
class='action'
target='_blank'
rel='noopener noreferrer'
data-test-open-custom-subdomain-override-button
>
<ExternalLink
width='16'
height='16'
class='button-icon'
/>
Open Site
</BoxelButton>
{{/if}}
{{#if this.publishErrorForCustomSubdomainOverride}}
<div
class='domain-publish-error'
data-test-domain-publish-error={{overrideUrl}}
>
<span
class='error-text'
>{{this.publishErrorForCustomSubdomainOverride}}</span>
</div>
{{/if}}
</div>
{{/if}}
{{/let}}
{{/if}}
</div>
</:content>

Expand Down
1 change: 1 addition & 0 deletions packages/host/app/config/environment.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ declare const config: {
};
publishedRealmBoxelSpaceDomain: string;
publishedRealmBoxelSiteDomain: string;
publishedRealmDomainOverrides: string;
defaultSystemCardId: string;
cardSizeLimitBytes: number;
};
Loading