White Label and Custom Domain

Put your Report portal on your own domain, so the address your clients visit is yours.

You, your team, and your clients sign in on the same page, at the address that ends in /login. On the default Deepwell address, that page shows Deepwell branding. When your custom domain reads Activated, the page on your domain shows your Company Name and your colors in place of Deepwell. There is no logo setting.

Inside the portal, the sidebar reads "Powered by Deepwell." That is the only place that names Deepwell to your client, and you can contact Deepwell to remove it.

Both tasks on this page are optional, because your portal already works on the default Deepwell address, in Deepwell's colors. Only an MSP Admin can do them, and for the domain you'll also need access to the DNS settings for your domain. If you set up your domain, set your brand color too. See Email that Deepwell sends in your name.

How to set up your domain

The Domains page shows four stages across the top, Configure, DNS Setup, Provisioning, and Activated, so you can see where you are at any time.

1. Go to Domains, in the Admin menu.
2. Type the address. For reports.yourmsp.com, type reports in Subdomain (optional) and yourmsp.com in Root Domain. Deepwell recommends a subdomain, because the portal address needs a CNAME record, and many DNS providers don't allow a CNAME record on a root domain.
3. Select Continue to DNS Setup. Deepwell shows the DNS Records that it needs, each with its type, its Name, its Value, and a Status of Not checked. They are CNAME records: one for the portal address, one for the TLS certificate, and the others for email from your domain. See Email that Deepwell sends in your name.
4. At your DNS provider, add every record exactly as Deepwell shows it. Copy the name and the value from each row, or select Download Zone File if your DNS provider can import one.
5. In Deepwell, select Verify Records. Each record that Deepwell finds changes to Verified. A DNS change is usually effective in some minutes, though some DNS providers need up to 48 hours.
6. If a record stays Not verified, read the row under it. Expected is the record that Deepwell needs, and Found is the record that your DNS provider returned, which reads (empty) when there is none yet. Correct the record at your DNS provider, then select I've Fixed These Records.
7. When every record reads Verified, select Activate. Deepwell then issues the TLS certificate for your domain, which usually takes a few minutes. Select Check Provisioning Status to see if it is done.
8. When the page reaches Activated, your Report portal is on your domain.

How to control your domain

• Review the status at any time on the Domains page. The page shows the condition of each DNS record and the stage that your domain is in. Deepwell renews your TLS certificate automatically, so you won't need to activate it again.
• Start Over deletes the domain configuration, during setup or after it. Deepwell asks you to confirm with Yes, Start Over, and you can't undo it. Use it to change the address, because Deepwell then issues new DNS records for you to add. Use it also to stop using your domain, after which your portal goes back to the default address, and your email comes from Deepwell again. Tell your clients before you do either, because the links on your old domain will stop working.

How to set your brand color

The portal uses Deepwell's blue by default. You give Deepwell one color, and it makes the other portal colors from it: your color goes on the buttons, the links, and the focus outlines, while the sidebar gets darker and lighter shades of it. The sign-in page gets them too, on your custom domain only. Deepwell's own marks stay off the portal as before.

1. Go to Settings, in the Admin menu.
2. Under Branding, select the Primary Color swatch, and set the color in the picker that opens.
3. Select Save.

The picker is your browser's own, so its controls depend on the browser. You can set the color in any way that it offers, for example:

• A hex code, or RGB or HSL values.
• The eyedropper, to take a color from your screen, for example from your logo.
• The color field and the hue slider.

Your client sees the new color the next time they open the portal.

Two things to know before you select a color:

• Text on a button is always white, so use a color dark enough to read under it.
• You can't remove a saved color, but you can change it at any time. Before you save a change, select the revert control to go back to the saved color.

Email that Deepwell sends in your name

Deepwell sends two emails to your clients: the invitation to a contact, and the notice that a Report is ready when you deliver a Report Snapshot. Each one ends with "Sent by" and the name of your MSP, with or without your domain. For who gets the notice, see Who gets an email when a Report Snapshot is delivered.

Where the email comes from depends on your domain:

• Before your domain reads Activated, the email comes from Deepwell Support, in Deepwell's standard colors. Its links go to the default Deepwell address.
• When your domain reads Activated, the email comes from noreply@ and your portal address, for example noreply@reports.yourmsp.com, with the name of your MSP as the sender. It uses your brand colors, and its links go to your domain.

Deepwell changes your email to your domain when an MSP Admin opens the Domains page and the page reads Activated.

When your domain is active, save a brand color too. Until you save one, Deepwell can't send email for your MSP: an invitation by email fails, and Deepwell sends no notice when you deliver a Report Snapshot. See How to set your brand color.