Skip to content

Commit 5187e79

Browse files
authored
Tidy install options docs (hestiacp#4074)
* Fix indentation of --username option * Add Username and Web Terminal options to install builder * Fix inconsistencies in install option docs * Improve option description * Remove unsightly border * Fix typos * Improve spacing
1 parent 9116b38 commit 5187e79

File tree

9 files changed

+39
-25
lines changed

9 files changed

+39
-25
lines changed

bin/v-list-default-php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#
55
# example: v-list-default-php
66
#
7-
# List the default version used by de the default template
7+
# List the default version used by the default template
88

99
#----------------------------------------------------------#
1010
# Variables & Functions #

docs/_data/options.js

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export const options = [
99
{
1010
flag: 'lang',
1111
label: 'Language',
12-
description: 'Change the ISO 639-1 language code',
12+
description: 'Change the interface language',
1313
type: 'select',
1414
default: 'en',
1515
options: [
@@ -64,6 +64,13 @@ export const options = [
6464
type: 'text',
6565
default: '',
6666
},
67+
{
68+
flag: 'username',
69+
label: 'Username',
70+
description: 'Set the admin account username',
71+
type: 'text',
72+
default: '',
73+
},
6774
{
6875
flag: 'email',
6976
label: 'Email',
@@ -180,6 +187,12 @@ export const options = [
180187
description: 'Use hard disk space limits on user packages',
181188
default: 'no',
182189
},
190+
{
191+
flag: 'webterminal',
192+
label: 'Web Terminal',
193+
description: 'Web-based SSH terminal',
194+
default: 'no',
195+
},
183196
{
184197
flag: 'api',
185198
label: 'Hestia API',

docs/docs/introduction/getting-started.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ bash hst-install.sh -h
7575
### List of installation options
7676

7777
::: tip
78-
An easier way to choose your installation options is by using the [Install string generator](/install).
78+
An easier way to choose your installation options is by using the [Install script generator](/install).
7979
:::
8080

8181
To choose what software gets installed, you can provide flags to the installation script. You can view the full list of options below.
@@ -88,22 +88,24 @@ To choose what software gets installed, you can provide flags to the installatio
8888
-j, --proftpd Install ProFTPD [yes | no] default: no
8989
-k, --named Install BIND [yes | no] default: yes
9090
-m, --mysql Install MariaDB [yes | no] default: yes
91-
-M, --mysql8 Install Mysql8 [yes | no] default: no
91+
-M, --mysql8 Install MySQL 8 [yes | no] default: no
9292
-g, --postgresql Install PostgreSQL [yes | no] default: no
9393
-x, --exim Install Exim [yes | no] default: yes
9494
-z, --dovecot Install Dovecot [yes | no] default: yes
9595
-Z, --sieve Install Sieve [yes | no] default: no
9696
-c, --clamav Install ClamAV [yes | no] default: yes
9797
-t, --spamassassin Install SpamAssassin [yes | no] default: yes
98-
-i, --iptables Install Iptables [yes | no] default: yes
99-
-b, --fail2ban Install Fail2ban [yes | no] default: yes
98+
-i, --iptables Install iptables [yes | no] default: yes
99+
-b, --fail2ban Install Fail2Ban [yes | no] default: yes
100100
-q, --quota Filesystem Quota [yes | no] default: no
101+
-W, --webterminal Web Terminal [yes | no] default: no
101102
-d, --api Activate API [yes | no] default: yes
102103
-r, --port Change Backend Port default: 8083
103104
-l, --lang Default language default: en
104105
-y, --interactive Interactive install [yes | no] default: yes
105106
-s, --hostname Set hostname
106107
-e, --email Set admin email
108+
-u, --username Set admin user
107109
-p, --password Set admin password
108110
-D, --with-debs Path to Hestia debs
109111
-f, --force Force installation

docs/docs/reference/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4279,7 +4279,7 @@ list default PHP version used by default.tpl
42794279

42804280
**Options**: `[FORMAT]`
42814281

4282-
List the default version used by de the default template
4282+
List the default version used by the default template
42834283

42844284
## v-list-dns-domain
42854285

docs/docs/server-administration/email.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ If not, you have 2 options:
3939

4040
## What is an SMTP relay service and how to set it up
4141

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.
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 the 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.
4343

4444
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"
4545

install/hst-install-debian.sh

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,29 +55,29 @@ help() {
5555
echo "Usage: $0 [OPTIONS]
5656
-a, --apache Install Apache [yes|no] default: yes
5757
-w, --phpfpm Install PHP-FPM [yes|no] default: yes
58-
-o, --multiphp Install Multi-PHP [yes|no] default: no
59-
-v, --vsftpd Install Vsftpd [yes|no] default: yes
58+
-o, --multiphp Install MultiPHP [yes|no] default: no
59+
-v, --vsftpd Install VSFTPD [yes|no] default: yes
6060
-j, --proftpd Install ProFTPD [yes|no] default: no
61-
-k, --named Install Bind [yes|no] default: yes
61+
-k, --named Install BIND [yes|no] default: yes
6262
-m, --mysql Install MariaDB [yes|no] default: yes
63-
-M, --mysql8 Install MySQL [yes|no] default: no
63+
-M, --mysql8 Install MySQL 8 [yes|no] default: no
6464
-g, --postgresql Install PostgreSQL [yes|no] default: no
6565
-x, --exim Install Exim [yes|no] default: yes
6666
-z, --dovecot Install Dovecot [yes|no] default: yes
6767
-Z, --sieve Install Sieve [yes|no] default: no
6868
-c, --clamav Install ClamAV [yes|no] default: yes
6969
-t, --spamassassin Install SpamAssassin [yes|no] default: yes
70-
-i, --iptables Install Iptables [yes|no] default: yes
71-
-b, --fail2ban Install Fail2ban [yes|no] default: yes
70+
-i, --iptables Install iptables [yes|no] default: yes
71+
-b, --fail2ban Install Fail2Ban [yes|no] default: yes
7272
-q, --quota Filesystem Quota [yes|no] default: no
73-
-W, --webterminal Web terminal [yes|no] default: no
73+
-W, --webterminal Web Terminal [yes|no] default: no
7474
-d, --api Activate API [yes|no] default: yes
7575
-r, --port Change Backend Port default: 8083
7676
-l, --lang Default language default: en
7777
-y, --interactive Interactive install [yes|no] default: yes
7878
-s, --hostname Set hostname
7979
-e, --email Set admin email
80-
-u, --username Set admin user
80+
-u, --username Set admin user
8181
-p, --password Set admin password
8282
-D, --with-debs Path to Hestia debs
8383
-f, --force Force installation

install/hst-install-ubuntu.sh

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,20 +55,20 @@ help() {
5555
echo "Usage: $0 [OPTIONS]
5656
-a, --apache Install Apache [yes|no] default: yes
5757
-w, --phpfpm Install PHP-FPM [yes|no] default: yes
58-
-o, --multiphp Install Multi-PHP [yes|no] default: no
59-
-v, --vsftpd Install Vsftpd [yes|no] default: yes
58+
-o, --multiphp Install MultiPHP [yes|no] default: no
59+
-v, --vsftpd Install VSFTPD [yes|no] default: yes
6060
-j, --proftpd Install ProFTPD [yes|no] default: no
61-
-k, --named Install Bind [yes|no] default: yes
61+
-k, --named Install BIND [yes|no] default: yes
6262
-m, --mysql Install MariaDB [yes|no] default: yes
63-
-M, --mysql8 Install MySQL [yes|no] default: no
63+
-M, --mysql8 Install MySQL 8 [yes|no] default: no
6464
-g, --postgresql Install PostgreSQL [yes|no] default: no
6565
-x, --exim Install Exim [yes|no] default: yes
6666
-z, --dovecot Install Dovecot [yes|no] default: yes
6767
-Z, --sieve Install Sieve [yes|no] default: no
6868
-c, --clamav Install ClamAV [yes|no] default: yes
6969
-t, --spamassassin Install SpamAssassin [yes|no] default: yes
70-
-i, --iptables Install Iptables [yes|no] default: yes
71-
-b, --fail2ban Install Fail2ban [yes|no] default: yes
70+
-i, --iptables Install iptables [yes|no] default: yes
71+
-b, --fail2ban Install Fail2Ban [yes|no] default: yes
7272
-q, --quota Filesystem Quota [yes|no] default: no
7373
-W, --webterminal Web Terminal [yes|no] default: no
7474
-d, --api Activate API [yes|no] default: yes
@@ -77,7 +77,7 @@ help() {
7777
-y, --interactive Interactive install [yes|no] default: yes
7878
-s, --hostname Set hostname
7979
-e, --email Set admin email
80-
-u, --username Set admin user
80+
-u, --username Set admin user
8181
-p, --password Set admin password
8282
-D, --with-debs Path to Hestia debs
8383
-f, --force Force installation

web/css/src/themes/default.css

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1195,7 +1195,6 @@
11951195
.card-content {
11961196
padding: 10px;
11971197
color: #353535;
1198-
border-top: 1px solid #e6e6e6;
11991198
text-align: center;
12001199
}
12011200

web/templates/pages/edit_mail.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ class="<?= $v_status ?> js-enable-inputs-on-submit"
133133
</div>
134134
</div>
135135
<?php if ($v_ssl != "no") { ?>
136-
<ul class="values-list">
136+
<ul class="values-list u-mb20">
137137
<li class="values-list-item">
138138
<span class="values-list-label"><?= _("Issued To") ?></span>
139139
<span class="values-list-value"><?= htmlentities($v_ssl_subject) ?></span>

0 commit comments

Comments
 (0)