📚
Resources
👨💻 Developer Resources
Bring your own domain
Personalize your portal by bringing your own domain.
Introduction
Available in advanced plans on stable branch only.
Contact [email protected] for more information
By default QwykPortals will serve your portals instance as a self-chosen subdomain under qwykportals.com (or next.qwykportals.com) You can however elect to bind your own (sub-)domain and allow your visitor to access your portal using a URL they recognise as trusted.
A standard portals url with your own chosen prefix but our root.
A custom domain
We use CNAME records to accomplish this which will also allow us to generate an SSL certificate using Let's Encrypt's HTTP-01 ACME Challenge method:
A Canonical Name record (abbreviated as CNAME record) is a type of resource record in the Domain Name System (DNS) that maps one domain name (an alias) to another (the canonical name).[1]This can prove convenient when running multiple services (like an FTP server and a web server, each running on different ports) from a single IP address. One can, for example, point ftp.example.com and www.example.com to the DNS entry for example.com, which in turn has an A record which points to the IP address. Then, if the IP address ever changes, one only has to record the change in one place within the network: in the DNS A record for example.com.CNAME records must always point to another domain name, never directly to an IP address.
Goal
The goal of this guide is to setup domain alias to point to your QwykPortals instance so people can use that address to visit your portal.
What you'll need
Workflow
Choosing a domain name
We recommend choosing a domain name that's not too long and easy to remember for your customers. This can be for example: portal.your-domain.com, or any variant of
portal such as online or customers or we personally think my is really good. For the purposes of this guide we'll choose my.digitalfreight.company as the domain at which we'd like the portal to be available.
CNAME records pointing to the apex of a zone are not permitted:
If you decide to register a fresh domain, you need to remember that creating a CNAME record at the apex of your zone (i.e. example.com) is not permitted and your DNS provider will likely not accept you creating one. If they do let you continue, the alias is unlikely to work.
Add a CNAME record to your DNS settings
Follow the provided steps provided by your DNS provider, creating a CNAME record for the domain you chose in the first step pointing to:
hosting.qwykportals.com1
NAME TYPE VALUE
2
-----------------------------------------------------------------
3
my.digitalfreight.company. CNAME hosting.qwykportals.com.
Copied!
Guides for common DNS providers:
If your DNS provider is not listed, you can either check their support page or use a search engine to search for "How to create a CNAME record on [YOUR DOMAIN PROVIDER]"
Do not create A records
Traffic to portals is load balanced to a fleet of servers at multiple IPs and due to auto-scaling those IP addresses change frequently. We will not notify you of changes and so when pointing an A to portals, the domain may become unable to resolve. Always use CNAMEs as explained above.
Request domain configuration from Qwyk
Send a message to [email protected] with the current address of your portal site as well as the requested domain in the subject and revert once it has been setup.
To: [email protected] Subject: Domain Request mydigitalfreight.qwykportals.com > my.digitalfreight.company Hello,We've created a CNAME record for the requested domain to point to my.digitalfreight.company and would like you to activate the redirection.Thank you,
As we will add your domain to our hosting.qwykportals.com SSL certificate, the CNAME record needs to be created before you send us your request, and it may take a moment for changes to propagate.
Last modified 1mo ago