Hestia Control Panel

https://hestiacp.com/docs/
Admin
Hestia Control Panel is an open-source server control panel designed to simplify the management of...
Tokens:149,468
Snippets:1,867
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Show Hestia installer help

Source: https://hestiacp.com/docs/introduction/getting-started.html

Displays the list of available installation options for custom or unattended installations.

```bash
bash hst-install.sh -h
```

--------------------------------

### Install SnappyMail

Source: https://hestiacp.com/docs/server-administration/email

Install SnappyMail by running this command.

```bash
v-add-sys-snappymail
```

--------------------------------

### v-quick-install-app

Source: https://hestiacp.com/docs/reference/cli

Installs web applications via CLI, lists available applications, or shows installation options for a specified application.

```APIDOC
## v-quick-install-app

### Description
Installs web applications via CLI, lists available applications, or shows installation options for a specified application.

### Method
CLI

### Command
v-quick-install-app

### Parameters
- **ACTION** (string) - Required - The action to perform: `install`, `app`, or `options`.
- **USER** (string) - Optional - The user for the installation (used with `install` and `options` actions).
- **DOMAIN** (string) - Optional - The domain for the installation (used with `install` and `options` actions).
- **APP** (string) - Optional - The application name (used with `install` and `options` actions).
- **OPTIONS** (string) - Optional - Additional installation options (used with `install` action).

### Actions
- **install** - Automates the installation of web applications on a server managed by Hestia Control Panel.
- **app** - Retrieves a list of web applications that can be quickly installed. Application names are case sensitive.
- **options** - Lists all required and optional fields for the specified web application, including default values if available.

### Examples
```bash
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"
```
```bash
v-quick-install-app app
```
```bash
v-quick-install-app options admin domain.com WordPress
```
```

--------------------------------

### SSH into VM and install required packages

Source: https://hestiacp.com/docs/contributing/development

SSH into the VM as root and install jq and libjq1.

```bash
multipass exec hestia-dev -- sudo bash
sudo apt update && sudo apt install -y jq libjq1
```

--------------------------------

### Custom Hestia installation example

Source: https://hestiacp.com/docs/introduction/getting-started.html

Example custom installation command that installs Hestia in French with Nginx, PHP-FPM (8.2, 8.3, 8.4), MariaDB, iptables, Fail2Ban, vsftpd, Exim, and Dovecot. Disables Apache, BIND, ClamAV, and SpamAssassin.

```bash
bash hst-install.sh \
	--interactive no \
	--hostname host.domain.tld \
	--email email@domain.tld \
	--password p4ssw0rd \
	--lang fr \
	--apache no \
	--named no \
	--clamav no \
	--spamassassin no \
	--multiphp '8.2,8.3,8.4'
```

--------------------------------

### Install a web app with v-quick-install-app

Source: https://hestiacp.com/docs/reference/cli

Installs a web application via the Hestia Control Panel CLI. The install command automates deployment, the app command lists available applications (case-sensitive), and the options command lists required and optional fields with defaults.

```php
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"
 example: v-quick-install-app app
 example: v-quick-install-app options admin domain.com WordPress
```

--------------------------------

### Build and install all packages

Source: https://hestiacp.com/docs/contributing/building

Builds and installs Hestia along with hestia-nginx and hestia-php. Use this if Hestia is already installed and you want your changes to take effect.

```bash
# Hestia + hestia-nginx and hestia-php
./hst_autocompile.sh --all --install '~localsrc'
```

--------------------------------

### Install Hestia with flags

Source: https://hestiacp.com/docs/contributing/development

Navigate to /install and run the installation script with specified flags. Update the flags to your liking; login credentials are set here.

```bash
cd ../install
bash hst-install-ubuntu.sh --hostname demo.hestiacp.com --email admin@example.com --username admin --password Password123 --with-debs /tmp/hestiacp-src/deb/ --interactive no --force
```

--------------------------------

### Hestia installation options

Source: https://hestiacp.com/docs/introduction/getting-started.html

Lists all installation flags for customizing the Hestia installation, including defaults. Use with the install script generator for easier selection.

