Storefront Custom Domain

What it is

Configure a custom domain for your storefront

Who it's for

Workspace Owner

Access & Scope

Property	Value
Module	storefront
Personas	workspace-owner
Scope	Workspace-level
UI Location	Dashboard > Storefront > Settings > Custom Domain

| Status | active |

UI Location

Dashboard > Storefront > Settings > Custom Domain

How it works

The Storefront Custom Domain feature allows you to configure a custom domain name for your storefront. Here's how it works:

1. Domain Creation:

   • Add a custom domain to your storefront
   • Domain must be owned by you
   • Multiple domains can be added, but only one can be active at a time

2. Domain Verification:

   • System provides DNS instructions for domain verification
   • Add required DNS records to your domain's DNS settings
   • System verifies domain ownership automatically
   • Verification status: pending → verifying → verified

3. SSL Certificate:

   • After domain verification, SSL certificate can be issued
   • SSL certificate enables HTTPS for secure connections
   • Certificate is automatically managed by the system

4. Domain Activation:

   • Once verified and SSL certificate is issued, domain can be activated
   • Active domain becomes the primary domain for the storefront
   • Only one domain can be active at a time

5. Domain Status:

   • Pending: Domain added but not yet verified
   • Verifying: DNS verification in progress
   • Verified: Domain ownership verified, ready for SSL
   • Active: Domain is live and serving the storefront
   • Failed: Verification or SSL issuance failed
   • Disabled: Domain is disabled (not serving traffic)

6. Domain Management:

   • View all domains associated with the storefront
   • Disable active domains
   • Delete domains (with confirmation)
   • Re-activate previously active domains

Settings

The Storefront Custom Domain feature includes the following configuration options:

1. Domain Settings:

   • Domain name (e.g., store.example.com)
   • Domain status tracking
   • Verification status

2. DNS Configuration:

   • System provides specific DNS records to add
   • DNS instructions are displayed in the interface
   • Records must be added to domain's DNS provider

3. SSL Certificate Settings:

   • Automatic SSL certificate issuance after verification
   • Certificate renewal is handled automatically
   • Certificate status is displayed

4. Domain Activation:

   • Activate verified domain with SSL
   • Deactivate active domain
   • Switch between multiple domains

Permissions

Access to Storefront Custom Domain requires:

• store.manage: Required to view and manage custom domains

Default Access:

• Workspace Owner: Has full access to custom domain management
• Staff: Access depends on assigned role permissions. Typically, only workspace owners manage custom domains.

Note: Custom domain management is a sensitive operation that affects the public-facing URL of the storefront. Access is typically restricted to workspace owners.

Use Cases

1. Branded Storefront:

   • Use your own domain name instead of the default storefront domain
   • Create a professional branded experience
   • Improve brand recognition

2. Multiple Domains:

   • Add multiple domains for different regions or languages
   • Switch between domains as needed
   • Maintain multiple domain configurations

3. Domain Migration:

   • Migrate from one domain to another
   • Maintain storefront availability during migration
   • Test new domain before making it active

4. SSL Security:

   • Enable HTTPS for secure customer connections
   • Protect customer data during checkout
   • Improve SEO and customer trust

5. Subdomain Management:

   • Use subdomains (e.g., shop.example.com, store.example.com)
   • Organize multiple storefronts under one main domain
   • Maintain separate configurations per subdomain

Notes / Limits

1. Domain Ownership:

   • You must own the domain you want to use
   • Domain must be registered with a domain registrar
   • DNS access is required to add verification records

2. DNS Configuration:

   • DNS records must be added to your domain's DNS provider
   • DNS propagation can take up to 48 hours
   • Verification may fail if DNS records are incorrect

3. SSL Certificate:

   • SSL certificate is issued automatically after verification
   • Certificate issuance may take a few minutes
   • Certificate renewal is automatic

4. Active Domain:

   • Only one domain can be active at a time
   • Activating a new domain deactivates the previous one
   • Active domain serves all storefront traffic

5. Domain Deletion:

   • Deleting a domain is permanent
   • Confirmation is required before deletion
   • Deleted domains cannot be recovered

6. Domain Verification:

   • Verification requires adding specific DNS records
   • Records are provided by the system
   • Verification is automatic once DNS records are detected

7. Failed Verification:

   • If verification fails, check DNS records
   • Ensure DNS propagation is complete
   • Contact support if issues persist

8. Domain Status:

   • Status updates are automatic
   • Status changes may take a few minutes to reflect
   • Monitor status during setup process

9. Performance: Domain changes may take a few minutes to propagate. Allow time for DNS and SSL changes to take effect.

10. Support: For complex domain configurations or issues, contact support for assistance.

Changelog

Mon Jan 15 2024 02:00:00 GMT+0200 (Eastern European Standard Time)

• Initial documentation