Skip to content

Commit

Permalink
docs: add screenshots to custom domain page
Browse files Browse the repository at this point in the history
  • Loading branch information
robinbraemer committed Feb 14, 2024
1 parent fd96611 commit a249ad6
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 14 deletions.
Binary file added .web/docs/guide/cname.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 10 additions & 14 deletions .web/docs/guide/domains.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Use a custom domain
# Use a custom domain <VPBadge>Always Free</VPBadge>

When you create a Connect Endpoint, it is automatically given a `play.minekube.net` sub-domain, based on the endpoint’s
name. This is great for testing and private servers, but when you want to go to full production you’ll want your
Expand All @@ -7,37 +7,33 @@ That’s where the Connect custom domains comes in.
Let’s set up the custom domain, first step: directing traffic to your
endpoint.

## Set a CNAME record
## Set a CNAME record <VPBadge>Option 1</VPBadge>

The simplest option for directing traffic to your endpoint is to create a CNAME record for your custom domain that
points at your `<endpoint>.play.minekube.net` host. For example, if you have a custom domain called `example.com` and an
endpoint called `mcserver`, then you can create a CNAME record for `example.com`‘s DNS that would look like:

```
CNAME @ mcserver.play.minekube.net
```
![cname.png](cname.png)

You’ll need to configure this with your DNS provider.
If you want to make a subdomain like `mc`, set the `Name` to: `mc`

You’ll need to configure this with your DNS provider. The example screenshot uses Cloudflare.

Now, accessing `example.com` will tell the DNS system to look up `mcserver.play.minekube.net` and return its results.

## Option 2: Set an SRV record
## Or, set an SRV record <VPBadge>Option 2</VPBadge>

If you want to use an SRV record instead of a CNAME, you can do that too. Use an SRV record if
you can’t use a CNAME record at the root of your domain anymore, because you have other records there (a website, for
example).

An SRV record for `example.com` would look like:

```
SRV @ _minecraft._tcp 0 5 25565 mcserver.play.minekube.net
```
![srv.png](srv.png)

| Type | Name | Service | Protocol | Priority | Weight | Port | Target |
|------|------|------------|----------|----------|--------|-------|----------------------------|
| SRV | @ | _minecraft | TCP | 0 | 5 | 25565 | mcserver.play.minekube.net |
If you want to make a subdomain like `mc`, append it like so in the `Name` field: `_minecraft._tcp.mc`

## Add your domain
## Add your domain <VPBadge>Do not forget!</VPBadge>

You'll need to go to the [Connect Dashboard](https://app.minekube.com) and add your domain to your endpoint.

Expand Down
Binary file added .web/docs/guide/srv.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a249ad6

Please sign in to comment.