Domains

To make your deployments available publicly you can either use a domain name (domain) generated by Northflank or associate your Services with your own domain names.

Types of domain names

While configuring your Services on Northflank you are likely to encounter the following types of domain names on the platform.

Northflank public domain names

To make a Service available online, you need to create a public port for it. Northflank will automatically generate a domain name and a TLS certificate for the service. The domain name will be accessible almost immediately.

Public domain names take the format:

[port-name].[service-name].[project-name].[account-name].northflank.app

You will also need this public domain name to associate your own domain name with a Service.

Northflank private domain names

To access a Service from other Services within the same Project, you create a private port. Northflank will assign a private, internal domain name based on the Service name. It is not accessible outside of your Project.

Private domain names take the format:

[service-name]:[port-number]

External domain names

You can associate your domain names managed by external DNS services with specific Service ports. You must have added and verified the domain name in your user or team account settings before adding it to a Service.

Adding a domain to Northflank

If you want to create a Deployment or Combined service accessible via your registered domain, you will need access to its DNS records. You can then add it to your team or user account.

Adding and verifying a domain

You can add any domain (for example yourdomain.com) or a subdomain (for example service.yourdomain.com) provided you have access to the DNS records.

  1. Navigate to your Account settings page
  2. Select the Domains tab
  3. Click Create new, enter your domain and click Add Domain
  4. You will now see an entry for your domain, which includes a hostname and a token. You will need to add the hostname and token to your DNS records as a text (TXT) record.
Verify Domain
  1. Open a new browser tab or window and navigate to your DNS provider
  2. Log in to your control panel and find the DNS settings for your domain
  3. Add a new text (TXT) record with the hostname and token specified in the entry you just generated for the domain on Northflank
  4. Return to the Northflank domains tab and select Verify on the entry for your domain
  5. Your domain should now be verified - if not, check you have entered the record correctly and try again
Domain Verified

Adding a subdomain

You can make different Services available on your domain by adding subdomains. You can create as many levels of subdomains as required (for example one.yourdomain.com or three.two.one.yourdomain.com).

  1. Navigate to your Account settings page
  2. Select the Domains tab
  3. Find the entry for the domain you wish to add a subdomain to
  4. Select add new in the list of subdomains
  5. Enter the name of the subdomain (this will be added to your domain name, for example one will create one.yourdomain.com) and Submit
  6. Your subdomain should now be created and you can associate it with a public port on a Service.
Subdomains

Adding a domain to a service

You can point your domains or subdomains at specific ports on Northflank Services. To do this, you will need to add your domain to a port entry on a Service and update your domain's DNS records accordingly. You can edit the port number after adding a domain to a port. If you edit the port name, you must update your DNS records to match the new Northflank public domain.

Follow these steps to add a subdomain (subdomain.yourdomain.com) to a Service:

  1. Select your Project and the Service you want to add the domain to
