Make more changes

bin/v-acknowledge-user-notification

@@ -1,10 +1,15 @@
 #!/bin/bash
-# info: update user notification
+# info: Acknowledge user notification
 # options: USER NOTIFICATION
+# variable: USER | Username used for testing
+# variable: NOTIFICATION | Notification ID or "all"
+# example: v-acknowledge-user-notification user 1
+# example: v-acknowledge-user-notification user all
 #
-# example: v-acknowledge-user-notification
+# This function acknowledge user notification.
 #
-# This function updates user notification.
+# note: Used only for testing
+
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

bin/v-add-access-key

@@ -1,5 +1,5 @@
 #!/bin/bash
-# info: generate access key
+# info: Generate access key
 # options: USER [PERMISSIONS] [COMMENT] [FORMAT]
 #
 # example: v-add-access-key admin v-purge-nginx-cache,v-list-mail-accounts comment json

bin/v-add-backup-host

@@ -1,11 +1,12 @@
 #!/bin/bash
-# info: add backup host
+# info: Add backup host
 # options: TYPE HOST USERNAME PASSWORD [PATH] [PORT]
 #
-# example: v-add-backup-host sftp backup.acme.com admin p4$$w@Rd
-#          v-add-backup-host b2 bucketName keyID applicationKey
+# example: v-add-backup-host sftp backup.acme.com admin 'p4$$w@Rd'
 #
-# Add a new remote backup location. Currently SFTP, FTP and Backblaze are supported
+# example: v-add-backup-host 'rclone' 'remote-name' '' '' 'Bucket or Folder name' ''
+#
+# Add a new remote backup location. Currently SFTP, FTP and RCONE are supported
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

bin/v-add-cron-hestia-autoupdate

@@ -1,5 +1,5 @@
 #!/bin/bash
-# info: add cron job for hestia automatic updates
+# info: Add cron job for hestia automatic updates
 # options: MODE
 #
 # This function adds a cronjob for hestia automatic updates

bin/v-add-cron-job

@@ -1,11 +1,15 @@
 #!/bin/bash
-# info: add cron job
+# info: Creates a new cronjob
 # options: USER MIN HOUR DAY MONTH WDAY COMMAND [JOB] [RESTART]
 #
-# example: v-add-cron-job admin * * * * * sudo /usr/local/hestia/bin/v-backup-users
+# variable: COMMAND | Command to executed. For security reasons sudo can't be used anymore. Make sure to use full paths as path variables may no bee loaded on default
 #
-# This function adds a job to cron daemon. When executing commands, any output
-# is mailed to user's email if parameter REPORTS is set to 'yes'.
+# variable: JOB | ID (Numeric) is only used for sorting in Hestia
+#
+# example: v-add-cron-job user '*' '*' '*' '*' '*'  '/usr/bin/php /home/user/web/domain/public_html/wp-cron.php'
+#
+# This function adds a job to cron daemon. When executing commands, any output is mailed to user's email. Output can be muted by using [v-delete-cron-reports](/docs/reference/cli.html#v-delete-cron-reports) for the user in general or by appending `> /dev/null 2>&1` to the command.
+
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

bin/v-add-cron-letsencrypt-job

@@ -1,5 +1,5 @@
 #!/bin/bash
-# info: add cron job for Let's Encrypt certificates
+# info: Add cron job for Let's Encrypt certificates
 # options: NONE
 #
 # This function adds a new cron job for Let's Encrypt.

bin/v-add-cron-reports

@@ -1,8 +1,8 @@
 #!/bin/bash
-# info: add cron reports
+# info: Add cron reports
 # options: USER
 #
-# example: v-add-cron-reports admin
+# example: v-add-cron-reports user
 #
 # This function for enabling reports on cron tasks and administrative
 # notifications.

bin/v-add-cron-restart-job

@@ -1,5 +1,5 @@
 #!/bin/bash
-# info: add cron reports
+# info: Enable the restart cronjob
 # options: NONE
 #
 # This function for enabling restart cron tasks

bin/v-add-database

@@ -1,8 +1,8 @@
 #!/bin/bash
-# info: add database
+# info: Add database
 # options: USER DATABASE DBUSER DBPASS [TYPE] [HOST] [CHARSET]
 #
