Merge remote-tracking branch 'origin/main' into feature/osal

CHANGELOG.md

@@ -15,6 +15,7 @@ All notable changes to this project will be documented in this file.
     - Removed unnecessary tooltips from buttons and other elements.
     - Fixed incorrect tags which prevented tooltips from being displayed.
     - Introduced tooltips to counter items on the Users, Packages, and Statistics pages to help better distinguish statistics.
+- Improved the display of items, quotas, and suspended items in the Control Panel navigation header - thanks **@cmstew**!
 - Fixed an issue which caused higher than normal CPU usage during an upgrade due to a duplicate condition in the rebuild process.
 - Fixed minor spelling inconsistencies in command line script comments and output text.
 - Fixed an issue where old configuration files were not cleaned up when moving domains with `v-change-domain-owner`.
@@ -24,9 +25,9 @@ All notable changes to this project will be documented in this file.
 - Improved the quality of comment formatting in command line scripts - thanks **@bisubus**! 
 - Fixed an issue where the logo was not displayed in the File Manager - thanks **@robothemes**!
 - Fixed an issue in the Control Panel UI which caused databases and additional FTP accounts to be named incorrectly if manually prefaced with the username.
+- Fixed an issue where custom document roots were not saved correctly.
 - Improved the visibility of service availability in the Control Panel UI.
 
-
 ## [1.3.0] - Major Release (Feature / Quality Update)
 ### Features
 - Users can now choose to point a domain to a different document root location (similar to domain parking).

bin/v-acknowledge-user-notification

@@ -1,7 +1,9 @@
 #!/bin/bash
 # info: update user notification
 # options: USER NOTIFICATION
-# labels: 
+# labels: panel
+#
+# example: v-acknowledge-user-notification
 #
 # The function updates user notification.
 

bin/v-add-dns-domain

@@ -1,9 +1,9 @@
 #!/bin/bash
 # info: add dns domain
-# options: USER DOMAIN IP [NS1] [NS2] [NS3] [..] [NS8] [RESTART]
+# options: USER DOMAIN IP [NS1] [NS2] [NS3] [NS4] [NS5] [NS6] [NS7] [NS8] [RESTART]
 # labels: dns
 #
-# example: v-add-dns-domain admin example.com ns1.example.com ns2.example.com yes
+# example: v-add-dns-domain admin example.com ns1.example.com ns2.example.com '' '' '' '' '' '' yes
 #
 # The function adds DNS zone with records defined in the template. If the exp
 # argument isn't stated, the expiration date value will be set to next year.

bin/v-add-firewall-ipset

@@ -3,6 +3,8 @@
 # options: NAME [SOURCE] [IPVERSION] [AUTOUPDATE] [FORCE]
 # labels: hestia
 #
+# example: v-add-firewall-ipset country-nl 'http://ipverse.net/ipblocks/data/countries/nl.zone'
+#
 # The function adds new ipset to system firewall
 
 #----------------------------------------------------------#

bin/v-add-mail-account

@@ -3,7 +3,7 @@
 # options: USER DOMAIN ACCOUNT PASSWORD [QUOTA]
 # labels: mail
 #
-# example: v-add-mail-account john example.com john P4$$vvOrD
+# example: v-add-mail-account user example.com john P4$$vvOrD
 #
 # The function add new email account.
 

bin/v-add-remote-dns-host

@@ -4,8 +4,12 @@
 # labels: dns
 #
 # example: v-add-remote-dns-host slave.your_host.com 8083 admin your_passw0rd
+# 
+# example: v-add-remote-dns-host slave.your_host.com 8083 api_key ''
 #
 # The function adds remote dns server to the dns cluster.
+# As alternative api_key generated on the slave server.
+# See v-generate-api-key can be used to connect the remote dns server
 
 
 #----------------------------------------------------------#

bin/v-add-sys-firewall

@@ -3,6 +3,8 @@
 # options: NONE
 # labels: 
 #
+# example: v-add-sys-firewall
+#
 # The script enables firewall
 
 

bin/v-add-sys-quota

@@ -3,7 +3,10 @@
 # options: NONE
 # labels: 
 #
+# example: v-add-sys-quota
+#
 # The script enables filesystem quota on /home partition
+# Some kernels do require additional packages to be installed first
 
 
 #----------------------------------------------------------#

