Configure brand and domain

Your customers reach the platform under your domains, not EdgeX's. Each tenant has up to four:

Domain	Example	What it serves	Required
Console	cloud.yourcompany.com	The console your customers sign in to.	Yes
API	api.yourcompany.com	The API, for integrations that use API keys.	No
Docs	docs.yourcompany.com	The documentation for your customers, with your brand.	No
Org docs	org.docs.yourcompany.com	The documentation for your team: white label and administration.	No

The console does not need the API domain: it talks to the platform under its own domain. The API domain only matters if you or your customers integrate with the API directly.

Rules for the names

• The docs domain must start with docs., and the org docs domain with org.docs.. That prefix is how the platform tells a documentation site from a console, so a name like help.yourcompany.com is refused.
• The console domain must not start with docs. or org.docs., or visitors would get the documentation instead of the console.
• Each domain belongs to a single tenant.

Point the DNS

Before the domains are registered, each one must point to the platform:

Domain	Point it to
Console, docs and org docs	The platform's console address, given by EdgeX
API	The platform's API address, given by EdgeX

A CNAME record is the simplest way. Use an A record only if your DNS provider does not allow a CNAME on that name.

Certificates

There is nothing to upload. The certificate for each domain is issued automatically on the first visit, as soon as the DNS points to the platform and the domain is registered to your tenant. That first visit can take a few seconds longer. A domain that is not registered to any tenant never gets a certificate.

Register the domains

There is no screen for this in the console yet. Send the list of domains to EdgeX support, and they become active as soon as they are registered and the DNS points to the platform.

What your customers see

• The console under your console domain, with your brand.
• The Learn more links in the console open your docs domain. While you have none, they open the EdgeX documentation.
• The documentation under your docs domain, with your colors, logo and name.

Brand

Under construction

The part about colors, logo and sign-in banner is being written. Check back soon.