```bash
-a, --apache Install Apache [yes | no] default: yes
-w, --phpfpm Install PHP-FPM [yes | no] default: yes
-o, --multiphp Install MultiPHP [yes | no] default: no
-v, --vsftpd Install VSFTPD [yes | no] default: yes
-j, --proftpd Install ProFTPD [yes | no] default: no
-k, --named Install BIND [yes | no] default: yes
-m, --mysql Install MariaDB [yes | no] default: yes
-M, --mysql8 Install MySQL 8 [yes | no] default: no
-g, --postgresql Install PostgreSQL [yes | no] default: no
-x, --exim Install Exim [yes | no] default: yes
-z, --dovecot Install Dovecot [yes | no] default: yes
-Z, --sieve Install Sieve [yes | no] default: no
-c, --clamav Install ClamAV [yes | no] default: yes
-t, --spamassassin Install SpamAssassin [yes | no] default: yes
-i, --iptables Install iptables [yes | no] default: yes
-b, --fail2ban Install Fail2Ban [yes | no] default: yes
-q, --quota Filesystem Quota [yes | no] default: no
-W, --webterminal Web Terminal [yes | no] default: no
-d, --api Activate API [yes | no] default: yes
-r, --port Change Backend Port default: 8083
-l, --lang Default language default: en
-y, --interactive Interactive install [yes | no] default: yes
-s, --hostname Set hostname
-e, --email Set admin email
-u, --username Set admin user
-p, --password Set admin password
-D, --with-debs Path to Hestia debs
-f, --force Force installation
-h, --help Print this help
```

--------------------------------

### v-add-sys-smtp example

Source: https://hestiacp.com/docs/reference/cli

Configures an SMTP account for the server to use for logging, notification, and warning emails. The example uses domain example.com, port 587, STARTTLS security, username test@domain.com, password securepassword, and email test@example.com.

```bash
v-add-sys-smtp example.com 587 STARTTLS test@domain.com securepassword test@example.com
```

--------------------------------

### v-start-service command

Source: https://hestiacp.com/docs/reference/cli

Starts a system service. SERVICE is required.

```bash
v-start-service mysql
```

--------------------------------

### v-get-dns-domain-value: Get DNS domain value

Source: https://hestiacp.com/docs/reference/cli

Gets a certain DNS domain parameter. The example retrieves the SOA value for example.com for user admin.

```bash
v-get-dns-domain-value admin example.com SOA
```

--------------------------------

### Run Hestia interactive installer

Source: https://hestiacp.com/docs/introduction/getting-started.html

Runs the interactive Hestia installer with default configuration. Follow the on-screen prompts; a welcome email may be sent.

```bash
bash hst-install.sh
```

--------------------------------

### Download beta installer scripts

Source: https://hestiacp.com/docs/contributing/testing

Download the Hestia installation script for Debian or Ubuntu from the beta server. Use the appropriate command for your distribution, then run the script with bash.

```bash
# Debian
wget https://beta-apt.hestiacp.com/hst-install-debian.sh
# or Ubuntu
wget https://beta-apt.hestiacp.com/hst-install-ubuntu.sh
```

--------------------------------

### v-add-backup-host examples

Source: https://hestiacp.com/docs/reference/cli

Adds a new remote backup location. Currently SFTP, FTP and Backblaze are supported. The first example uses SFTP, the second uses Backblaze B2.

```bash
v-add-backup-host sftp backup.acme.com admin 'P4$$w@rD'
v-add-backup-host b2 bucketName keyID applicationKey
```

--------------------------------

### Download and install Rclone

Source: https://hestiacp.com/docs/server-administration/backup-restore

Downloads and installs Rclone on the server. Requires sudo privileges.

```bash
sudo -v
curl https://rclone.org/install.sh | sudo bash

```

--------------------------------

### Add Remote Database Host with v-add-database-host (Syntax and Example)

Source: https://hestiacp.com/docs/server-administration/databases

Adds a remote database host with optional parameters. The first line shows the full syntax; the second is an example that adds a MySQL host with a maximum of 500 databases.

```bash
v-add-database-host TYPE HOST DBUSER DBPASS [MAX_DB] [CHARSETS] [TPL] [PORT]
```

```bash
v-add-database-host mysql db.hestiacp.com root mypassword 500
```

--------------------------------

### v-update-sys-hestia-git

Source: https://hestiacp.com/docs/reference/cli

Downloads and compiles/installs packages from GitHub repositories. The example uses the hestiacp repository, staging/beta branch, and the install option. The install-auto option installs the package and schedules automatic updates from Git.

```bash
v-update-sys-hestia-git hestiacp staging/beta install
# Will download from the hestiacp repository
# Pulls code from staging/beta branch
# install: installs package immediately
# install-auto: installs package and schedules automatic updates from Git
```

--------------------------------

### Install php-memcached and php-redis

Source: https://hestiacp.com/docs/server-administration/web-templates

Install php-memcached and php-redis along with required additional packages for PHP.

```bash
apt install php-memcached php-redis
```

--------------------------------

### Download and run ioncube installer

Source: https://hestiacp.com/docs/community/ioncube-hestia-installer

Downloads, makes executable, and runs the ioncube installer script for Hestia. The script installs Ioncube loaders for each available PHP version.

```bash
wget https://raw.githubusercontent.com/jaapmarcus/ioncube-hestia-installer/main/install_ioncube.sh
chmod +x install_ioncube.sh
./install_ioncube.sh
```