You can only add domains to Combined or Deployment serviced.
  1. Open the Networking tab and edit your port entries
  2. Choose an existing public port, or create a new one (make sure the port number matches a port exposed by your container)
  3. Select the subdomain you want to associate with the port from the drop-down list (if you cannot see your subdomain, check the Domains tab in account settings to ensure that your domain has been verified, and the desired subdomain has been added)
  4. Open a new browser tab or window and navigate to your DNS provider
  5. Log in to your control panel and find the DNS settings for your domain
  6. Add a new CNAME record with the subdomain as the hostname and the public Northflank domain name generated by your service for the port as the destination address or value (the public Northflank domain will be listed in the public DNS entry for your port in the format

    [port-name].[service-name].[project-name].[account-name].northflank.app

  7. If you are able to, set your TTL (time to live) on your DNS host to 60 seconds, or as low as possible, to ensure your records update and direct to your Northflank Service as quickly as possible.
  8. Northflank will now generate DNS entries and TLS certificates for your subdomain
  9. Your service will be available on your subdomain as soon as your DNS host's entries have updated

Your domain should redirect to Northflank soon after saving.

note

To add a root domain, add two new CNAME records, one with `@` as the hostname and another with `www` as the hostname. For both of these, add the public Northflank domain name generated by your service for the port as the destination address or value.


The public Northflank domain will be listed in the public DNS entry for your port in this format:

[port-name].[service-name].[project-name].[account-name].northflank.app

Removing a domain from a service or account

If you remove a domain from your Northflank account you will need to verify it again if you add it back later. If you remove a verified domain you should remove the associated text entry in your DNS records. This isn't necessary but may reduce confusion if you add the domain back later.

If you want to move your domain or subdomain to another Service, another port entry, or if you change your port name, you have to update your DNS records.

Removing a domain from a service

  1. Select your Project and the Service that contains the port linked to your domain
  2. Open the Networking tab and edit your port entries
  3. Select the x next to the entry for the domain you wish to remove (alternatively you can remove the entire port or make it private)
  4. Update and redeploy
  5. Update or remove the associated CNAME entry in your DNS records

Removing a domain or subdomain from your Northflank account

  1. Navigate to your Account settings page
  2. Select the Domains tab
  3. Select the Trash icon on the entry for the domain name you want to remove
  4. (Recommended) Remove the text entry in yo

DNS hosts

In the following guides, we explain how to add domains or subdomains from popular DNS hosting services to Northflank.

Cloudflare

If you manage your domain through Cloudflare, you can configure it by following these instructions. You can also read Cloudflare's documentation

for more platform specific information.

Add and verify your Cloudflare domain

  1. Add your domain to Northflank
  2. Open Cloudflare in a new browser tab or window and log in to your Cloudflare dashboard
  3. Select the domain you are adding to Northflank
  4. Select the DNS tab and Add record
  5. Open the Type dropdown and scroll down to choose TXT
  6. Copy or input the hostname from Northflank into the Name field
  7. Set the TTL (time to live) to 2 minutes (you can select a higher value, but it might take longer to register changes)
  8. Copy or input the value from Northflank into the Content field and Save the record
Cloudflare Verify Domain on Northflank
  1. Return to the Northflank domains tab and select Verify on the entry for your domain
  2. Your domain should now be verified and appearin your domain card. If not, check you have entered the record correctly and try again.

Add a Cloudflare domain to a service

  1. Add a subdomain to Northflank or use your root domain
  2. Open Cloudflare in a new browser tab or window and log in to your Cloudflare dashboard
  3. Select the domain you are adding to Northflank
  4. Select the DNS tab and Add record
  5. Open the Type dropdown and scroll down to choose CNAME
  6. Enter the subdomain in the Name field
  7. Enter the public Northflank domain from your Service's public port in the Target field:

    [port-name].[service-name].[project-name].[account-name].northflank.app

  8. If possible, set your TTL to 2 min, or the lowest possible value, to ensure your subdomain is available as soon as possible
Cloudflare Setup Domain on Northflank

Your domain should redirect to Northflank soon after saving.

note

As Cloudflare supports CNAME Flattening
you can simply add your root domain to a CNAME record to point it at Northflank

Namecheap

Add and verify your domain on Namecheap DNS

If you use one of Namecheap's BasicDNS, BackupDNS, PremiumDNS, or FreeDNS services, you can configure your domain by following these instructions. You can also read Namecheap's documentation

for more platform specific information.

  1. Add your domain to Northflank
  2. Open Namecheap in a new browser tab or window and log in to your Namecheap dashboard
  3. Open the Domain List and select Manage on the entry for the domain you are adding to Northflank
  4. Select Advanced DNS add and select Add new record
  5. Open the Type dropdown and scroll down to choose TXT
  6. Copy or input the hostname from Northflank into the Host field
  7. Copy or input the value from Northflank into the Value field
  8. Set the TTL (time to live) to 1 minute (you can select a higher value, but it might take longer to register changes) and select Save all changes
  9. Return to the Northflank domains tab and select Verify on the entry for your domain
  10. Your domain should now be verified and appear in your domain card. If not, check you have entered the record correctly and try again.

Add and verify your domain on Namecheap Web Hosting DNS

If you use Namecheap's Web Hosting DNS to manage your domain name, you can configure it in cPanel by following these instructions. You can also read Namecheap's documentation

for more platform specific information.

  1. Add your domain to Northflank
  2. Open Namecheap in a new browser tab or window and log in to your Namecheap dashboard
  3. Open the Domain List and select All products from the drop-down list
  4. Hover over the Hosting icon that contains the domain you want to add and select Go to cPanel
  5. Locate the Domains section in cPanel and select Zone editor
  6. Select Manage on the entry for the domain you want to add
  7. Select Add record
  8. Copy or input the hostname from Northflank into the Name field
  9. Set the TTL (time to live) to 60 seconds (you can select a higher value, but it might take longer to register changes)
  10. Open the Type dropdown and scroll down to choose TXT
  11. Copy or input the value from Northflank into the Record field and select Save all changes
  12. Return to the Northflank domains tab and select Verify on the entry for your domain
  13. Your domain should now be verified and appear in your domain card. If not, check you have entered the record correctly and try again.

Add a domain on Namecheap DNS to a service

  1. Add a subdomain to Northflank or use your root domain
  2. Open Namecheap in a new browser tab or window and log in to your Namecheap dashboard
  3. Open the Domain List and select Manage on the entry for the domain you are adding to Northflank
  4. Select Advanced DNS add and select Add new record
  5. Open the Type dropdown and scroll down to choose CNAME
  6. Enter the subdomain in the Hostname field
  7. Enter the public Northflank domain from your Service's public port in the Value field:

    [port-name].[service-name].[project-name].[account-name].northflank.app

  8. Set your TTL to 1 min, or the lowest possible value, to ensure your subdomain is available as soon as possible

Your domain should redirect to Northflank soon after saving.

Add a domain on Namecheap Web Hosting DNS to a service

  1. Add a subdomain to Northflank or use your root domain
  2. Open Namecheap in a new browser tab or window and log in to your Namecheap dashboard
  3. Open the Domain List and select All products from the drop-down list
  4. Hover over the Hosting icon that contains the domain you want to add and select Go to cPanel
  5. Locate the Domains section in cPanel and select Zone editor
  6. Select Manage on the entry for the domain you want to add
  7. Select Add record
  8. Copy or input the hostname from Northflank into the Name field
  9. Set the TTL (time to live) to 60 seconds (you can select a higher value, but it might take longer to register changes)
  10. Open the Type dropdown and scroll down to choose CNAME
  11. Copy or input the value from Northflank into the Record field and select Save all changes

Your domain should redirect to Northflank soon after saving.

note

Namecheap does not support adding CNAME records for root domains. To point your root domain to Northflank add two new CNAME records, one with `@` as the Name and another with `www` as the Name. For both of these, add the public Northflank domain name generated by your Service for the port as the destination address or value.


The public Northflank domain will be listed in the public DNS entry for your port in this format:

[port-name].[service-name].[project-name].[account-name].northflank.app

OVH

If you manage your domain through OVH, you can configure it by following these instructions. You can also read OVH's documentation for more platform specific information.

Add and verify your OVH domain

  1. Add your domain to Northflank
  2. Open OVH in a new browser tab or window and log in to your OVHcloud Control Panel
  3. Navigate to Web Cloud - Domains and select the domain you are adding to Northflank
  4. Select the DNS zone tab and Add an entry
  5. Select TXT under Extended records
  6. Copy or input the hostname from Northflank into the Sub-domain field
  7. Set the TTL (time to live) to Personalised and 60 seconds (you can select a higher or default value, but it might take longer to register changes)
  8. Copy or input the value from Northflank into the Value field, click Next and Confirm to save the record
OVH Verify Domain on Northflank
  1. Return to the Northflank domains tab and select Verify on the entry for your domain
  2. Your domain should now be verified and appear in your domain card. If not, check you have entered the record correctly and try again.

Add a domain on OVH to a service

  1. Add a subdomain to Northflank or use your root domain
  2. Open OVH in a new browser tab or window and log in to your OVHcloud Control Panel
  3. Navigate to Web Cloud - Domains and select the domain you are adding to Northflank
  4. Select the DNS zone tab and Add an entry
  5. Select CNAME under Pointer records
  6. Enter the subdomain in the Sub-domain field
  7. Set the TTL (time to live) to Personalised and 60 seconds (you can select a higher or default value, but it might take longer to register changes)
  8. Enter the public Northflank domain from your Service's public port in the Target field:

    [port-name].[service-name].[project-name].[account-name].northflank.app

    and add a full stop at the end

    important

    You must add a full-stop (.) at the end of your target in OVH.

  9. Click Next and Confirm to save the record
OVH Setup Domain on Northflank

Your domain should redirect to Northflank soon after saving.

© 2020 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com