bin/v-add-sys-sftp-jail

@@ -3,6 +3,8 @@
 # options: [RESTART]
 # labels: 
 #
+# example: v-add-sys-sftp-jail yes
+#
 # The script enables sftp jailed environment
 
 

bin/v-add-sys-theme

@@ -3,8 +3,12 @@
 # options: THEME [MODE] [ACTIVE]
 # labels: hestia
 #
+# example: v-add-sys-theme myTheme local 
+#
 # The function for installing a custom theme or downloading one
 # from the HestiaCP theme repository.
+# For more info see https://docs.hestiacp.com/customize_hestia.html
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #

bin/v-add-sys-webmail

@@ -3,6 +3,8 @@
 # options: USER DOMAIN [RESTART] [QUIET]
 # labels: hestia
 #
+# example: v-add-sys-webmail user domain.com
+#
 # this function adds support for webmail services
 # to a mail domain.
 

bin/v-add-user-composer

@@ -3,6 +3,8 @@
 # options: USER
 # labels: hestia
 #
+# example: v-add-user-composer user
+#
 # The function adds support for composer (php dependency manager)
 # Homepage: https://getcomposer.org/
 

bin/v-add-user-ssh-key

@@ -3,6 +3,8 @@
 # options: USER KEY
 # labels: hestia
 #
+# example: v-add-user-ssh-key user 'valid ssh key'
+#
 # Function check if $user/.ssh/authorized_keys exists and create it.
 # After that it append the new key(s)
 

bin/v-add-web-domain-ssl

@@ -97,6 +97,10 @@ if [ -e "$USER_DATA/ssl/$domain.ca" ]; then
     cp -f $USER_DATA/ssl/$domain.ca $HOMEDIR/$user/conf/web/$domain/ssl/$domain.ca
 fi
 
+if [ "$SSL_FORCE" == "yes" ]; then
+    # Enabling SSL redirection on demand
+    $BIN/v-add-web-domain-ssl-force "$user" "$domain"
+fi
 # Parsing domain values
 get_domain_values 'web'
 local_ip=$(get_real_ip $IP)
@@ -124,9 +128,6 @@ increase_user_value "$user" '$U_WEB_SSL'
 update_object_value 'web' 'DOMAIN' "$domain" '$SSL_HOME' "$SSL_HOME"
 update_object_value 'web' 'DOMAIN' "$domain" '$SSL' "yes"
 
-# Enabling automatic SSL redirection
-$BIN/v-add-web-domain-ssl-force "$user" "$domain"
-
 # Restarting web server
 $BIN/v-restart-web $restart
 check_result $? "Web restart failed" >/dev/null

bin/v-add-web-domain-ssl-force

@@ -70,6 +70,8 @@ else
     echo 'RewriteRule ^(.*)$ https://%{HTTP_HOST}$1 [R=301,L]' >> $forcessl
 fi
 
+chown root:$user $forcessl
+chmod 640 $forcessl
 
 #----------------------------------------------------------#
 #                       Hestia                             #

bin/v-add-web-domain-ssl-hsts

@@ -56,6 +56,8 @@ fi
 
 echo 'add_header Strict-Transport-Security "max-age=15768000;" always;' > $hstsconf
 
+chown root:$user $hstsconf
+chmod 640 $hstsconf
 
 #----------------------------------------------------------#
 #                       Hestia                             #

bin/v-add-web-domain-ssl-preset