--------------------------------

### v-list-dns-templates example

Source: https://hestiacp.com/docs/reference/cli

Lists all available DNS templates. Optionally accepts a format argument (e.g., json).

```bash
v-list-dns-templates json
```

--------------------------------

### v-rebuild-database command example

Source: https://hestiacp.com/docs/reference/cli

Rebuilds a single database for a user. Requires USER and DATABASE arguments.

```bash
v-rebuild-database user user_wordpress
```

--------------------------------

### v-restore-web-domain-restic command examples

Source: https://hestiacp.com/docs/reference/cli

Restores web domains from a Restic snapshot. The example shows restoring a single domain, multiple domains, and all domains with a wildcard.

```bash
v-restore-web-domain-restic user snapshot domain.com
example: v-restore-web-domain-restic user snapshot 'domain.com,domain2.com'
example: v-restore-web-domain-restic user snapsho '*'
```

--------------------------------

### Install Hestia from a branch

Source: https://hestiacp.com/docs/contributing/building

Clones the Hestia repository, checks out a branch, compiles all packages, and installs them using the installer script with the built .deb files. Useful for testing a Pull Request or a branch on a fork.

```bash
# Replace with https://github.com/username/hestiacp.git if you want to test a branch that you created yourself
git clone https://github.com/hestiacp/hestiacp.git
cd ./hestiacp/

# Replace main with the branch you want to test
git checkout main

cd ./src/

# Compile packages
./hst_autocompile.sh --all --noinstall --keepbuild '~localsrc'

cd ../install

bash hst-install-{os}.sh --with-debs /tmp/hestiacp-src/deb/
```

--------------------------------

### v-add-web-php: Install PHP-FPM version

Source: https://hestiacp.com/docs/reference/cli

Installs PHP-FPM for the specified version. Requires the VERSION option.

```bash
v-add-web-php 8.0
```

--------------------------------

### v-list-dns-domain example

Source: https://hestiacp.com/docs/reference/cli

Lists DNS domain parameters for a given user and domain. Requires the user and domain as arguments.

```bash
v-list-dns-domain alice wonderland.com
```

--------------------------------

### v-start-service

Source: https://hestiacp.com/docs/reference/cli

Starts a system service. Requires the service name.

```APIDOC
## v-start-service

### Description
Starts a system service.

### Method
CLI

### Command
`v-start-service`

### Options
- `SERVICE` (string) - Required - The name of the service to start.

### Example
```bash
v-start-service mysql
```
```

--------------------------------

### Install PHP module with apt

Source: https://hestiacp.com/docs/server-administration/web-templates

Install a PHP module using apt. Replace php-package-name with the actual package name.

```bash
apt install php-package-name
```

--------------------------------

### Example decompressed tar file path

Source: https://hestiacp.com/docs/server-administration/backup-restore

Example path of the resulting tarball after decompression.

```batch
C:\Users\{user}\Downloads\admin.2021-06-27_05-48-23\web\{domain}\domain_data.tar

```

--------------------------------

### v-add-sys-snappymail

Source: https://hestiacp.com/docs/reference/cli

Installs the SnappyMail webmail client.

```APIDOC
## v-add-sys-snappymail

### Description
Installs the SnappyMail webmail client.

### Method
CLI

### Command
v-add-sys-snappymail

### Parameters
- `MODE` (string) - Optional - Mode of operation.

### Example
```bash
v-add-sys-snappymail
```

```

--------------------------------

### v-list-dns-records example

Source: https://hestiacp.com/docs/reference/cli

Lists all DNS records for a given user and domain. Requires the user and domain as arguments.

```bash
v-list-dns-records admin example.com
```

--------------------------------

### v-rebuild-web-domain command example

Source: https://hestiacp.com/docs/reference/cli

Rebuilds the web configuration files for a specified user and domain. The USER and DOMAIN arguments are required.

```bash
v-rebuild-web-domain user domain.tld
```

--------------------------------

### Activate beta repo on existing install

Source: https://hestiacp.com/docs/contributing/testing

Run these commands as root to add the beta apt repository to an existing Hestia installation. The script collects system architecture and codename, comments out the current hestia.list entries, adds the beta repo, imports the signing key, and updates packages. Warning: betas may contain bugs and can break your server.