-# example: v-add-database admin wordpress_db matt qwerty123
+# example: v-add-database user wordpress_db matt qwerty123
 #
 # This function creates the database concatenating username and user_db.
 # Supported types of databases you can get using v-list-sys-config script.

bin/v-add-database-host

@@ -1,5 +1,5 @@
 #!/bin/bash
-# info: add new database server
+# info: Add new database server
 # options: TYPE HOST DBUSER DBPASS [MAX_DB] [CHARSETS] [TEMPLATE] [PORT]
 #
 # example: v-add-database-host mysql localhost alice p@$$wOrd

bin/v-add-database-temp-user

@@ -1,5 +1,5 @@
 #!/bin/bash
-# info: add temp database user.
+# info: Adds a temporary database user to a mysql database.
 # options: USER DATABASE [TYPE] [HOST] [TTL]
 #
 # example: v-add-database-temp-user wordress wordpress_db mysql

bin/v-add-dns-domain

@@ -9,6 +9,8 @@
 # The soa argument is responsible for the relevant record. By default the first
 # user's NS server is used. TTL is set as common for the zone and for all of
 # its records with a default value of 14400 seconds.
+#
+# note: DNSEC can only be used with Hestia Master -> Slave
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #
@@ -50,7 +52,7 @@ domain_utf=$(idn2 --quiet -d "$domain_idn")
 #                    Verifications                         #
 #----------------------------------------------------------#
 
-check_args '3' "$#" 'USER DOMAIN IP [NS1] [NS2] [NS3] [..] [NS8] [RESTART]'
+check_args '3' "$#" 'USER DOMAIN IP [NS1] [NS2] [NS3] [..] [NS8] [RESTART] [DNSSEC]'
 is_format_valid 'user' 'domain' 'ip'
 is_system_enabled "$DNS_SYSTEM" 'DNS_SYSTEM'
 is_object_valid 'user' 'USER' "$user"

bin/v-add-letsencrypt-domain

@@ -1,11 +1,11 @@
 #!/bin/bash
-# info: check letsencrypt domain
+# info: Generate Lets Encrypt certificate for provided domain and aliases.
 # options: USER DOMAIN [ALIASES] [MAIL]
-#
-# example: v-add-letsencrypt-domain admin wonderland.com www.wonderland.com,demo.wonderland.com
-# example: v-add-letsencrypt-domain admin wonderland.com '' yes
-#
-# This function check and validates domain with Let's Encrypt
+# variable: ALIASES | Comma separated list of aliases to be addd to the certificate this could contain up to 100 different domains / subdomain need to be under "ALIASES" under web
+# variable: MAIL | Enable Lets encrypt from mail and webmail
+# example: v-add-letsencrypt-domain user domain.com 'www.domain.com,demo.domain.com'
+# example: v-add-letsencrypt-domain user domain.com '' yes
+# note: Wildcard domains *.domain.com are supported only when DNS via Hestia is used.
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

bin/v-add-sys-dependencies

@@ -1,8 +1,8 @@
 #!/bin/bash
 # info: Adds / Update  PHP  dependencies to Hestia
-# options:
+# options: NONE
 #
-# example: v-sys-dependencies
+# example: v-add-sys-dependencies
 #
 # This script download System Dependencies for Web UI. PHP Mailer, phpquoteshellarg and twofactorauth.
 

bin/v-change-cron-job

@@ -2,11 +2,13 @@
 # info: change cron job
 # options: USER JOB MIN HOUR DAY MONTH WDAY COMMAND
 #
-# example: v-change-cron-job admin 7 * * * * * /usr/bin/uptime
+# example: v-change-cron-job user 7 * * * * * *  '/usr/bin/php /home/user/web/domain/public_html/wp-cron.php'
 #
 # This function is used for changing existing job. It fully replace job
 # parameters with new one but with same id.
-
+# Change CRON_REPORTS value via:
+# [v-add-cron-reports](https://hestiacp.com/docs/reference/cli.html#v-add-cron-reports) and
+# [v-delete-cron-reports](https://hestiacp.com/docs/reference/cli.html#v-delete-cron-reports)
 #----------------------------------------------------------#
 #                Variables & Functions                     #
 #----------------------------------------------------------#