@@ -0,0 +1,58 @@
+#!/bin/bash
+# info: Adding force SSL for a domain
+# options: USER DOMAIN [SSL] 
+# labels: hestia web
+#
+# example: v-add-web-domain-ssl-preset
+#
+# Up on creating an web domain set the SSL Force values due to the delay of LE due to DNS propergation over DNS cluster
+# When LE has been activated it will set the actions
+
+#----------------------------------------------------------#
+#                    Variable&Function                     #
+#----------------------------------------------------------#
+
+# Argument definition
+user=$1
+domain=$2
+ssl=$3
+
+# Includes
+source $HESTIA/func/main.sh
+source $HESTIA/conf/hestia.conf
+
+#----------------------------------------------------------#
+#                    Verifications                         #
+#----------------------------------------------------------#
+
+check_args '2' "$#" 'USER DOMAIN [SSL]'
+is_format_valid 'user' 'domain' 'ssl'
+is_object_valid 'user' 'USER' "$user"
+is_object_unsuspended 'user' 'USER' "$user"
+is_object_valid 'web' 'DOMAIN' "$domain"
+is_object_unsuspended 'web' 'DOMAIN' "$domain"
+
+# Perform verification if read-only mode is enabled
+check_hestia_demo_mode
+
+#----------------------------------------------------------#
+#                       Action                             #
+#----------------------------------------------------------#
+
+# Load domain data
+parse_object_kv_list $(grep "DOMAIN='$domain'" $USER_DATA/web.conf)
+
+if [  "$ssl" = "yes" ]; then
+    if [ -z "$SSL_FORCE" ]; then
+    add_object_key "web" 'DOMAIN' "$domain" 'SSL_FORCE' 'SSL_HOME'
+    fi
+
+    # Set forcessl flag to enabled
+    update_object_value 'web' 'DOMAIN' "$domain" '$SSL_FORCE' 'yes'
+fi
+
+# Logging
+log_history "Set values SSL FORCE / HSTS for $domain"
+log_event "$OK" "$ARGUMENTS"
+
+exit

bin/v-add-web-php

@@ -3,6 +3,8 @@
 # options: VERSION
 # labels: hestia
 #
+# example: v-add-web-php 7.4
+#
 # The function checks and delete a fpm php version if not used by any domain.
 
 

bin/v-backup-users

@@ -3,6 +3,8 @@
 # options: NONE
 # labels: 
 #
+# example: v-backup-users
+#
 # The function backups all system users.
 
 

bin/v-change-user-php-cli

@@ -1,9 +1,12 @@
 #!/bin/bash
-# info: add php version to .bash_aliases
+# info: add php  version alias to .bash_aliases
 # options: USER VERSION
 # labels: hestia
 #
-# add line to .bash_aliases to set default php incase of multiPHP
+# example: v-change-user-php-cli user php7.4
+#
+# add line to .bash_aliases to set default php command line
+# version when multi-php is enabled.
 
 
 #----------------------------------------------------------#

bin/v-change-user-role

@@ -3,7 +3,9 @@
 # options: USER ROLE
 # labels: hestia
 #
-# The function changes user's role.
+# example: v-change-user-role user administrator
+#
+# Give/revoke user administrator rights to manage all accounts as admin 
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #

bin/v-change-web-domain-backend-tpl

@@ -3,7 +3,7 @@
 # options: USER DOMAIN TEMPLATE [RESTART]
 # labels: web
 #
-# example: v-change-web-domain-backend-tpl admin acme.com socket
+# example: v-change-web-domain-backend-tpl admin acme.com PHP-7_4
 #
 # The function changes backend template
 

bin/v-change-web-domain-dirlist

@@ -3,6 +3,8 @@
 # options: USER DOMAIN MODE
 # labels: hestia
 #
+# example: v-change-web-domain-dirlist user demo.com on
+#
 # The call is used for changing the directory list mode.
 
 

bin/v-change-web-domain-docroot

@@ -80,21 +80,28 @@ if [ "$target_domain" = "default" ]; then
     update_object_value 'web' 'DOMAIN' "$domain" '$CUSTOM_PHPROOT' "" 
 else
     # Check for existence of specified directory under target domain's public_html folder
+    target_domain_directory="$HOMEDIR/$user/web/$target_domain"
     if [ ! -z "$target_directory" ]; then
-        if [ ! -e "$HOMEDIR/$user/web/$target_domain/public_html/$target_directory" ]; then
-            echo "ERROR: Directory $target_directory does not exist under $HOMEDIR/$user/$target_domain/public_html/."
-            exit 1
+
+        # Checking destination path
+        real_target_directory="$(readlink -e "${target_domain_directory}/public_html/$target_directory/")"
+        if [ -z "$(echo $real_target_directory | egrep "^$target_domain_directory\b")" ]; then
+            check_result $E_FORBIDEN "Error: target dir outside of target domain dir"
+        fi
+
+        if [ ! -e "$real_target_directory" ]; then
+            check_result $E_NOTEXIST "ERROR: Directory $target_directory does not exist under $HOMEDIR/$user/$target_domain/public_html/."
         else
