Skip to content

Commit 1552131

Browse files
authored
Update docs regarding DNS cluster user (hestiacp#3604)
1 parent 83289a4 commit 1552131

File tree

1 file changed

+15
-11
lines changed
  • docs/docs/server-administration

1 file changed

+15
-11
lines changed

docs/docs/server-administration/dns.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ With the release of version 1.7.0, we have implemented support for DNSSEC. DNSSE
1010

1111
## DNS Cluster setup
1212

13+
::: tip
14+
Create for each server a unique user and assing them the "Sync DNS User" or "dns-cluster" role!
15+
:::
16+
1317
If you are looking at options to minimise DNS-related downtime or for a way to manage DNS across all your servers, you might consider setting up a DNS cluster.
1418

1519
1. Whitelist your master server IP in **Configure Server** -> **Security** -> **Allowed IP addresses for API**, otherwise you will get an error when adding the slave server to the cluster.
@@ -28,17 +32,17 @@ If you still want to use the legacy API to authenticate with **admin** username
2832
This method does not support DNSSEC!
2933
:::
3034

31-
1. Create a new user on the Hestia server that will act as a “Slave”. Make sure it uses the username of "dns-user" or has the role `dns-cluster`
35+
1. Create a new user on the Hestia server that will act as a “Slave”. Make sure it uses the username of "dns-cluster" or has the role `dns-cluster`
3236
2. Run the following command to enable the DNS server.
3337

3438
```bash
35-
v-add-remote-dns-host slave.yourhost.com 8083 'accesskey:secretkey' '' 'api' 'dns-user'
39+
v-add-remote-dns-host slave.yourhost.com 8083 'accesskey:secretkey' '' 'api' 'username'
3640
```
3741

3842
Or if you still want to use admin and password authentication
3943

4044
```bash
41-
v-add-remote-dns-host slave.yourhost.com 8083 'admin' 'strongpassword' 'api' 'dns-user'
45+
v-add-remote-dns-host slave.yourhost.com 8083 'admin' 'strongpassword' 'api' 'username'
4246
```
4347

4448
This way you can set up Master -> Slave or Master <-> Master <-> Master cluster.
@@ -76,13 +80,13 @@ There is no limitation on how to chain DNS servers.
7680
5. Run the following command to enable the DNS server:
7781

7882
```bash
79-
v-add-remote-dns-host slave.yourhost.com 8083 'accesskey:secretkey' '' 'api' 'dns-user'
83+
v-add-remote-dns-host slave.yourhost.com 8083 'accesskey:secretkey' '' 'api' 'user-name'
8084
```
8185

8286
If you still want to use admin and password authentication:
8387

8488
```bash
85-
v-add-remote-dns-host slave.yourhost.com 8083 'admin' 'strongpassword' 'api' 'dns-user'
89+
v-add-remote-dns-host slave.yourhost.com 8083 'admin' 'strongpassword' 'api' 'user-name'
8690
```
8791

8892
### Converting an existing DNS cluster to Master -> Slave
@@ -134,20 +138,20 @@ Removing or disabling the private key in Hestia will make the domain inaccessble
134138

135139
Yes, you can just supply the user variable at the end of the command.
136140

137-
```bash
138-
v-add-remote-dns-host slave.yourhost.com 8083 admin p4sw0rd '' useraccount
139-
```
141+
````bash
142+
v-add-remote-dns-host slave.yourhost.com 8083 'access_key:secret_key' '' '' 'username'```
143+
````
140144
141-
Or
145+
or
142146
143147
```bash
144-
v-add-remote-dns-host slave.yourhost.com 8083 api_key '' '' useraccount
148+
v-add-remote-dns-host slave.yourhost.com 8083 admin p4sw0rd '' 'username'
145149
```
146150

147151
With the new API system, you can also replace `api_key` with `access_key:secret_key`
148152

149153
::: info
150-
By default the user `dns-user` or user with the role `dns-cluster` are exempted from syncing to other DNS servers!
154+
By default the user `dns-cluster` or user with the role `dns-cluster` are exempted from syncing to other DNS servers!
151155
:::
152156

153157
## I am not able to add a server as DNS host

0 commit comments

Comments
 (0)