Skip to content

Commit 0782deb

Browse files
authored
Update Docs (hestiacp#4836)
* Upgrade info * Update info regariding rest api * Remove duplicate echo * Mute output * Make some more minor changes * Update comment v-quick-install-app * FIx error * Check if it becomes more reabable * Change order * Include all missing commands * Fix formatting error * Update CLI info
1 parent 3370d3d commit 0782deb

File tree

9 files changed

+511
-74
lines changed

9 files changed

+511
-74
lines changed

bin/v-add-web-domain

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#
77
# This function adds virtual host to a server. In cases when ip is
88
# undefined in the script, "default" template will be used. The alias of
9-
# www.domain.tld type will be automatically assigned to the domain unless
9+
# `www.domain.tld` type will be automatically assigned to the domain unless
1010
# "none" is transmited as argument. If ip have associated dns name, this
1111
# domain will also get the alias domain-tpl.$ipname. An alias with the ip
1212
# name is useful during the site testing while dns isn't moved to server yet.

bin/v-quick-install-app

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@
33
//# info: Install Quick Install Web App via CLI
44
//# options: action [user] [domain] [app] [options ...]
55
//#
6-
//# example: v-quick-install-app install admin domain.com wordpress email="info@hestiacp" password="123456" username="admin" site_name="HestiaCP Demo" install_directory="/" language="nl_NL" php_version="8.2" database_create="true"
7-
//# example: v-quick-install-app apps
8-
//# example: v-quick-install-app options admin domain.com wordpress
9-
//# Install Quick Install Web App via CLI run v-quick-install-app apps for supported apps.
10-
//# v-quick-install-app options for the app options and v-quick-install-app install to install the app
11-
//# Please note app names are case sensitive
6+
//# example: v-quick-install-app install admin domain.com WordPress email="info@hestiacp" password="123456" username="admin" site_name="HestiaCP Demo" install_directory="/" language="nl_NL" php_version="8.2" database_create="true"
7+
//# example: v-quick-install-app app
8+
//# example: v-quick-install-app options admin domain.com WordPress
9+
//#
10+
//# - The v-quick-install-app install command is used to automate the installation of web applications on a server managed by Hestia Control Panel.
11+
//# - The v-quick-install-app app command is used to retrieve a list of web applications that can be quickly installed through the v-quick-install-app install command in the Hestia Control Panel. This command provides a convenient overview of supported applications and their versions, allowing users to choose which application they would like to deploy on their server. The names of the applications are case sensitive.
12+
//# - v-quick-install-app options admin domain.com WordPress list all the options available for the specified web application. This command provides a list of all the required and optional fields that need to be filled in when installing the application. The command also provides the default values for each field, if available.
1213

1314
use Symfony\Component\Console\Application;
1415
use Symfony\Component\Console\Input\InputArgument;

docs/docs/introduction/best-practices.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ Managing a server is not easy. Here are some best practices you should try to ad
44

55
## Use a regular user
66

7-
::: danger Never run a web or mail domain with the **admin** user
8-
By default, the **admin** user has elevated privileges. This can pose a **security threat** to your server. For example, if you run WordPress under your **admin** user and a vulnerability is found in WordPress or a plugin, a malicious user might be able to run commands as **root**!
9-
:::
10-
117
Before adding any web or mail domain on your server, you should create a regular user. To do this, you can refer to our [User Management Guide](../user-guide/users#adding-a-user).
128

139
## Enable two-factor authentication (2FA) for the _admin_ user

docs/docs/introduction/getting-started.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The installer needs to be run as **root**, either directly from the terminal or
1010

1111
::: warning
1212
Hestia must be installed on top of a fresh operating system installation to ensure proper functionality.
13-
If on a VPS/KVM, and there is already an admin account, either delete that default admin ID, or use `--force` to continue with the installation. See custom installation below for further details.
13+
See custom installation below for further details.
1414
:::
1515

1616
| | Minimum | Recommended |
@@ -112,6 +112,10 @@ To choose what software gets installed, you can provide flags to the installatio
112112
-h, --help Print this help
113113
```
114114

115+
:::tip
116+
Option --multiphp (Multi PHP) also accepts a comma seperated list of PHP versions. For example: --multiphp 8.3,8.4 will install PHP8.3 and PHP8.4
117+
:::
118+
115119
#### Example
116120

117121
```bash
@@ -124,13 +128,14 @@ bash hst-install.sh \
124128
--apache no \
125129
--named no \
126130
--clamav no \
127-
--spamassassin no
131+
--spamassassin no \
132+
--multiphp '8.2,8.3,8.4'
128133
```
129134

130135
This command will install Hestia in French with the following software:
131136

132137
- Nginx Web Server
133-
- PHP-FPM Application Server
138+
- PHP-FPM Application Server (PHP version 8.2, 8.3 and 8.4)
134139
- MariaDB Database Server
135140
- IPtables Firewall + Fail2Ban Intrusion prevention software
136141
- Vsftpd FTP Server

0 commit comments

Comments
 (0)