```bash
# Collecting system data
ARCH=$(arch)
case $(arch) in x86_64) ARCH="amd64" ;; aarch64) ARCH="arm64" ;; esac
codename="$(lsb_release -s -c)"
apt="/etc/apt/sources.list.d"

# Add the beta repo to hestia.list
sed -i 's/^/#/' $apt/hestia.list
echo "deb [arch=$ARCH signed-by=/usr/share/keyrings/hestia-beta-keyring.gpg] https://beta-apt.hestiacp.com/ $codename main" >> $apt/hestia.list
curl -s "https://beta-apt.hestiacp.com/pubkey.gpg" | gpg --dearmor | tee /usr/share/keyrings/hestia-beta-keyring.gpg > /dev/null 2>&1

# Update to the beta version
apt update && apt upgrade
```

--------------------------------

### Build all packages without installing

Source: https://hestiacp.com/docs/contributing/building

Builds Hestia along with hestia-nginx and hestia-php without installing them. Use --noinstall to only compile the packages.

```bash
# Hestia + hestia-nginx and hestia-php
./hst_autocompile.sh --all --noinstall --keepbuild '~localsrc'
```

--------------------------------

### v-list-dns-domains example

Source: https://hestiacp.com/docs/reference/cli

Lists all DNS domains for a specified user. Requires the user as an argument.

```bash
v-list-dns-domains admin
```

--------------------------------

### v-rebuild-databases command example

Source: https://hestiacp.com/docs/reference/cli

Rebuilds all databases of a single user. Requires USER argument.

```bash
v-rebuild-databases admin
```

--------------------------------

### v-list-firewall example

Source: https://hestiacp.com/docs/reference/cli

Lists all iptables rules. Optionally accepts a format argument (e.g., json).

```bash
v-list-firewall json
```

--------------------------------

### v-add-web-php

Source: https://hestiacp.com/docs/reference/cli

Installs PHP-FPM for a specified version.

```APIDOC
## v-add-web-php

### Description
Installs PHP-FPM for a specified version.

### Options
- `VERSION` - PHP version to install

### Example
```bash
v-add-web-php 8.0
```
```

--------------------------------

### Example zstd.exe decompression command

Source: https://hestiacp.com/docs/server-administration/backup-restore

Example command to decompress a domain_data.tar.zst backup file using zstd.exe. Outputs a tar file.

```batch
C:\Users\{user}\Downloads\zstd-v1.4.4-win64\zstd.exe -d c:\Users\{user}\Downloads\admin.2021-06-27_05-48-23\web\{domain}\domain_data.tar.zst

```

--------------------------------

### v-list-dns-template example

Source: https://hestiacp.com/docs/reference/cli

Lists DNS template parameters for a specified template. Requires the template name as an argument.

```bash
v-list-dns-template zoho
```

--------------------------------

### v-restore-user command example

Source: https://hestiacp.com/docs/reference/cli

Restores a user from a backup archive. The archive must be placed in /backup before running this command.

```bash
v-restore-user admin 2019-04-22_01-00-00.tar
```

--------------------------------

### v-list-sys-php

Source: https://hestiacp.com/docs/reference/cli

Lists available PHP versions installed. Accepts an optional FORMAT parameter.

```APIDOC
## v-list-sys-php

### Description
Lists available PHP versions installed.

### Method
CLI

### Command
v-list-sys-php [FORMAT]

### Parameters
#### Options
- **FORMAT** (string) - Optional - Output format (e.g., json, shell, plain).

### Examples
```bash
v-list-sys-php json
```

```

--------------------------------

### Install Bats and test dependencies

Source: https://hestiacp.com/docs/contributing/development

Clones the Hestia repo with testing submodules and installs Bats. Use the second command for an existing local repo with an up-to-date main branch.

```bash
# Clone Hestia repo with testing submodules
git clone --recurse-submodules https://github.com/hestiacp/hestiacp
# Or, using an existing local repo with an up-to-date main branch
git submodule update --init --recursive

# Install Bats
test/test_helper/bats-core/install.sh /usr/local
```

--------------------------------

### v-add-mail-domain-catchall example

Source: https://hestiacp.com/docs/reference/cli

Adds a catchall account for a mail domain. Requires USER, DOMAIN, and EMAIL options.

```bash
v-add-mail-domain-catchall admin example.com master@example.com
```

--------------------------------

### v-add-sys-roundcube

Source: https://hestiacp.com/docs/reference/cli

Installs the Roundcube webmail client.

```APIDOC
## v-add-sys-roundcube

### Description
Installs the Roundcube webmail client.

### Method
CLI

### Command
v-add-sys-roundcube

### Parameters
- `MODE` (string) - Optional - Mode of operation.

### Example
```bash
v-add-sys-roundcube
```

```

--------------------------------

### v-rebuild-user command example

Source: https://hestiacp.com/docs/reference/cli

Rebuilds the system user account. Requires USER argument; optional RESTART parameter is accepted.

```bash
v-rebuild-user admin yes
```

--------------------------------

### v-list-sys-ip command example

Source: https://hestiacp.com/docs/reference/cli

