Skip to content

Commit db27a1e

Browse files
authored
[docs] Refresh digital ocean provider docs (#3860)
## Done - [docs] Refresh digital ocean provider docs by clarifying which record types are supported, linking to the digital ocean docs, and calling out other relevant internal docs. - spelling correction - update docs for chicks-net as maintainer for digital ocean ## Meta (Automated in `.just/gh-process.just`.)
1 parent 986bc4c commit db27a1e

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

documentation/provider/digitalocean.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@ Example:
1616
```
1717
{% endcode %}
1818

19+
The [creds.json](../commands/creds-json.md#example-commands) page in the docs explains how you can generate this dynamically so you can pull the secret token from 1Password or the vault of your choosing.
20+
1921
## Metadata
22+
2023
This provider does not recognize any special metadata fields unique to DigitalOcean.
2124

2225
## Usage
26+
2327
An example configuration:
2428

2529
{% code title="dnsconfig.js" %}
@@ -34,10 +38,34 @@ D("example.com", REG_NONE, DnsProvider(DSP_DIGITALOCEAN),
3438
{% endcode %}
3539

3640
## Activation
37-
[Create Personal Access Token](https://cloud.digitalocean.com/account/api/tokens)
41+
42+
- [Create Personal Access Token](https://cloud.digitalocean.com/account/api/tokens)
43+
- [How to Create a Personal Access Token (documentation)](https://docs.digitalocean.com/reference/api/create-personal-access-token/)
3844

3945
Your access token must have access to create, read, update and delete domain records.
4046

47+
## Supported record types
48+
49+
The [API reference](https://docs.digitalocean.com/reference/api/digitalocean/#tag/Domain-Records) states that these record types are supported:
50+
51+
| Name | Description |
52+
| ----- | ----------- |
53+
| A | This record type is used to map an IPv4 address to a hostname. |
54+
| AAAA | This record type is used to map an IPv6 address to a hostname. |
55+
| CAA | As specified in RFC-6844, this record type can be used to restrict which certificate authorities are permitted to issue certificates for a domain. |
56+
| CNAME | This record type defines an alias for your canonical hostname (the one defined by an A or AAAA record). |
57+
| MX | This record type is used to define the mail exchanges used for the domain. |
58+
| NS | This record type defines the name servers that are used for this zone. |
59+
| TXT | This record type is used to associate a string of text with a hostname, primarily used for verification. |
60+
| SRV | This record type specifies the location (hostname and port number) of servers for specific services. |
61+
| SOA | This record type defines administrative information about the zone. Can only have ttl changed, cannot be deleted |
62+
63+
## Unsupported record types
64+
65+
This means that `ALIAS`, `DHCID`, `DNAME`, `DS`, `FRAME`, `HTTPS`, `LOC`, `OPENPGPKEY`, `PTR`, `SMIMEA`, `SSHFP`, `SVCB`, `TLSA`, `URL`, or `URL301` presumably **do not work** with Digital Ocean.
66+
67+
In 2025, the provider maintainer has confirmed that `ALIAS` and `LOC` records are rejected. The other ones that do not work are expected in this circumstance. `SPF` records are not a problem since they are turned into `TXT` record types.
68+
4169
## Limitations
4270

4371
- Digitalocean DNS doesn't support `;` value with CAA-records ([DigitalOcean documentation](https://www.digitalocean.com/docs/networking/dns/how-to/create-caa-records/))

documentation/provider/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ Providers in this category and their maintainers are:
407407
|[`CNR`](cnr.md)|@KaiSchwarz-cnic|
408408
|[`CSCGLOBAL`](cscglobal.md)|@Air-New-Zealand|
409409
|[`DESEC`](desec.md)|@D3luxee|
410-
|[`DIGITALOCEAN`](digitalocean.md)|@Deraen|
410+
|[`DIGITALOCEAN`](digitalocean.md)|@chicks-net|
411411
|[`DNSIMPLE`](dnsimple.md)|@onlyhavecans|
412412
|[`DNSMADEEASY`](dnsmadeeasy.md)|@vojtad|
413413
|[`DNSOVERHTTPS`](dnsoverhttps.md)|@mikenz|

0 commit comments

Comments
 (0)