diff --git a/content/external-domain-cloudflare-cname.md b/content/external-domain-cloudflare-cname.md new file mode 100644 index 0000000..c3277cc --- /dev/null +++ b/content/external-domain-cloudflare-cname.md @@ -0,0 +1,101 @@ ++++ +title = "Add an external domain with Cloudflare (CNAME Gateway)" +tags = ["external-domain"] +description_file = "descriptions/external-domain-cloudflare.txt" ++++ + +## Before purchasing a domain from Cloudflare + +As stated in §6.1 of Cloudflare’s [Domain Registration Agreement](https://www.cloudflare.com/domain-registration-agreement/), you must use Cloudflare’s nameservers for your root domain, hence adding it to playit.gg using NS record is not possible. However, if your tunnel utilises playit’s gateway feature, you can add it using a CNAME record, if not, please visit {{< link "external-domain-cloudflare" >}} to learn how to use NS records instead. + +This guide will show the steps of adding a subdomain using CNAME record to a gateway in your playit.gg account. In our example our domain is `playit-example.com`, for you this will likely be different. + + +### Requirements +* [playit premium](https://playit.gg/account/billing/shop/premium) +* You already purchased a domain name on https://domains.cloudflare.com/ +* [playit agent](https://playit.gg/download) version `>=0.17.0` +* Only **Minecraft Java Tunnel** or **HTTPs Tunnel** support gateway. + +For other Domain Registrars visit {{< link "add-external-domain" >}}. + +## 1. Add your domain to playit + +Visit your [account settings](https://playit.gg/account/settings/domains) and add your domain. + +Click on `Domains`, and then go to `Add External Domain`. Fill out your domain's information. + +**DO NOT** add NS records in Cloudfalre, just type your domain and submit. + +{{< image src="post-img/playit-addexternaldomain-cloudflare-cname-addexternaldomain.png" alt="playit add external domain" >}} + +Once you've done that, confirm your settings by clicking `Add Domain`. + +## 2a. Add a gateway to your account + +Visit your [account settings](https://playit.gg/account/details/gateways) and add your gateway. + +Click on `Add Gateway` to create a new gateway, next step you will be asked to select a region, select the one that is clostest to your server. You can also click on an existing gateway if you would like to add the domain to it. + +{{< image src="post-img/playit-addexternaldomain-cloudflare-cname-gateway-add.png" alt="playit add gateway" >}} + + +## 2b. Add a domain to your gateway + +After entering your gateway's setting page, you will see these two sections. + +{{< image src="post-img/playit-addexternaldomain-cloudflare-cname-gateway-view1.png" alt="playit view gateway" >}} + +In `Assigned Domains` section, click on `+ Add Domain`, select your domain. + +{{< image src="post-img/playit-addexternaldomain-cloudflare-cname-gateway-domain-add.png" alt="playit add gateway" >}} + +Domain is successfully added. Now copy the value shown in the `Setup External Domain` section, in this example we are using `3bdc719f0bfce73a.gw.playit-dns.com`, yours will be different. + +{{< image src="post-img/playit-addexternaldomain-cloudflare-cname-gateway-view2.png" alt="playit add gateway" >}} + +## 3. Visit your domain's management page + +Log in to the **Cloudflare Dashboard**, select your domain, and open the **DNS → Records** page. + +{{< image src="post-img/playit-addexternaldomain-cloudflare-managedns.png" alt="cloudflare manage dns" >}} + +## 4. Add CNAME record for the domain + +We will connect your domain to your playit.gg gateway using a **CNAME record**. + +Click on `+ Add Record`, create the following **CNAME record**: + +| Type | Name (might be different for you) | Target (use the value you just cpoied) | Proxy Status | TTL | +|:-|:-|:-|:-|:-| +| `CNAME` | `playit-example.com` | `3bdc719f0bfce73a.gw.playit-dns.com` | DNS Only | Auto | + +{{< image src="post-img/playit-addexternaldomain-cloudflare-cname-add_cname_record.png" alt="cloudflare manage cname add" >}} + +It should look like this after adding your CNAME record. + +{{< image src="post-img/playit-addexternaldomain-cloudflare-cname-view_cname_record.png" alt="cloudflare manage cname view" >}} + +## 5. Assign your gateway during tunnel creation + +Create a new **Minecraft Java Tunnel** or **HTTPs Tunnel** tunnel, at the `Public Endpoint` step, click on the `Gateways` tab, select the gateway you have just created, and finish the rest of the setup. + +{{< image src="post-img/playit-addexternaldomain-cloudflare-cname-gateway-assign.png" alt="playit assign gateway" >}} + +After that, your gateway is assigned to the new tunnel. + +## 6. (Optional) Check if the new domain is properly set up + +To do this, we can use something like [nslookup.io](https://nslookup.io/). + +Enter your domain, and then click **Find DNS records** + +{{< image src="post-img/playit-addexternaldomain-cloudflare-cname-check_ns-1.png" alt="check dns records" >}} + +Your result might be showing as A and AAAA record instead of CNAME record, click on the result IPs, if you see the name `Developed Methods LLC`, it is working correctly. + +{{< image src="post-img/playit-addexternaldomain-cloudflare-cname-check_ns-2.png" alt="check dns records" >}} + +--- + +After adding your domain, it can take up to 1 hour before the update is seen globally. Usually it's much quicker. diff --git a/content/external-domain-cloudflare.md b/content/external-domain-cloudflare.md index 10e8bc4..50f2db1 100644 --- a/content/external-domain-cloudflare.md +++ b/content/external-domain-cloudflare.md @@ -4,12 +4,16 @@ tags = ["external-domain"] description_file = "descriptions/external-domain-cloudflare.txt" +++ -Your root domain cannot be on both Cloudflare and Playit. Because your domain is setup with cloudflare, we will add a subdomain to your Playit account. In our example our domain is `playit-example.com` and the subdomain is `minecraft` so we'll be adding `minecraft.playit-example.com`. For you this will likely be different. +## Before purchasing a domain from Cloudflare + +As stated in §6.1 of Cloudflare’s [Domain Registration Agreement](https://www.cloudflare.com/domain-registration-agreement/), you must use Cloudflare’s nameservers for your root domain, hence adding it to playit.gg using NS record is not possible. However, if your tunnel utilises playit’s gateway feature, you can add it using a CNAME record, please visit {{< link "external-domain-cloudflare-cname" >}} for the steps. + +This guide will show the steps of adding a subdomain using NS record to your playit.gg account. In our example our domain is `playit-example.com` and the subdomain is `minecraft` so we'll be adding `minecraft.playit-example.com`, for you this will likely be different. ### Requirements * [playit premium](https://playit.gg/account/billing/shop/premium) -* your external domain setup **Cloudflare DNS** +* You already purchased a domain name on https://domains.cloudflare.com/ For other Domain Registrars visit {{< link "add-external-domain" >}}. @@ -30,25 +34,19 @@ Log in to the **Cloudflare Dashboard**, select your domain, and open the **DNS {{< image src="post-img/playit-addexternaldomain-cloudflare-managedns.png" alt="cloudflare manage dns" >}} ---- - ## 3. Add NS records for the sub domain We will delegate the sub domain to playit.gg using **NS records**. -Create **one NS record**: +Click on `+ Add Record`, create the following **NS records**: -### NS Record - -* **Type:** `NS` -* **Name:** `minecraft` (might be different for you) -* **Target:** `ns1.playit-dns.com` -* **TTL:** Auto +| Type | Name (might be different for you) | Nameserver | TTL | +|:-|:-|:-|:-| +| `NS` | `minecraft` | `ns1.playit-dns.com` | Auto | +| `NS` | `minecraft` | `ns2.playit-dns.com` | Auto | {{< image src="post-img/playit-addexternaldomain-cloudflare-add_ns_record.png" alt="cloudflare manage ns" >}} ---- - ## 4. Assign your domain to a tunnel Edit or create a new tunnel, and look at the top of the page. You should see an automatically assigned domain. Click on `Change domain`, and choose a domain from `Select a domain from your account`. @@ -57,9 +55,10 @@ Edit or create a new tunnel, and look at the top of the page. You should see an Once you've selected your domain, click on `use yourdomain.tld`. Again, your domain will be different. -## 5. Check if the new domain is properly set up +## 5. (Optional) Check if the new domain is properly set up + +To do this, we can use something like [nslookup.io](https://nslookup.io/). -To do this, we can use something like [nslookup.io](https://nslookup.io/) Enter your domain, and then click **Find DNS records** {{< image src="post-img/playit-addexternaldomain-cloudflare-check_ns-1.png" alt="check dns records" >}} diff --git a/static/post-img/playit-addexternaldomain-cloudflare-cname-add_cname_record.png b/static/post-img/playit-addexternaldomain-cloudflare-cname-add_cname_record.png new file mode 100644 index 0000000..7b1d751 Binary files /dev/null and b/static/post-img/playit-addexternaldomain-cloudflare-cname-add_cname_record.png differ diff --git a/static/post-img/playit-addexternaldomain-cloudflare-cname-addexternaldomain.png b/static/post-img/playit-addexternaldomain-cloudflare-cname-addexternaldomain.png new file mode 100644 index 0000000..fc18cad Binary files /dev/null and b/static/post-img/playit-addexternaldomain-cloudflare-cname-addexternaldomain.png differ diff --git a/static/post-img/playit-addexternaldomain-cloudflare-cname-check_ns-1.png b/static/post-img/playit-addexternaldomain-cloudflare-cname-check_ns-1.png new file mode 100644 index 0000000..81725c0 Binary files /dev/null and b/static/post-img/playit-addexternaldomain-cloudflare-cname-check_ns-1.png differ diff --git a/static/post-img/playit-addexternaldomain-cloudflare-cname-check_ns-2.png b/static/post-img/playit-addexternaldomain-cloudflare-cname-check_ns-2.png new file mode 100644 index 0000000..5914c32 Binary files /dev/null and b/static/post-img/playit-addexternaldomain-cloudflare-cname-check_ns-2.png differ diff --git a/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-add.png b/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-add.png new file mode 100644 index 0000000..81dfc7a Binary files /dev/null and b/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-add.png differ diff --git a/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-assign.png b/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-assign.png new file mode 100644 index 0000000..01510e6 Binary files /dev/null and b/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-assign.png differ diff --git a/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-domain-add.png b/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-domain-add.png new file mode 100644 index 0000000..0c3bacd Binary files /dev/null and b/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-domain-add.png differ diff --git a/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-view1.png b/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-view1.png new file mode 100644 index 0000000..d142bef Binary files /dev/null and b/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-view1.png differ diff --git a/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-view2.png b/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-view2.png new file mode 100644 index 0000000..8cd4f5d Binary files /dev/null and b/static/post-img/playit-addexternaldomain-cloudflare-cname-gateway-view2.png differ diff --git a/static/post-img/playit-addexternaldomain-cloudflare-cname-view_cname_record.png b/static/post-img/playit-addexternaldomain-cloudflare-cname-view_cname_record.png new file mode 100644 index 0000000..6efe0b8 Binary files /dev/null and b/static/post-img/playit-addexternaldomain-cloudflare-cname-view_cname_record.png differ