-            CUSTOM_DOCROOT="$HOMEDIR/$user/web/$target_domain/public_html/$target_directory/"
+            CUSTOM_DOCROOT="$real_target_directory"
             if [ ! -z "$php" ]; then
-                custom_phproot="$HOMEDIR/$user/web/$target_domain/public_html/"
+                custom_phproot="${target_domain_directory}/public_html/"
             else
-                custom_phproot="$HOMEDIR/$user/web/$target_domain/public_html/$target_directory/"
+                custom_phproot="$real_target_directory"
             fi
         fi
     else
-        CUSTOM_DOCROOT="$HOMEDIR/$user/web/$target_domain/public_html/"
-        custom_phproot="$HOMEDIR/$user/web/$target_domain/public_html/"
+        CUSTOM_DOCROOT="${target_domain_directory}/public_html/"
+        custom_phproot="${target_domain_directory}/public_html/"
     fi
     
     add_object_key 'web' 'DOMAIN' "$domain" 'CUSTOM_DOCROOT' 'IP6'

bin/v-check-api-key

@@ -3,6 +3,8 @@
 # options: KEY [IP]
 # labels: 
 #
+# example: v-check-api-key random_key 127.0.0.1
+#
 # The function checks a key file in $HESTIA/data/keys/
 
 

bin/v-copy-user-package

@@ -3,6 +3,8 @@
 # options: PACKAGE NEW_PACKAGE
 # labels: hestia
 #
+# example: v-copy-user-package default new
+# 
 # The function allows the user to duplicate an existing
 # package file to facilitate easier configuration.
 

bin/v-delete-cron-hestia-autoupdate

@@ -1,7 +1,7 @@
 #!/bin/bash
 # info: delete hestia autoupdate cron job
 # options: NONE
-# labels: 
+# labels: hestia
 #
 # The function deletes hestia autoupdate cron job.
 

bin/v-delete-firewall-ipset

@@ -3,6 +3,8 @@
 # options: NAME
 # labels: hestia
 #
+# example: v-delete-firewall-ipset country-nl
+#
 # The function removes ipset from system and from hestia
 
 

bin/v-delete-mail-domain-ssl

@@ -3,6 +3,8 @@
 # options: USER DOMAIN
 # labels: hestia
 #
+# example: v-delete-mail-domain-ssl user demo.com
+#
 # The function delete ssl certificates.
 
 #----------------------------------------------------------#

bin/v-delete-sys-filemanager

@@ -3,6 +3,8 @@
 # options: [FULL]
 # labels: hestia
 #
+# example: v-delete-sys-filemanager
+#
 # The function removes the File Manager and its entry points
 
 #----------------------------------------------------------#

bin/v-delete-sys-firewall

@@ -3,6 +3,8 @@
 # options: NONE
 # labels: panel
 #
+# example: v-delete-sys-firewall
+#
 # The script disables firewall support
 
 

bin/v-delete-sys-quota

@@ -3,6 +3,8 @@
 # options: NONE
 # labels: panel
 #
+# example: v-delete-sys-quota
+#
 # The script disables filesystem quota on /home partition
 
 

bin/v-delete-sys-sftp-jail

@@ -3,6 +3,8 @@
 # options: NONE
 # labels: panel
 #
+# example: v-delete-sys-sftp-jail 
+#
 # The script disables sftp jailed environment
 
 

bin/v-delete-sys-theme

@@ -1,9 +1,12 @@
 #!/bin/bash
 # info: removes a theme from the custom theme library
-# options: [RESTART]
+# options: theme
 # labels: hestia
 #
-# The function removes a theme from the custom theme library.
+# example: v-delete-sys-theme dark
+#
+# The function removes a theme from the custom theme library. 
+# Please note "default" theme can't be deleted due to dependencies for other themes
 
 
 #----------------------------------------------------------#

bin/v-delete-sys-webmail

@@ -3,6 +3,8 @@
 # options: USER DOMAIN [RESTART] [QUIET]
 # labels: hestia
 #
+# example: v-delete-sys-webmail user demo.com
+#
 # this function removes support for webmail from
 # a specified mail domain.
 

bin/v-delete-user-log

@@ -3,6 +3,8 @@
 # options: USER
 # labels: hestia
 #
+# example: v-delete-user-log user 
+#
 # The function for deleting a users log file
 
 #----------------------------------------------------------#

