From ad9acc4963fdc754704eb3bc37dea6f8ed73cdda Mon Sep 17 00:00:00 2001 From: Ashish Date: Mon, 3 Jun 2024 20:49:01 +0545 Subject: [PATCH 1/3] Add guide for connecting ngrok to a GoDaddy custom domain --- docs/guides/Connecting-ngrok-to-GoDaddy | 33 +++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/guides/Connecting-ngrok-to-GoDaddy diff --git a/docs/guides/Connecting-ngrok-to-GoDaddy b/docs/guides/Connecting-ngrok-to-GoDaddy new file mode 100644 index 000000000..3e12f8864 --- /dev/null +++ b/docs/guides/Connecting-ngrok-to-GoDaddy @@ -0,0 +1,33 @@ +## Connecting ngrok to a GoDaddy Custom Domain + +This guide explains how to configure a custom domain in GoDaddy to work with ngrok. + +### Step 1: Log in to Your GoDaddy Account +1. Go to [GoDaddy.com](https://www.godaddy.com) and log in with your credentials. + +### Step 2: Access DNS Management +1. Click on your username in the upper right corner and select "My Products". +2. Find your domain in the list and click "DNS" or "Manage DNS" next to it. + +### Step 3: Add a CNAME Record +1. In the DNS Management page, scroll down to the "Records" section. +2. Click "Add" to create a new record. +3. Select "CNAME" from the Type dropdown menu. +4. In the "Host" field, enter the subdomain you want to use (e.g., `www`). +5. In the "Points to" field, enter the URL provided by ngrok (e.g., `your-subdomain.ngrok.io`). +6. Set the TTL to your desired value (default is fine). +7. Click "Save" to add the record. + +For more details, refer to [GoDaddy's guide on adding a CNAME record](https://www.godaddy.com/help/add-a-cname-record-19236). + +### Step 4: Configure ngrok +1. Download and set up ngrok from [ngrok.com](https://ngrok.com). +2. Run the following command to expose your local server to the internet using ngrok: + ```sh + ngrok http 80 + ``` +3. Note the forwarding URL provided by ngrok (e.g., `your-subdomain.ngrok.io`). + +### Step 5: Verify Your Domain +1. Open a browser and go to your custom domain (e.g., `www.yourdomain.com`). +2. It should now forward to your local server via ngrok. From 7294f231e6753ad3b6d5786f3a582e7208c1beee Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Wed, 31 Jul 2024 17:21:27 +0000 Subject: [PATCH 2/3] ci: apply automated fixes --- docs/using-ngrok-with/fastAPI.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/using-ngrok-with/fastAPI.md b/docs/using-ngrok-with/fastAPI.md index 570ea2959..a724a6195 100644 --- a/docs/using-ngrok-with/fastAPI.md +++ b/docs/using-ngrok-with/fastAPI.md @@ -7,7 +7,7 @@ title: FastAPI You can leverage the [ngrok-python](https://github.com/ngrok/ngrok-python) library to embed the ngrok agent in to FastAPI Applications. :::warning - ngrok-python and FastAPI libraries used in this example are sensitive to versions. Use of Virtual Environments is highly recommended +ngrok-python and FastAPI libraries used in this example are sensitive to versions. Use of Virtual Environments is highly recommended ::: ```sh From e53bc1be9510b586721c27bd8bd0070b4c093c3c Mon Sep 17 00:00:00 2001 From: Russ Savage Date: Tue, 6 Aug 2024 16:04:46 -0700 Subject: [PATCH 3/3] fix: updating godaddy guide Signed-off-by: Russ Savage --- docs/guides/Connecting-ngrok-to-GoDaddy | 33 -------------------- docs/guides/godaddy.mdx | 40 +++++++++++++++++++++++++ docs/guides/index.md | 1 + 3 files changed, 41 insertions(+), 33 deletions(-) delete mode 100644 docs/guides/Connecting-ngrok-to-GoDaddy create mode 100644 docs/guides/godaddy.mdx diff --git a/docs/guides/Connecting-ngrok-to-GoDaddy b/docs/guides/Connecting-ngrok-to-GoDaddy deleted file mode 100644 index 3e12f8864..000000000 --- a/docs/guides/Connecting-ngrok-to-GoDaddy +++ /dev/null @@ -1,33 +0,0 @@ -## Connecting ngrok to a GoDaddy Custom Domain - -This guide explains how to configure a custom domain in GoDaddy to work with ngrok. - -### Step 1: Log in to Your GoDaddy Account -1. Go to [GoDaddy.com](https://www.godaddy.com) and log in with your credentials. - -### Step 2: Access DNS Management -1. Click on your username in the upper right corner and select "My Products". -2. Find your domain in the list and click "DNS" or "Manage DNS" next to it. - -### Step 3: Add a CNAME Record -1. In the DNS Management page, scroll down to the "Records" section. -2. Click "Add" to create a new record. -3. Select "CNAME" from the Type dropdown menu. -4. In the "Host" field, enter the subdomain you want to use (e.g., `www`). -5. In the "Points to" field, enter the URL provided by ngrok (e.g., `your-subdomain.ngrok.io`). -6. Set the TTL to your desired value (default is fine). -7. Click "Save" to add the record. - -For more details, refer to [GoDaddy's guide on adding a CNAME record](https://www.godaddy.com/help/add-a-cname-record-19236). - -### Step 4: Configure ngrok -1. Download and set up ngrok from [ngrok.com](https://ngrok.com). -2. Run the following command to expose your local server to the internet using ngrok: - ```sh - ngrok http 80 - ``` -3. Note the forwarding URL provided by ngrok (e.g., `your-subdomain.ngrok.io`). - -### Step 5: Verify Your Domain -1. Open a browser and go to your custom domain (e.g., `www.yourdomain.com`). -2. It should now forward to your local server via ngrok. diff --git a/docs/guides/godaddy.mdx b/docs/guides/godaddy.mdx new file mode 100644 index 000000000..ab06adf70 --- /dev/null +++ b/docs/guides/godaddy.mdx @@ -0,0 +1,40 @@ +# Configuring GoDaddy DNS for ngrok Reserved Domains + +This guide explains how to configure a custom domain in GoDaddy to work with ngrok. + +The guide assumes that you have already [added a reserved domain](/guides/how-to-set-up-a-custom-domain/) in ngrok with a subdomain (e.g. myapp.example.com). + +::::note +GoDaddy does not support CNAMEs as apex records. An apex record is a DNS record at the root (or apex) of a DNS zone. For example, in the DNS zone example.com, an apex record also has the fully qualified name example.com (this is sometimes called a naked domain). By convention, the relative name '@' is used to represent apex records. + +You will need to use a subdomain (e.g. `www.example.com`) when using ngrok. +:::: + +## Step 1: Find your reserved domain in ngrok + +1. Log into the [ngrok Dashboard](https://dashboard.ngrok.com) and navigate to your domain in the [Domains section](https://dashboard.ngrok.com/cloud-edge/domains). +1. Click in your domain to open the details, and click on the "DNS Targets" link in the top table. This will provide you with the relevant CNAME values to use in later steps. + +## Step 2: Log in to Your GoDaddy Account & Access DNS Management + +1. Go to [GoDaddy.com](https://www.godaddy.com) and log in with your credentials. +1. Click on your username in the upper right corner and select "My Products". +1. Find your domain in the list and click "DNS" or "Manage DNS" next to it. + +## Step 3: Add a CNAME Record + +1. In the DNS Management page, scroll down to the "Records" section. +1. Click "Add" to create a new record. +1. Select "CNAME" from the Type dropdown menu. +1. In the "Host" field, enter the subdomain you want to use (e.g., `www` if your domain in ngrok is `www.example.com`). +1. In the "Points to" field, enter the CNAME provided by ngrok (e.g., `ptenvq2ejdlptgyr.5mql8tts8aeqxhrtv.ngrok-cname.com`). +1. Set the TTL to your desired value (default is fine). +1. Click "Save" to add the record. + +For more details, refer to [GoDaddy's guide on adding a CNAME record](https://www.godaddy.com/help/add-a-cname-record-19236). + +## Step 4: Verify the DNS Entries in ngrok + +1. Once you've configured the DNS records in GoDaddy, you can return to the ngrok dashboard and click the "Check Status" button on the bottom of the DNS Details page. It may take a few minutes to an hour for the DNS records to propagate. ngrok will continue to check at a regular interval after your domain is configured. Once you see a green checkmark, you are good to go. + +Finally, whenever you want to use your new domain in the ngrok agent, be sure to add `--domain your.domain.com` to the end of any command, such as `ngrok http 80 --domain your.domain.com`. diff --git a/docs/guides/index.md b/docs/guides/index.md index 1cd054b91..29d6f3bf3 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -38,3 +38,4 @@ Here you will find a set of guides to help you with common (and not so common) t | [Using Labels with ngrok Edges](/guides/using-labels-within-ngrok) | Learn how to use labels and tunnel groups with ngrok Cloud Edges | | [Using ngrok with IoT devices](/guides/device-gateway) | Learn how to remotely manage IoT devices using ngrok | | [Using Mutual TLS Authentication](/guides/using-tls-mutual-authentication) | Learn how to protect your endpoints with mutual TLS authentication (mTLS) using ngrok | +| [Configuring GoDaddy DNS for ngrok Reserved Domains](/guides/godaddy) | Learn how to configure GoDaddy DNS for ngrok Reserved Domains |