Lists system IP parameters for the specified IP address. The IP argument is required.

```bash
v-list-sys-ip 203.0.113.1
```

--------------------------------

### Let's Encrypt validation log output example

Source: https://hestiacp.com/docs/server-administration/ssl-certificates

Example output from the Hestia log file when debugging a certificate request. Look for this step in /var/log/hestia/ and follow the URL in the JSON to see why validation failed.

```bash
==[Step 5]==
- status: 200
- nonce: 0004EDQMty6_ZOb1BdRQSc-debiHXGXaXbZuyySFU2xoogk
- validation: pending
- details:
- answer: HTTP/2 200
server: nginx
date: Wed, 21 Apr 2021 22:32:16 GMT
content-type: application/json
content-length: 186
boulder-requester: 80260362
cache-control: public, max-age=0, no-cache
link: <https://acme-v02.api.letsencrypt.org/directory>;rel="index"
link: <https://acme-v02.api.letsencrypt.org/acme/authz-v3/12520447717>;rel="up"
location: https://acme-v02.api.letsencrypt.org/acme/chall-v3/12520447717/scDRXA
replay-nonce: 0004EDQMty6_ZOb1BdRQSc-debiHXGXaXbZuyySFU2xoogk
x-frame-options: DENY
strict-transport-security: max-age=604800

{
  "type": "http-01",
  "status": "pending",
  "url": "https://acme-v02.api.letsencrypt.org/acme/chall-v3/12520447717/scDRXA",
  "token": "9yriok5bpLtV__m-rZ8f2tQmrfeQli0tCxSj4iNkv2Y"
}
```

--------------------------------

### Setup FTP backup server with v-add-backup-host

Source: https://hestiacp.com/docs/server-administration/backup-restore

Sets up an FTP backup server. Run as root. Replace the placeholders with your FTP host, username, password, path, and port.

```bash
v-add-backup-host 'ftp' 'remote.ftp-host.tld' 'backup-user' 'p4ssw0rd' '/path-backups/' 'port'

```

--------------------------------

### v-add-mail-domain-antispam example

Source: https://hestiacp.com/docs/reference/cli

Enables antispam support for a mail domain. Requires USER and DOMAIN options.

```bash
v-add-mail-domain-antispam admin mydomain.tld
```

--------------------------------

### dpkg dependency error example

Source: https://hestiacp.com/docs/contributing/building

Example error shown when dependencies are added or removed during package installation with dpkg. It indicates that dependency problems left the package unconfigured.

```bash
dpkg: error processing package hestia (–install):
dependency problems - leaving unconfigured
```

--------------------------------

### List user parameters with v-list-user

Source: https://hestiacp.com/docs/reference/cli

Displays parameters for the specified user, 'admin' in this example. Useful for retrieving user configuration details.

```bash
v-list-user admin
```

--------------------------------

### Setup SFTP backup server with v-add-backup-host (password and key-based)

Source: https://hestiacp.com/docs/server-administration/backup-restore

Sets up an SFTP backup server. The first command uses a password (stored as plain text on the server, accessible only by root). The second uses public/private keys (recommended) by specifying the private key path instead of a password.

```bash
v-add-backup-host 'sftp' 'remote.ftp-host.tld' 'backup-user' 'p4ssw0rd' '/path-backups/' 'port'

```

```bash
v-add-backup-host 'sftp' 'remote.ftp-host.tld' 'backup-user' '/root/id_rsa' '/path-backups/' 'port'

```

--------------------------------

### v-add-sys-sftp-jail example

Source: https://hestiacp.com/docs/reference/cli

Enables the sftp jailed environment. The RESTART option is set to 'yes' to restart the SSH service.

```bash
v-add-sys-sftp-jail yes
```

--------------------------------

### v-rebuild-mail-domains command example

Source: https://hestiacp.com/docs/reference/cli

Rebuilds EXIM configuration files for all mail domains of a user. Requires USER argument.

```bash
v-rebuild-mail-domains admin
```

--------------------------------

### Clean up after upgrade

Source: https://hestiacp.com/docs/server-administration/os-upgrades

Update package lists, install remaining upgrades, and remove unnecessary packages.

```bash
apt-get update
apt-get -y full-upgrade
apt-get autoremove
apt-get clean
```

--------------------------------

### v-restore-user-full-restic command example

Source: https://hestiacp.com/docs/reference/cli

Performs a full user restore from a Restic snapshot for a non-existing user.

```bash
v-restore-user-full-restic user snapshot key
```

--------------------------------

### v-rebuild-mail-domain command example

Source: https://hestiacp.com/docs/reference/cli

Rebuilds configuration files for a single mail domain. Requires USER and DOMAIN arguments.

```bash
v-rebuild-mail-domain user domain.tld
```

