Skip to content

Commit

Permalink
Merge pull request #37 from Bananalolok/patch-1
Browse files Browse the repository at this point in the history
Update docs to add new NS, CAA and SRV records and add FAQ About who are allowed to use NS records
  • Loading branch information
orangci authored Oct 20, 2024
2 parents 5c5fee2 + d4001a5 commit fddb05b
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 3 deletions.
64 changes: 62 additions & 2 deletions src/docs/domain-structure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ All the filenames below meet all the criteria. The reason in parentheses is just
},
"record": {
"URL": "https://www.is-a.dev/docs"
}
},
"proxied": false
}
```

Expand Down Expand Up @@ -75,7 +76,10 @@ This section is where you specify the DNS records. The supported types are:
- `URL`
- `MX`
- `TXT`

- `SRV`
- `CAA`
- `NS` (NS records will only be given to users with a [genuine need for them who are trusted users.](https://is-a.dev/docs/faq/))

Below are some examples for the given record types:

- **CNAME** record: This must be a hostname (`something.tld`). It cannot be used in conjunction with any other record types. This is typically used to map your domain to a specific server.
Expand Down Expand Up @@ -144,3 +148,59 @@ Below are some examples for the given record types:
}
}
```
- **NS** record: This must be a list of hostnames. These hostnames specify the authoritative DNS servers for your domain.
```json
{
"record": {
"NS": [
"ns1.example.com",
"ns2.example.com"
]
}
}
```
Note: Please refer to the [frequently asked questions](https://is-a.dev/docs/faq/) for clarification on what or who we allow NS records for.

- **SRV** record: This must be a list of service records. Each record specifies the priority, weight, port, and target for a service on your domain. SRV records are often used for services such as VoIP, messaging, and more.
```json
{
"record": {
"SRV": [
{
"priority": 10,
"weight": 5,
"port": 8080,
"target": "srv.example.com"
},
{
"priority": 20,
"weight": 10,
"port": 9090,
"target": "srv2.example.com"
}
]
}
}
```
- **CAA** record: This must be a list of Certification Authority Authorization (CAA) records. Each record specifies the authority permitted to issue SSL certificates for your domain, with fields for `flags`, `tag`, and `value`.
```js
{
"record": {
"CAA": [
{
"flags": 0,
"tag": "issue",
"value": "letsencrypt.org"
},
{
"flags": 0,
"tag": "issuewild",
"value": "comodoca.com"
}
]
}
}
```

### proxied (*optional*)
Enable Cloudflare proxy for your domain. Disabled by default.
17 changes: 16 additions & 1 deletion src/docs/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ We support the following records:
- CNAME
- MX
- TXT
- URL (Redirection)
- URL (redirection)
- NS (limited access)
- SRV
- CAA

## Why does my domain still redirect to the is-a-dev website?
This usually occurs due to the cache of your browser becoming invalid and [clearing your browser's cache](https://support.google.com/accounts/answer/32050) should solve this issue.
Expand Down Expand Up @@ -45,6 +48,18 @@ Please open a help thread via any of our help channels and we will look into it.
## Can I use my domain for a minecraft server?
Sure, but it needs to be a nested subdomain (mc.example.is-a.dev). You would normally use a A record for this.

## Can I use NS records?
We allow NS records for the following reasons and users:
- is-a.dev maintainers
- Users who are using **multiple** Cloudflare (or similar providers') services, which often require their own zones (e.g., DynDNS, cloudflared tunnels, etc.)
- Users who require a private zone, as they are using their home IP addresses behind Cloudflare (These cases will be carefully reviewed, as we understand some may claim to use a home IP address when they are not.)
- Users with a lot of nested subdomains *may* be allowed to register NS records so they do not have to manage multiple files.
- Aternos users (specifically Aternos, as they require NS records and you cannot modify DNS records under them).

Note: These guidelines are not set in stone and may change. You are not limited to fitting only one of the criteria above; use them as a general guide. [@wdhdev](https://github.com/wdhdev) personally review each NS record request.

*We reserve the right to deny NS records at our discretion.*

## How can I make changes to my is-a.dev subdomain?

1. **Open your JSON file:** Navigate to the `domains` directory in your local repository and open the JSON file corresponding to your subdomain (`domains/<subdomain>.json`).
Expand Down

0 comments on commit fddb05b

Please sign in to comment.