|
| 1 | +## Configuration |
| 2 | + |
| 3 | +To use this provider, add an entry to `creds.json` with `TYPE` set to `GIDINET` |
| 4 | +along with your Gidinet account credentials. |
| 5 | + |
| 6 | +Example: |
| 7 | + |
| 8 | +{% code title="creds.json" %} |
| 9 | +```json |
| 10 | +{ |
| 11 | + "gidinet": { |
| 12 | + "TYPE": "GIDINET", |
| 13 | + "username": "your-gidinet-username", |
| 14 | + "password": "your-gidinet-password" |
| 15 | + } |
| 16 | +} |
| 17 | +``` |
| 18 | +{% endcode %} |
| 19 | + |
| 20 | +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. |
| 21 | + |
| 22 | +## Metadata |
| 23 | + |
| 24 | +This provider does not recognize any special metadata fields unique to Gidinet. |
| 25 | + |
| 26 | +## Usage |
| 27 | + |
| 28 | +### As DNS Provider only |
| 29 | + |
| 30 | +If you manage your domain registration elsewhere but want to use Gidinet for DNS: |
| 31 | + |
| 32 | +{% code title="dnsconfig.js" %} |
| 33 | +```javascript |
| 34 | +var REG_NONE = NewRegistrar("none"); |
| 35 | +var DSP_GIDINET = NewDnsProvider("gidinet"); |
| 36 | + |
| 37 | +D("example.com", REG_NONE, DnsProvider(DSP_GIDINET), |
| 38 | + A("test", "1.2.3.4"), |
| 39 | +); |
| 40 | +``` |
| 41 | +{% endcode %} |
| 42 | + |
| 43 | +### As both Registrar and DNS Provider |
| 44 | + |
| 45 | +If your domain is registered with Gidinet and you want to manage both nameserver delegation and DNS records: |
| 46 | + |
| 47 | +{% code title="dnsconfig.js" %} |
| 48 | +```javascript |
| 49 | +var REG_GIDINET = NewRegistrar("gidinet"); |
| 50 | +var DSP_GIDINET = NewDnsProvider("gidinet"); |
| 51 | + |
| 52 | +D("example.com", REG_GIDINET, DnsProvider(DSP_GIDINET), |
| 53 | + A("test", "1.2.3.4"), |
| 54 | +); |
| 55 | +``` |
| 56 | +{% endcode %} |
| 57 | + |
| 58 | +### As Registrar only (DNS hosted elsewhere) |
| 59 | + |
| 60 | +If your domain is registered with Gidinet but you want to use a different DNS provider: |
| 61 | + |
| 62 | +{% code title="dnsconfig.js" %} |
| 63 | +```javascript |
| 64 | +var REG_GIDINET = NewRegistrar("gidinet"); |
| 65 | +var DSP_OTHER = NewDnsProvider("cloudflare"); |
| 66 | + |
| 67 | +D("example.com", REG_GIDINET, DnsProvider(DSP_OTHER), |
| 68 | + A("test", "1.2.3.4"), |
| 69 | +); |
| 70 | +``` |
| 71 | +{% endcode %} |
| 72 | + |
| 73 | +When used as a registrar, Gidinet will manage the nameserver delegation at the registry level. |
| 74 | + |
| 75 | +## Activation |
| 76 | + |
| 77 | +1. Log in to the [Gidinet Control Panel](https://www.gidinet.com/) |
| 78 | +2. Your account credentials (username and password) are the same ones you use to log in to the control panel |
| 79 | + |
| 80 | +## Supported record types |
| 81 | + |
| 82 | +The Gidinet DNS API supports the following record types: |
| 83 | + |
| 84 | +| Name | Description | |
| 85 | +| ----- | ----------- | |
| 86 | +| A | IPv4 address record | |
| 87 | +| AAAA | IPv6 address record | |
| 88 | +| CNAME | Canonical name (alias) record | |
| 89 | +| MX | Mail exchange record | |
| 90 | +| NS | Name server record (subdomains only, apex NS managed by registrar) | |
| 91 | +| TXT | Text record | |
| 92 | +| SRV | Service record | |
| 93 | + |
| 94 | +## Unsupported record types |
| 95 | + |
| 96 | +The following record types are **not supported** by Gidinet: |
| 97 | + |
| 98 | +- `ALIAS` - Not available |
| 99 | +- `CAA` - Only available with premium service |
| 100 | +- `DHCID`, `DNAME`, `DNSKEY`, `DS`, `HTTPS`, `LOC`, `NAPTR`, `PTR`, `SOA`, `SSHFP`, `SVCB`, `TLSA` - Not available |
| 101 | + |
| 102 | +## Limitations |
| 103 | + |
| 104 | +### TTL values |
| 105 | + |
| 106 | +Gidinet only supports specific TTL values. If you specify a TTL that is not in the allowed list, DNSControl will automatically round up to the nearest allowed value. |
| 107 | + |
| 108 | +Allowed TTL values (in seconds): |
| 109 | +- 60 (1 minute) |
| 110 | +- 300 (5 minutes) |
| 111 | +- 600 (10 minutes) |
| 112 | +- 900 (15 minutes) |
| 113 | +- 1800 (30 minutes) |
| 114 | +- 2700 (45 minutes) |
| 115 | +- 3600 (1 hour) |
| 116 | +- 7200 (2 hours) |
| 117 | +- 14400 (4 hours) |
| 118 | +- 28800 (8 hours) |
| 119 | +- 43200 (12 hours) |
| 120 | +- 64800 (18 hours) |
| 121 | +- 86400 (1 day) |
| 122 | +- 172800 (2 days) |
| 123 | + |
| 124 | +### Nameservers |
| 125 | + |
| 126 | +Gidinet's default nameservers are: |
| 127 | +- `dnsl1.gidinet.com` |
| 128 | +- `dnsl2.gidinet.com` |
| 129 | + |
| 130 | +**Apex NS records are automatically filtered** by the DNS provider with a warning message. Gidinet does not support modifying NS records at the zone apex via the DNS API - they are managed by the registrar. |
| 131 | + |
| 132 | +To manage nameserver delegation, use Gidinet as a **registrar** with the `NAMESERVER()` function: |
| 133 | + |
| 134 | +{% code title="dnsconfig.js" %} |
| 135 | +```javascript |
| 136 | +var REG_GIDINET = NewRegistrar("gidinet"); |
| 137 | +var DSP_GIDINET = NewDnsProvider("gidinet"); |
| 138 | + |
| 139 | +D("example.com", REG_GIDINET, DnsProvider(DSP_GIDINET), |
| 140 | + NAMESERVER("dnsl1.gidinet.com."), |
| 141 | + NAMESERVER("dnsl2.gidinet.com."), |
| 142 | + A("test", "1.2.3.4"), |
| 143 | +); |
| 144 | +``` |
| 145 | +{% endcode %} |
| 146 | + |
| 147 | +This uses the Core API's `domainNameServersChange` method to update the nameservers at the registry level. |
| 148 | + |
| 149 | +### Zone creation |
| 150 | + |
| 151 | +Zones must be created via the Gidinet web interface. The API does not support creating new zones. |
| 152 | + |
| 153 | +### Zone listing |
| 154 | + |
| 155 | +The provider supports listing all zones in your account via `dnscontrol get-zones`. This uses the Core API's `domainGetList` method to retrieve all active domains. |
| 156 | + |
| 157 | +### Concurrent operations |
| 158 | + |
| 159 | +The provider does not support concurrent API operations. Changes are applied sequentially to ensure reliability. |
0 commit comments