--------------------------------

### Install ca-certificates for SSL validation

Source: https://hestiacp.com/docs/introduction/getting-started.html

Installs the ca-certificate package to resolve SSL validation errors when downloading the installation script.

```bash
apt-get update && apt-get install ca-certificates
```

--------------------------------

### Build and install only Hestia

Source: https://hestiacp.com/docs/contributing/building

Builds and installs only the Hestia package. Use this if Hestia is already installed and you want your changes to take effect.

```bash
# Only Hestia
./hst_autocompile.sh --hestia --install '~localsrc'
```

--------------------------------

### v-add-mail-domain-antivirus example

Source: https://hestiacp.com/docs/reference/cli

Enables antivirus support for a mail domain. Requires USER and DOMAIN options.

```bash
v-add-mail-domain-antivirus admin mydomain.tld
```

--------------------------------

### Create a new theme CSS file

Source: https://hestiacp.com/docs/server-administration/customisation

Create a new theme by placing a CSS file in /usr/local/hestia/web/css/themes/custom/my_theme.css. The example styles the login and reset pages with a gradient background.

```css
.page-login,
.page-reset {
	height: auto;
	padding-top: 10%;
	background: rgb(231, 102, 194) !important;
	background: radial-gradient(circle, rgba(231, 102, 197, 1), rgba(174, 43, 177, 1)) !important;
}
```

--------------------------------

### v-add-user example

Source: https://hestiacp.com/docs/reference/cli

Creates a new user account with username 'user', password 'P4$$w@rD', and email 'bgates@aol.com'.

```bash
v-add-user user 'P4$$w@rD' bgates@aol.com
```

--------------------------------

### v-list-dnssec-public-key example

Source: https://hestiacp.com/docs/reference/cli

Lists the public DNSSEC key for a given user and domain. This key must be added to the domain registrar.

```bash
v-list-dns-public-key admin acme.com
```

--------------------------------

### zstd.exe decompression output example

Source: https://hestiacp.com/docs/server-administration/backup-restore

Example output from the zstd.exe decompression command, showing the file name and size.

```batch
C:\Users\{user}\Downloads\admin.2021-06-27_05-48-23\web\{domain}\domain_data.tar.zst: 61440 bytes

```

--------------------------------

### Download Hestia installation script

Source: https://hestiacp.com/docs/introduction/getting-started.html

Downloads the Hestia installation script for the latest release. Run as root from the terminal or via SSH.

```bash
wget https://raw.githubusercontent.com/hestiacp/hestiacp/release/install/hst-install.sh
```

--------------------------------

### v-add-sys-smtp-relay example

Source: https://hestiacp.com/docs/reference/cli

Adds system-wide SMTP relay support. The example specifies host srv.smtprelay.tld with username uname123 and password pass12345.

```bash
v-add-sys-smtp-relay srv.smtprelay.tld uname123 pass12345
```

--------------------------------

### Perform the system upgrade

Source: https://hestiacp.com/docs/server-administration/os-upgrades

Run the full upgrade with non-interactive frontend and force configuration file options to avoid prompts.

```bash
DEBIAN_FRONTEND=noninteractive UCF_FORCE_CONFFOLD=1 apt-get -y full-upgrade -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold"
```

--------------------------------

### Set hostname and enable Let's Encrypt for control panel

Source: https://hestiacp.com/docs/server-administration/ssl-certificates

Run these two commands to set the server hostname and generate a Let's Encrypt certificate for the control panel. Ensure the DNS hostname points to the server's IP address before running.

```bash
v-change-sys-hostname host.domain.tld
v-add-letsencrypt-host
```

--------------------------------

### Get mail domain value with v-get-mail-domain-value

Source: https://hestiacp.com/docs/reference/cli

Gets a certain mail domain parameter. Requires USER, DOMAIN, and KEY options.

```bash
v-get-mail-domain-value admin example.com DKIM
```

--------------------------------

### v-restore-web-domain command example

Source: https://hestiacp.com/docs/reference/cli

Restores a single web domain from a backup archive. The command uses placeholders for USER, BACKUP, DOMAIN, and optional NOTIFY.

```bash
v-restore-web-domain USER BACKUP DOMAIN [NOTIFY]
```

--------------------------------

### Get mail account value with v-get-mail-account-value

Source: https://hestiacp.com/docs/reference/cli

Gets a certain mail account parameter. Requires USER, DOMAIN, ACCOUNT, and KEY options.

```bash
v-get-mail-account-value admin example.tld tester QUOTA
```

--------------------------------

### List available APIs

Source: https://hestiacp.com/docs/reference/cli

Lists all available APIs, with output formatted as JSON.

```bash
v-list-apis json
```

--------------------------------

