Skip to main content

How Do I Use A Custom Domain?

This guide shows you how to use any domain name you already own, such as app.your-domain.com, with ngrok.

note

ngrok is not a domain registrar; you must already own a domain name to use it with ngrok.

1. Add your domain in ngrok​

On your dashboard's Domain page, click the New Domain button to add your domain to your ngrok account. After it's been added, you'll be given a CNAME value such as exampledata.otherdata.ngrok-cname.com. Copy this for the next step.

info

You can also add a domain via the ngrok API. The CNAME will be in the "cname_target" field of the response object.

2. Add the CNAME record to your domain​

In a new browser tab, navigate to your domain hosting provider's dashboard and create a CNAME record. (Check your provider's support content if you're unsure how to do this.) When configuring the record, use the following values:

  • type: CNAME
  • name: @
  • value: the CNAME value you copied from ngrok
Test your CNAME record

Using a tool like dig or nslookup, you can test your CNAME record in the terminal.

3. Start an endpoint using your domain​

To start an agent endpoint at your domain, run the following command in your terminal, replacing your-domain-here.example.com with the domain you added in the ngrok dashboard:

Loading…

Then you can access that TCP endpoint with:

Loading…