bin/v-delete-user-notification

@@ -3,7 +3,7 @@
 # options: USER NOTIFICATION
 # labels: panel
 #
-# example: v-delete-user-notification admin "Hello, admin!"
+# example: v-delete-user-notification admin 1
 #
 # The function deletes user notification.
 

bin/v-delete-user-ssh-key

@@ -3,8 +3,9 @@
 # options: USER KEY
 # labels: hestia
 #
-# Function check if $user/.ssh/authorized_keys exists and create it.
-# After that it append the new key(s)
+# example: v-delete-user-ssh-key user unique_id
+#
+# Delete user ssh key from authorized_keys
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #

bin/v-delete-web-domain-ssl-hsts

@@ -3,6 +3,8 @@
 # options: USER DOMAIN [RESTART]
 # labels: hestia
 #
+# example: v-delete-web-domain-ssl-hsts user domain.tld
+#
 # The function removes force SSL configurations.
 
 

bin/v-delete-web-php

@@ -3,6 +3,8 @@
 # options: VERSION
 # labels: hestia
 #
+# example: v-delete-web-php 7.3
+#
 # The function checks and delete a fpm php version if not used by any domain.
 
 

bin/v-download-backup

@@ -3,6 +3,8 @@
 # options: USER BACKUP
 # labels: hestia
 #
+# example: v-download-backup admin admin.2020-11-05_05-10-21.tar
+#
 # The function download back-up from remote server
 
 

bin/v-generate-api-key

@@ -3,6 +3,8 @@
 # options: NONE
 # labels: panel
 #
+# example: v-generate-api-key 
+#
 # The function creates a key file in $HESTIA/data/keys/
 
 

bin/v-get-sys-timezones

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-get-sys-timezones json
+#
 # The function checks system timezone settings
 
 

bin/v-list-database-hosts

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-database-hosts json
+#
 # The function for obtaining the list of all configured database hosts.
 
 

bin/v-list-database-types

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-database-types json
+#
 # The function for obtaining the list of database types.
 
 

bin/v-list-databases

@@ -3,6 +3,8 @@
 # options: USER [FORMAT]
 # labels: panel
 #
+# example: v-list-databases user json
+#
 # The function for obtaining the list of all user's databases.
 
 

bin/v-list-dns-templates

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: dns
 #
+# example: v-list-dns-templates json
+#
 # The function for obtaining the list of all DNS templates available.
 
 

bin/v-list-firewall

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-firewall json
+#
 # The function of obtaining the list of all iptables rules.
 
 

bin/v-list-firewall-ban

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-firewall-ban json
+#
 # The function of obtaining the list of currently blocked ips.
 
 

bin/v-list-firewall-ipset

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: hestia
 #
+# example: v-list-firewall-ipset json
+#
 # The function prints defined ipset lists
 
 

bin/v-list-mail-domain-ssl

@@ -3,6 +3,8 @@
 # options: USER DOMAIN [FORMAT]
 # labels: hestia
 #
+# example: v-list-mail-domain-ssl user acme.com json
+#
 # The function of obtaining domain ssl files.
 
 

bin/v-list-remote-dns-hosts

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-remote-dns-hosts json
+#
 # The function for obtaining the list of remote dns host.
 
 

bin/v-list-sys-clamd-config

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-sys-clamd-config
+#
 # The function for obtaining the list of clamd config parameters.
 
 

bin/v-list-sys-config

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-sys-config json
+#
 # The function for obtaining the list of system parameters.
 
 

bin/v-list-sys-cpu-status

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-sys-cpu-status
+#
 # The function lists cpu information
 
 

bin/v-list-sys-db-status

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# v-list-sys-db-status
+#
 # The function lists db server status
 
 

bin/v-list-sys-disk-status

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-sys-disk-status
+#
 # The function lists disk information
 
 

bin/v-list-sys-dns-status

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-sys-dns-status
+#
 # The function lists dns server status
 
 

bin/v-list-sys-dovecot-config

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-sys-dovecot-config
+#
 # The function for obtaining the list of dovecot config parameters.
 
 

bin/v-list-sys-hestia-autoupdate

@@ -3,7 +3,9 @@
 # options: [FORMAT]
 # labels: 
 #