### v-list-database-host: List database host parameters

Source: https://hestiacp.com/docs/reference/cli

Lists database host parameters. TYPE and HOST are required, FORMAT is optional.

```bash
v-list-database-host mysql localhost
```

--------------------------------

### Build only Hestia package

Source: https://hestiacp.com/docs/contributing/building

Builds only the Hestia package without installing it. The --noinstall flag prevents installation, and --keepbuild preserves the build artifacts.

```bash
# Only Hestia
./hst_autocompile.sh --hestia --noinstall --keepbuild '~localsrc'
```

--------------------------------

### custom.sh example

Source: https://hestiacp.com/docs/server-administration/firewall

Example custom.sh script that creates a custom chain YOURCHAIN and applies it to all TCP ports. This script is executed by Hestia to customize iptables rules.

```bash
#!/bin/bash

IPTABLES="$(command -v iptables)"

$IPTABLES -N YOURCHAIN
$IPTABLES -F YOURCHAIN
$IPTABLES -I YOURCHAIN -s 0.0.0.0/0 -j RETURN
$IPTABLES -I INPUT -p TCP -m multiport --dports 1:65535 -j YOURCHAIN
```

--------------------------------

### v-add-web-domain-backend: Add web backend

Source: https://hestiacp.com/docs/reference/cli

Adds the web backend configuration for a domain.

```bash
v-add-web-domain-backend admin example.com default yes
```

--------------------------------

### List Database Hosts with v-list-database-hosts

Source: https://hestiacp.com/docs/server-administration/databases

Lists all database hosts to verify that the new host was added successfully.

```bash
v-list-database-hosts
```

--------------------------------

### Verify Rclone installation with test upload

Source: https://hestiacp.com/docs/server-administration/backup-restore

Verifies Rclone installation by uploading a test file to the configured remote and listing its contents. Requires environment variables HOST and FOLDER to be set.

```bash
echo "test" > /tmp/backuptest.txt
rclone cp /tmp/backuptest.txt $HOST:$FOLDER/backuptest.txt
rclone lsf $HOST:$FOLDER

```

--------------------------------

### v-dump-site: Dump site files to zip archive

Source: https://hestiacp.com/docs/reference/cli

Dumps site files into a zip archive. The example shows the basic usage and a full dump example. The output is saved to /backup/user.domain.timestamp.zip.

```bash
v-dump-site user domain
example: v-dump-site user domain full
```

--------------------------------

### v-get-sys-timezone

Source: https://hestiacp.com/docs/reference/cli

Gets the system timezone.

```APIDOC
## v-get-sys-timezone

### Description
Gets the system timezone.

### Method
CLI

### Command
`v-get-sys-timezone [FORMAT]`

### Parameters
- **FORMAT** (string) - Optional - The output format.

```

--------------------------------

### v-rebuild-dns-domain command example

Source: https://hestiacp.com/docs/reference/cli

Rebuilds DNS configuration files for a domain. Requires USER and DOMAIN arguments; optional RESTART and UPDATE_SERIAL parameters are accepted.

```bash
v-rebuild-dns-domain alice wonderland.com
```

--------------------------------

### Add database with v-add-database

Source: https://hestiacp.com/docs/reference/cli

Creates a database by concatenating the username and database name. The host is chosen by algorithm if not specified.

```bash
v-add-database admin wordpress_db matt qwerty123
```

--------------------------------

### Reboot VM

Source: https://hestiacp.com/docs/contributing/development

Reboots the VM after installation.

```bash
reboot
```

--------------------------------

### Move a user to a new server with v-backup-user and v-restore-user

Source: https://hestiacp.com/docs/server-administration/backup-restore

Steps to move a user to a new server: create a backup, copy the tarball to the new server's /backup directory, then restore it. The restore command can target a different user by changing the username. User accounts that do not exist will be created.

```bash
v-backup-user username

```

```bash
scp /backup/username.2020.01.01-00-00.tar root@host.domain.tld:/backup/

```

```bash
v-restore-user username username.2020.01.01-00-00.tar

```

--------------------------------

### v-unsuspend-database example

Source: https://hestiacp.com/docs/reference/cli

Unsuspends a specific database for a user.

```bash
v-unsuspend-database admin mydb
```

--------------------------------

### v-get-fs-file-type

Source: https://hestiacp.com/docs/reference/cli

Gets the file type of a specified file.

```APIDOC
## v-get-fs-file-type

### Description
Gets the file type of a specified file.

### Method
CLI

### Command
`v-get-fs-file-type USER FILE`

### Parameters
- **USER** (string) - Required - The username.
- **FILE** (string) - Required - The file path.

### Example
```bash
v-get-fs-file-type admin index.html
```

```

--------------------------------

