Connecting Your Domain

This document covers how to connect a domain to Airkit and white label a web url. In order to connect a domain to Airkit, there are a few configuration steps needed.

🚧

If using a custom domain in an application, whether it is a URL Domain or URL Route, that domain has to be compatible with https://letsencrypt.org/docs/certificate-compatibility/.

Create a CNAME record in your domain provider

Create a CNAME record for the domain with the following values:

usher.woodsidebikes.com -> app.airkit.com.

📘

The domain must be pointing to app.airkit.com first and propagated before moving on to the next step. Also, based on the realm of the Airkit organization, the url will differ:

US Realm:

app.airkit.com 

EU Realm:

app.airkit.eu 

APAC Realm:

app.airkit.com.au

The below is an example configuration for a domain hosted in Amazon AWS:

Creating a URL domain and URL Route

To add a URL Domain and a URL Route in Airkit, go to console.airkit.com to add a resource. 

To add a URL domain, under Resources click on +New and type a unique name to label the domain and select URL Domain in the capabilities drop down.

After selecting URL Domain, put in the custom domain name that was created when the CNAME was created. For example: usher.woodsidebikes.com. Airkit will then attempt to retrieve the certificate that was created.  The URL Domain will then be able to be used for canvas links and web launch URLs.

After adding a URL domain, add a URL Route resource. Under the Resources tab, Click on +New and type a unique name to label the route and select URL Route in the capabilities drop down.

Then select the URL domain that was created in the previous step. This will provide the ability to create a custom path on your domain (e.g. usher.woodsidebikes.com/c/order). 

Lastly, add a Custom URL key which give the ability to customize the URL the app will launch at.

Configure the domain in configuration builder

Go to Configuration Builder and look for Web Resource. This is where to configure what domain the application is hosted on. Find the URL Route that was created and select that URL Route as the web resource. 

Once published, the application will now use the white-labeled domain!

Further Reading

White labeling a domain provides a more branded experience for an application. Instead of users seeing app.airkit.com when sent a link, they will see a custom domain. For related information on publishing your application or connecting Twilio numbers, see below:

• Publishing Your Application
• Connecting Your Twilio Numbers to Airkit
• Using Profiles for Deployment settings and Configurations