-# The function for obtaining autoupdate setings.
+# example: v-list-sys-hestia-autoupdate
+#
+# The function for obtaining autoupdate settings.
 
 
 #----------------------------------------------------------#

bin/v-list-sys-hestia-ssl

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-sys-hestia-ssl
+#
 # The function of obtaining hestia ssl files.
 
 

bin/v-list-sys-hestia-updates

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-sys-hestia-updates
+#
 # The function checks available updates for hestia packages.
 
 

bin/v-list-sys-info

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-sys-info
+#
 # The function checks available updates for hestia packages.
 
 

bin/v-list-sys-interfaces

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-sys-interfaces
+#
 # The function for obtaining the list of network interfaces.
 
 

bin/v-list-sys-ips

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-sys-ips
+#
 # The function for obtaining the list of system ip adresses.
 
 

bin/v-list-sys-languages

@@ -1,10 +1,12 @@
 #!/bin/bash
-# info: list system users
+# info: list system languages
 # options: [FORMAT]
 # labels: panel
 #
-# The function for obtaining the list of system users without
-# detailed information.
+# example: v-list-sys-languages json
+#
+# The function for obtaining the available languages for HestiaCP
+# Output is always in the ISO language code
 
 
 #----------------------------------------------------------#

bin/v-list-sys-mail-status

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: mail
 #
+# example: v-list-sys-mail-status json
+#
 # The function lists mail server status
 
 

bin/v-list-sys-memory-status

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-sys-memory-status json
+#
 # The function lists virtual memory information
 
 

bin/v-list-sys-mysql-config

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-sys-mysql-config
+#
 # The function for obtaining the list of mysql config parameters.
 
 

bin/v-list-sys-network-status

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: 
 #
+# example: v-list-sys-network-status json
+#
 # The function lists network status
 
 

bin/v-list-sys-nginx-config

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-sys-nginx-config 
+#
 # The function for obtaining the list of nginx config parameters.
 
 

bin/v-list-sys-pgsql-config

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-sys-pgsql-config
+#
 # The function for obtaining the list of postgresql config parameters.
 
 

bin/v-list-sys-php

@@ -1,9 +1,11 @@
 #!/bin/bash
 # info: listing availble PHP versions installed
 # options: [FORMAT]
-# labels: hestia
+# labels: hestia panel
 #
-# List /etc/php/* version check if folder fpm is avalible
+# example: v-list-sys-php
+#
+# List /etc/php/* version check if folder fpm is available
 
 
 #----------------------------------------------------------#

bin/v-list-sys-php-config

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-sys-php-config
+#
 # The function for obtaining the list of php config parameters.
 
 

bin/v-list-sys-proftpd-config

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-sys-proftpd-config
+#
 # The function for obtaining the list of proftpd config parameters.
 
 

bin/v-list-sys-rrd

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-sys-rrd
+#
 # List available rrd graphics, its titles and paths.
 
 

bin/v-list-sys-services

@@ -1,7 +1,9 @@
 #!/bin/bash
 # info: list system services
 # options: [FORMAT]
-# labels: 
+# labels: panel
+#
+# example: v-list-sys-services json
 #
 # The function for obtaining the list of configured system services.
 

bin/v-list-sys-shells

@@ -1,7 +1,9 @@
 #!/bin/bash
 # info: list system shells
 # options: [FORMAT]
-# labels: 
+# labels: panel
+# 
+# example: v-list-sys-shells
 #
 # The function for obtaining the list of system shells.
 

bin/v-list-sys-spamd-config

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-sys-spamd-config
+#
 # The function for obtaining the list of spamassassin config parameters.
 
 

bin/v-list-sys-themes

@@ -1,8 +1,10 @@
 #!/bin/bash
-# info: list web templates
+# info: list system themes
 # options: [FORMAT]
 # labels: hestia
 #
+# example: v-list-sys-themes
+#
 # The function for obtaining the list of themes in the theme
 # library and displaying them in the backend or user interface.
 

bin/v-list-sys-users

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-sys-users 
+#
 # The function for obtaining the list of system users without
 # detailed information.
 

bin/v-list-sys-vsftpd-config

@@ -1,7 +1,9 @@
 #!/bin/bash
 # info: list vsftpd config parameters
 # options: [FORMAT]
