The HappyFox account name created during your account registration (company.happyfox.com) can be remapped to suit your custom domain requirements (support.companyname.com) or (department.companyname.com). All custom domains need to mandatorily have SSL certificates, which can be done either through custom configuration or using out of the box capability.
This article illustrates the procedure to set up custom domains in your HappyFox Service Desk account.
Available Plans: ✔️ Mighty ✔️ Fantastic ✔️ Enterprise ✔️ Enterprise Plus
Pre Requisite
An agent who intends to perform this action requires an account level permission Manage custom domain
Steps to setup custom domain
Navigate to Main menu > Manage > Custom Domains
The primary service portal along with other service portals (if any) would be listed. To get started, click Setup Custom Domain for the corresponding HappyFox Domain.
You would be able to access the Configure Custom Domain form
Configure Custom Domain Section
- You would see the HappyFox Domain of the chosen service portal. Eg. finance-acme.happyfox.com.
- For the above happyfox domain, enter the corresponding custom domain (e.g, [email protected]) in the Custom Domain Name field.
CName Verification
- The next step is to verify the CName.
- Click Copy to copy the CName record given and add the CName record in your DNS Settings.
- Once it is done, Click Verify Now
DNS configuration example
If your custom domain is support.yourorg.com and your happyfox account domain is yourorg.happyfox.com, then you have to set the following CNAME at yourorg.com DNS zone.
- CNAME name: support
- CNAME target: yourorg.happyfox.com
If your custom domain department-support.yourorg.com should be used to load a specific department's support page at department-yourorg.happyfox.com, then you have to set the following CNAME at yourorg.com DNS zone.
CNAME name: department-support
CNAME target: department-yourorg.happyfox.com
⚠ Note: Adding CNAME for HappyFox domain(s) is the only supported method to configure custom domain.
⚠ Note: If you are using Cloudflare as the network infrastructure provider, please set the CNAME record as DNS only and not DNS proxied by Cloudflare. This is because HappyFox is already on Cloudlfare.
Configure SSL for your Custom Domain
Choose the required mode in which you would like to setup the SSL Certificate
- Custom - Choose this setting if you would like to set up your own custom SSL certificate parameters.
- Cloudflare - Choose this setting if you would like HappyFox to provide it through Cloudflare.
SSL Certificate - Managed by Cloudflare
This feature is available for all US hosted accounts and on plans offered by HappyFox. To know your hosting location, click the ? icon at the top right corner on your agent profile.
- When this option is chosen, the SSL certificate is automatically managed by Cloudflare. SSL Certificate renewals are also done automatically by HappyFox.
- This feature is available on all plans and is offered by HappyFox.
- If your authoritative DNS has CAA records, please reach out to [email protected] to know the necessary CAA records in order to use Cloudflare SSL certificate.
SSL Certificate - Custom
- Private Key
- Primary Certificate
- Intermediary Certificate
-
Paste the respective certificates in .pem format into private key, primary and intermediate certificate boxes. The private keys must NOT be encrypted. If the SSL provider issued an encrypted SSL key, then please decrypt it and paste it.
-
Note: You can contact any SSL vendors like GoDaddy, Verisign, Rapid SSL, or any other popular vendors out there to purchase a certificate. If prompted, set server type as Apache while purchasing an SSL cert.
-
Verify the certificates.
-
On successful verification, the SSL gets enabled.
Once the info is added, click Validate
The Save button gets enabled ONLY after the following are done
- Successful CName verification
- SSL Certificate Validation (for custom SSL certificate)
Click Save to complete the custom domain configuration
Troubleshooting and FAQs
1. I am getting errors while doing Cname verification. What do I do?
If you haven't setup CNAME record on your DNS provider's control panel to point to the happyfox domian (<accountname>.happyfox.com)
2. Validation fails for custom SSL Validation. How can I fix this?
Here are some possible reasons for SSL failure.
- Certificates not in .pem format
- Private key is not valid
- Primary Certificate doesn’t match with private key
- Intermediary Certificate doesn’t match with primary certificate
- Primary Certificate doesn’t match with custom domain
- Primary Certificate has expired
3. Is SSL certificate mandatory for custom domains?
Yes, SSL certificates are mandatory for all websites. The browsers – led by Google and Mozilla – have mandated all sites be served with encryption via HTTPS. To accomplish this transition the browsers have created new security warnings. A Secure/Not Secure binary that labels sites based on their SSL implementation.
4. Which plans is it applicable to?
All Plans of HappyFox Service Desk
Conclusion
Custom domains are a great way to customize your service portals. This gives your requesters an opportunity to reach out for support in a safe, secure and customized environment.