You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update dns.md - mainly Master -> Slave config
Docs updated when deploying slave configuration.
Master <-> Master could do with re-validating as it may be affected by the changes.
I also made general changes which I believe makes the document more readable.
* Update docs/docs/server-administration/dns.md
Co-authored-by: Jakob Bouchard <jakob@jakobbouchard.dev>
* Update docs/docs/server-administration/dns.md
Co-authored-by: Jakob Bouchard <jakob@jakobbouchard.dev>
* Update docs/docs/server-administration/dns.md
Co-authored-by: Jakob Bouchard <jakob@jakobbouchard.dev>
* Update docs/docs/server-administration/dns.md
Co-authored-by: Jakob Bouchard <jakob@jakobbouchard.dev>
* Update dns.md - addressed linting & pritty issues
* Update dns.md - more formatting tweaks
* Update dns.md removed trailing newline at end of page
* Update dns.md - text tweaks, clarified M/S user name
* Fix format
---------
Co-authored-by: Jakob Bouchard <jakob@jakobbouchard.dev>
Co-authored-by: Jaap Marcus <9754650+jaapmarcus@users.noreply.github.com>
Copy file name to clipboardExpand all lines: docs/docs/server-administration/dns.md
+60-33Lines changed: 60 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,42 +4,55 @@
4
4
With the release of version 1.7.0, we have implemented support for DNSSEC. DNSSEC requires a Master -> Slave setup. IF the existing implementation is a Master <-> Master setup, it is not supported. DNSSEC also requires at least Ubuntu 22.04 or Debian 11!
5
5
:::
6
6
7
-
## Host your DNS on Hestia
7
+
## Host DNS for your domain on Hestia
8
8
9
-
[Create a DNS Zone](../user-guide/dns.md#adding-a-dns-zone) with the **child-ns** template, then login to your domain registrar’s panel and change the name servers of the domain. Depending your registrar panel, you could be able to create glue records. You may need to wait for up to 24 hours before the name servers become active.
9
+
Pre-requisites
10
10
11
-
## DNS Cluster setup
11
+
These steps require that you configure the DNS servers of your domain to use your Hestia servers.
12
+
13
+
- Note that most domain providers require two or more DNS servers to be configured.
14
+
- The name servers will most likely be required to be registered as 'Glue records'
15
+
- You may need to wait for up to 24 hours before the name servers become available
16
+
17
+
Preparing the domain and DNS
18
+
19
+
1. On your Hestia master, [create a DNS Zone](../user-guide/dns.md#adding-a-dns-zone) with the **child-ns** template
20
+
2. On your domain registrar panel, set the name servers of the domain to the Hestia servers
21
+
22
+
If you are looking at options to minimise DNS-related downtime or for a way to automatically synchronise DNS zones across all your servers, you might consider setting up a DNS cluster.
23
+
24
+
If DNSSEC matters to you, then you must use Master -> Slave. However if you would like to add zones to either server and have them replicate to the other, then configure as Master <-> Master.
12
25
13
26
::: tip
14
-
Create for each server a unique user and assing them the "Sync DNS User" or "dns-cluster" role!
27
+
If you have just set up your slave, check that the host name resolves and that you have a valid SSL certificate
15
28
:::
16
29
17
-
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.
30
+
## DNS Cluster setup
18
31
19
-
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.
20
-
2. Enable API access for admins (or all users).
21
-
3. Create an API key under the **admin** user with at least the **sync-dns-cluster** permission.
32
+
A Master server is where DNS zones are created, and a Slave server recieves the zone via the API. Hestia can be configured as Master <-> Master or Master -> Slave. With a Master <-> Master configuration, each Master is also a Slave, so it could be considered as Master/Slave <-> Master/Slave.
33
+
34
+
On each Slave server, a unique user is required who will be assigned the zones, and must be assigned the "Sync DNS User" or "dns-cluster" role.
22
35
23
36
::: info
24
-
With the release of 1.6.0, we have implemented a new API authentication system. We strongly suggest using this method instead of the old system, as it is more secure due to the length of the access key and secret key!
37
+
With the release of 1.6.0, we have implemented a new API Access Key authentication system. We strongly suggest using this method instead of the previous username/password system, as it is more secure due to the length of the access key and secret key!
25
38
26
39
If you still want to use the legacy API to authenticate with **admin** username and the password make sure **Enable legacy API** access is set to **yes**.
27
40
:::
28
41
29
-
### DNS Cluster with the Hestia API (Master <-> Master) "Default setup!"
42
+
### Master <-> Master DNS cluster (Default setup) with the Hestia API
30
43
31
44
::: warning
32
45
This method does not support DNSSEC!
33
46
:::
34
47
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`
48
+
1. Create a new user on each Hestia server that will act as a “Slave”. Make sure it uses the username of "dns-cluster" or has the role `dns-cluster`
36
49
2. Run the following command to enable the DNS server.
3. Check it worked by listing the DNS zones on the **Slave** for the dns-user with the CLI command `v-list-dns-domains dns-user` or by connecting to the web iterface as dns-user and reviewing the DNS zones.
116
+
92
117
### Converting an existing DNS cluster to Master -> Slave
93
118
94
119
1. In `/usr/local/hestia/conf/hestia.conf`, change `DNS_CLUSTER_SYSTEM='hestia'` to `DNS_CLUSTER_SYSTEM='hestia-zone'`.
@@ -134,7 +159,9 @@ Depending on your registrar, you will either be able to create a new record base
134
159
Removing or disabling the private key in Hestia will make the domain inaccessble.
135
160
:::
136
161
137
-
## Can I separate DNS accounts by users
162
+
## FAQ & troubleshooting
163
+
164
+
### Can I separate DNS accounts by users
138
165
139
166
Yes, you can just supply the user variable at the end of the command.
140
167
@@ -154,7 +181,7 @@ With the new API system, you can also replace `api_key` with `access_key:secret_
154
181
By default the user `dns-cluster` or user with the role `dns-cluster` are exempted from syncing to other DNS servers!
155
182
:::
156
183
157
-
## I am not able to add a server as DNS host
184
+
### I am not able to add a server as DNS host
158
185
159
186
When trying to add a DNS server for a cluster I get the following error:
160
187
@@ -163,4 +190,4 @@ When trying to add a DNS server for a cluster I get the following error:
163
190
Error: api connection to slave.domain.tld failed
164
191
```
165
192
166
-
By default, API access has been disabled fornon-local IP addresses. Please add your IP address to the **Allowed IP addresses for API** fieldinthe server settings.
193
+
By default, API access is disabled fornon-local IP addresses. On your **Slave**, add the IP address of your **Master** to the **Allowed IP addresses for API** fieldinServer settings -> Configure -> Security -> System -> Allowed IP addresses for API and press Save.
0 commit comments