-# labels: 
+# labels: panel
+#
+# example: v-list-sys-vsftpd-config
 #
 # The function for obtaining the list of vsftpd config parameters.
 

bin/v-list-sys-web-status

@@ -1,7 +1,9 @@
 #!/bin/bash
 # info: list web status
 # options: [FORMAT]
-# labels: 
+# labels: panel
+#
+# example: v-list-sys-web-status
 #
 # The function lists web server status
 

bin/v-list-user-log

@@ -3,6 +3,8 @@
 # options: USER [FORMAT]
 # labels: 
 #
+# example: v-list-user-log
+#
 # The function of obtaining the list of 100 last users commands.
 
 

bin/v-list-users

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: panel
 #
+# example: v-list-users
+#
 # The function to obtain the list of all system users.
 
 

bin/v-list-web-stats

@@ -1,7 +1,9 @@
 #!/bin/bash
 # info: list web statistics
 # options: [FORMAT]
-# labels: web
+# labels: web panel
+#
+# example: v-list-web-stats 
 #
 # The function for obtaining the list of web statistics analyzer.
 

bin/v-list-web-templates

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: web
 #
+# example: v-list-web-templates
+#
 # The function for obtaining the list of web templates available to a user.
 
 

bin/v-list-web-templates-backend

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: web
 #
+# example: v-list-web-templates-backend
+#
 # The function for obtaining the list of available backend templates.
 
 

bin/v-list-web-templates-proxy

@@ -3,6 +3,8 @@
 # options: [FORMAT]
 # labels: web
 #
+# example: v-list-web-templates-proxy
+#
 # The function for obtaining the list of proxy templates available to a user.
 
 

bin/v-rebuild-database

@@ -3,6 +3,8 @@
 # options: USER DATABASE
 # labels: hestia
 #
+# example: v-rebuild-database user user_wordpress
+#
 # The function for rebuilding a single database for a user
 
 

bin/v-rebuild-mail-domain

@@ -3,6 +3,8 @@
 # options: USER DOMAIN
 # labels: hestia
 #
+# example: v-rebuild-mail-domain user domain.tld
+#
 # The function rebuilds configuration files for a single domain.
 
 

bin/v-rebuild-users

@@ -1,9 +1,11 @@
 #!/bin/bash
-# info: rebuild system user
+# info: rebuild system users
 # options: [RESTART]
 # labels: hestia
 #
-# The function rebuilds system user accounts.
+# example: v-rebuild-users
+#
+# The function all users on the system.
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #

bin/v-rebuild-web-domain

@@ -3,6 +3,8 @@
 # options: USER DOMAIN [RESTART]
 # labels: hestia
 #
+# example: v-rebuild-web-domain user domain.tld 
+#
 # The function rebuilds web configuration files.
 
 

bin/v-rebuild-web-domains

@@ -3,6 +3,8 @@
 # options: USER [RESTART]
 # labels: 
 #
+# example: v-rebuild-web-domains
+#
 # The function rebuilds web configuration files.
 
 

bin/v-refresh-sys-theme

@@ -3,6 +3,8 @@
 # options: NONE
 # labels: hestia
 #
+# example: v-refresh-sys-theme
+#
 # The function for changing the currently active system theme.
 
 #----------------------------------------------------------#

bin/v-rename-package

@@ -3,6 +3,8 @@
 # options: OLD_NAME NEW_NAME
 # labels: hestia
 #
+# example: v-rename-package package package2
+#
 # The function changes the name of an existing package.
 
 

bin/v-restart-cron

@@ -3,6 +3,8 @@
 # options: NONE
 # labels: panel
 #
+# example: v-restart-cron
+#
 # The function tells crond service to reread its configuration files.
 
 

bin/v-restart-dns

@@ -3,6 +3,8 @@
 # options: NONE
 # labels: dns
 #
+# example: v-restart-dns
+#
 # The function tells BIND service to reload dns zone files.
 
 

bin/v-restart-ftp

@@ -3,6 +3,8 @@
 # options: NONE
 # labels: panel
 #
+# example: v-restart-ftp
+#
 # The function tells ftp server to reread its configuration.
 
 

bin/v-restart-mail

@@ -3,6 +3,8 @@
 # options: NONE
 # labels: mail
 #
+# example: v-restart-mail
+#
 # The function tells exim or dovecot services to reload configuration files.