### SSH into VM and navigate to /src

Source: https://hestiacp.com/docs/contributing/development

SSH into the VM as root and navigate to the /src directory to make changes.

```bash
multipass exec hestia-dev -- sudo bash
cd src
```

--------------------------------

### v-unsuspend-dns-domain example

Source: https://hestiacp.com/docs/reference/cli

Unsuspends a specific DNS domain for a user.

```bash
v-unsuspend-dns-domain alice wonderland.com
```

--------------------------------

### v-list-database: List database parameters

Source: https://hestiacp.com/docs/reference/cli

Lists all parameters for a database. USER and DATABASE are required, FORMAT is optional.

```bash
v-list-database wp_db
```

--------------------------------

### v-add-sys-filemanager

Source: https://hestiacp.com/docs/reference/cli

Installs the File Manager on the server for access through the Web interface.

```APIDOC
## v-add-sys-filemanager

### Description
Installs the File Manager on the server for access through the Web interface.

### Method
CLI

### Command
v-add-sys-filemanager

### Options
- `[MODE]` (string) - Optional - Mode for installation.
```

--------------------------------

### v-list-user-packages

Source: https://hestiacp.com/docs/reference/cli

Lists available hosting packages. Accepts an optional FORMAT argument.

```APIDOC
## v-list-user-packages

### Description
Lists available hosting packages.

### Command
`v-list-user-packages`

### Arguments
- **FORMAT** (string) - Optional - Output format.
```

--------------------------------

### v-unsuspend-domain example

Source: https://hestiacp.com/docs/reference/cli

Unsuspends web, DNS, and mail services for a domain.

```bash
v-unsuspend-domain admin acme.com
```

--------------------------------

### v-revoke-api-key command example

Source: https://hestiacp.com/docs/reference/cli

Revokes an API key by removing it from the $HESTIA/data/keys/ directory.

```bash
v-revoke-api-key mykey
```

--------------------------------

### Import database with v-import-database

Source: https://hestiacp.com/docs/reference/cli

Imports a database. Requires USER, DB, and PATH options.

```bash
v-import-database alice mydb /full/path/to.sql
```

--------------------------------

### v-get-dns-domain-value

Source: https://hestiacp.com/docs/reference/cli

Gets a DNS domain value. Options: USER DOMAIN KEY.

```APIDOC
## v-get-dns-domain-value

### Description
Get dns domain value.

### Options
- `USER` (string) - Required - The user name.
- `DOMAIN` (string) - Required - The domain name.
- `KEY` (string) - Required - The DNS record key.

### Examples
```bash
v-get-dns-domain-value admin example.com SOA
```
```

--------------------------------

### Import Cpanel backup with v-import-cpanel

Source: https://hestiacp.com/docs/reference/cli

Imports a Cpanel backup to a new user. Requires BACKUP and optional MX options. Based on sk-import-cpanel-backup-to-vestacp by Maks Usmanov (skamasle) and contributors.

```bash
v-import-cpanel /backup/backup.tar.gz yes
```

--------------------------------

### v-unsuspend-database-host example

Source: https://hestiacp.com/docs/reference/cli

Unsuspends a database server of the given type (e.g., mysql) and host.

```bash
v-unsuspend-database-host mysql localhost
```

--------------------------------

### v-rebuild-dns-domains command example

Source: https://hestiacp.com/docs/reference/cli

Rebuilds DNS configuration files for all domains of a user. Requires USER argument; optional RESTART and UPDATE_SERIAL parameters are accepted.

```bash
v-rebuild-dns-domains alice
```

--------------------------------

### v-list-sys-config

Source: https://hestiacp.com/docs/reference/cli

Lists system configuration parameters. Accepts an optional format argument.

```bash
v-list-sys-config json
```

--------------------------------

### v-delete-user-stats

Source: https://hestiacp.com/docs/reference/cli

Deletes user statistics data. The example shows usage with a user and domain.

```bash
v-delete-user-stats user
example: v-delete-user-stats admin overall
```

--------------------------------

### v-schedule-letsencrypt-domain

Source: https://hestiacp.com/docs/reference/cli

Adds a cronjob for Let's Encrypt SSL certificate installation for a specified domain.

```APIDOC
## v-schedule-letsencrypt-domain

### Description
Adds a cronjob for Let's Encrypt SSL certificate installation for a specified domain.

### Method
CLI

### Command
v-schedule-letsencrypt-domain

### Parameters
- **USER** (string) - Required - The Hestia user.
- **DOMAIN** (string) - Required - The domain for which to schedule the certificate installation.
- **ALIASES** (string) - Optional - Additional domain aliases.

### Example
```bash
v-schedule-letsencrypt-domain admin example.com www.example.com
```
```
Tokens:
Raw