Skip to content

Commit 5d1dfd1

Browse files
authored
Improve documentation with some extra info (hestiacp#3394)
* Add information about SMTP relay * Fix issue reported by users unable to install via this method * Add note about default setup * Update DNS user info exemptions
1 parent 6ac9b23 commit 5d1dfd1

File tree

3 files changed

+38
-6
lines changed

3 files changed

+38
-6
lines changed

docs/docs/introduction/getting-started.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,40 @@ Hestia does not support non-LTS Operating systems. If you install it on, for exa
3737

3838
Interactive installer that will install the default Hestia software configuration.
3939

40+
### Step 1: Download
41+
42+
Download the installation script for the latest release:
43+
44+
```bash
45+
wget https://raw.githubusercontent.com/hestiacp/hestiacp/release/install/hst-install.sh
46+
```
47+
48+
If the download fails due to an SSL validation error, please be sure you've installed the ca-certificate package on your system - you can do this with the following command:
49+
50+
```bash
51+
apt-get update && apt-get install ca-certificates
52+
```
53+
54+
### Step 2: Run
55+
56+
To begin the installation process, simply run the script and follow the on-screen prompts:
57+
4058
```bash
41-
wget -qO - https://raw.githubusercontent.com/hestiacp/hestiacp/release/install/hst-install.sh | bash
59+
bash hst-install.sh
4260
```
4361

62+
You will receive a welcome email at the address specified during installation (if applicable) and on-screen instructions after the installation is completed to log in and access your server.
63+
4464
## Custom installation
4565

4666
If you want to customise which software gets installed, or want to run an unattended installation, you will need to run a custom installation.
4767

68+
To view a list of available options, run
69+
70+
```bash
71+
bash hst-install.sh -h
72+
```
73+
4874
### List of installation options
4975

5076
::: tip
@@ -86,7 +112,7 @@ To choose what software gets installed, you can provide flags to the installatio
86112
#### Example
87113

88114
```bash
89-
wget -qO - https://raw.githubusercontent.com/hestiacp/hestiacp/release/install/hst-install.sh | bash -s -- \
115+
bash hst-install.sh \
90116
--interactive no \
91117
--hostname host.domain.tld \
92118
--email email@domain.tld \

docs/docs/server-administration/dns.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ With the release of 1.6.0, we have implemented a new API authentication system.
2222
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**.
2323
:::
2424

25-
### DNS Cluster with the Hestia API (Master <-> Master)
25+
### DNS Cluster with the Hestia API (Master <-> Master) "Default setup!"
2626

2727
::: warning
2828
This method does not support DNSSEC!
2929
:::
3030

31-
1. Create a new user on the Hestia server that will act as a “Slave”.
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`
3232
2. Run the following command to enable the DNS server.
3333

3434
```bash
@@ -47,7 +47,7 @@ There is no limitation on how to chain DNS servers.
4747

4848
### DNS Cluster with the Hestia API (Master -> Slave)
4949

50-
1. Create a new user on the Hestia server that will act as a “Slave”.
50+
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`
5151
2. In `/usr/local/hestia/conf/hestia.conf`, change `DNS_CLUSTER_SYSTEM='hestia'` to `DNS_CLUSTER_SYSTEM='hestia-zone'`.
5252
3. On the master server, open `/etc/bind/named.options`, do the following changes, then restart bind9 with `systemctl restart bind9`.
5353

@@ -147,7 +147,7 @@ v-add-remote-dns-host slave.yourhost.com 8083 api_key '' '' useraccount
147147
With the new API system, you can also replace `api_key` with `access_key:secret_key`
148148

149149
::: info
150-
Please note that currently, only the user `dns-user` is exempted from syncing to other servers. If you have a DNS cluster with multiple master slaves you might run in issues.
150+
By default the user `dns-user` or user with the role `dns-cluster` are exempted from syncing to other DNS servers!
151151
:::
152152

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

docs/docs/server-administration/email.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ If not, you have 2 options:
3737
- [SMTP2GO](https://www.smtp2go.com)
3838
- [Sendinblue](https://www.sendinblue.com)
3939

40+
## What is an SMTP relay service and how to set it up
41+
42+
SMTP mail relay is the process of transferring an email from one server to another for delivery. Often email from a server is blocked by de service provider due to fear of spam. Or the IP reputation is so low that all email go straight into the spam box. To prevent such issues a lot of companies offer a SMTP relay that takes care of the delivery part. As they send a lot email via the same ip addresses they have a better reputation.
43+
44+
To setup create a account by the provider you want or use and follow their instruction to update your DNS. When completed you can enter the SMTP user account they provider in the settings under "Global SMTP" or under the "Edit mail domain" -> "SMTP relay"
45+
4046
## I am unable to receive email
4147

4248
If you are unable to receive emails, make sure you have setup your DNS properly. If you are using Cloudflare, disable the use of the proxy for `mail.domain.tld`.

0 commit comments

Comments
 (0)