Browse Source

First part

Jaap Marcus 2 years ago
parent
commit
27bbf46cf0

+ 4 - 4
bin/v-add-database-temp-user

@@ -1,12 +1,12 @@
 #!/bin/bash
-# info: add temp database user
+# info: add temp database user.
 # options: USER DATABASE [TYPE] [HOST] [TTL]
 #
 # example: v-add-database-temp-user wordress wordpress_db mysql
 #
-# This function creates an temporary database user mysql_sso_db_XXXXXXXX and a random password
-# The user has an limited validity and only granted access to the specific database
-# Returns json to be read SSO Script
+# This function creates an temporary database user mysql_sso_db_XXXXXXXX and a random password.
+# The user has an limited validity and only granted access to the specific database.
+# Returns json to be read SSO Script.
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

+ 1 - 1
bin/v-add-dns-domain

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: add dns domain
-# options: USER DOMAIN IP [NS1] [NS2] [NS3] [NS4] [NS5] [NS6] [NS7] [NS8] [RESTART]
+# options: USER DOMAIN IP [NS1] [NS2] [NS3] [NS4] [NS5] [NS6] [NS7] [NS8] [RESTART] [DNSSEC]
 #
 # example: v-add-dns-domain admin example.com ns1.example.com ns2.example.com '' '' '' '' '' '' yes
 #

+ 1 - 1
bin/v-add-dns-record

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: add dns record
-# options: USER DOMAIN RECORD TYPE VALUE [PRIORITY] [ID] [RESTART] [TTL]
+# options: USER DOMAIN RECORD TYPE VALUE [PRIORITY] [ID] [RESTART] [TTL] [QUIET]
 #
 # example: v-add-dns-record admin acme.com www A 162.227.73.112
 #

+ 2 - 0
bin/v-add-sys-api-ip

@@ -3,6 +3,8 @@
 # options: IP
 #
 # example: v-add-sys-api-ip 1.1.1.1
+#
+# Adds Ip address to whit list
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

+ 5 - 4
bin/v-add-sys-dependencies

@@ -1,8 +1,10 @@
 #!/bin/bash
-# Add php dependencies to Hestia
-# options: [MODE]
+# info: Adds / Update  PHP  dependencies to Hestia
+# options:
 #
-# This function install PHPMailer and quoteshellarg as via composer
+# example: v-sys-dependencies
+#
+# This script download System Dependencies for Web UI. PHP Mailer, phpquoteshellarg and twofactorauth.
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #
@@ -18,7 +20,6 @@ source_conf "$HESTIA/conf/hestia.conf"
 # upgrade config file
 source "$HESTIA/install/upgrade/upgrade.conf"
 
-MODE=$1
 user="$ROOT_USER"
 
 PM_INSTALL_DIR="$HESTIA/web/inc"

+ 1 - 1
bin/v-add-sys-pma-sso

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: enables support for single sign on phpMyAdmin
-# options: [mode]
+# options: [MODE]
 #
 # example: v-add-sys-pma-sso
 #

+ 3 - 2
bin/v-add-sys-roundcube

@@ -19,8 +19,8 @@ source_conf "$HESTIA/conf/hestia.conf"
 # upgrade config file
 source "$HESTIA/install/upgrade/upgrade.conf"
 
-MODE=$2
-UPDATE="no"
+MODE=$1
+
 # Version and Download paths
 RC_FILE="roundcubemail-$rc_v-complete.tar.gz"
 RC_EXTRACT="roundcubemail-$rc_v"
@@ -62,6 +62,7 @@ if [ -d "/usr/share/roundcube" ]; then
 	exit 2
 fi
 
+UPDATE="no"
 # Get current version
 if [ -f "/var/lib/roundcube/index.php" ]; then
 	version=$(cat $RC_INSTALL_DIR/index.php | grep -o -E '[0-9].[0-9].[0-9]+' | head -1)

+ 2 - 2
bin/v-add-user-composer

@@ -1,8 +1,8 @@
 #!/bin/bash
 # info: add composer (php dependency manager) for a user
-# options: USER
+# options: USER [VERSION] [UPDATE]
 #
-# example: v-add-user-composer user [version]
+# example: v-add-user-composer user 2 yes
 #
 # This function adds support for composer (php dependency manager)
 # Homepage: <https://getcomposer.org/>

+ 3 - 1
bin/v-add-user-notification

@@ -1,6 +1,8 @@
 #!/bin/bash
 # info: add user notification
-# options: USER TOPIC NOTICE [TYPE]
+# options: USER TOPIC NOTICE [TYPE] [PRIORITY]
+#
+# example: v-add-user-notification user "Title" "My Message" "
 #
 # This function adds a new user notification to the panel.
 

+ 3 - 1
bin/v-add-user-package

@@ -1,6 +1,8 @@
 #!/bin/bash
 # info: adding user package
-# options: tmpfile PACKAGE [REWRITE]
+# options: TEMPFILE PACKAGE [REWRITE]
+#
+# example: v-add-user-package "/tmp/file/topackage" "packagename"
 #
 # This function adds new user package to the system.
 

+ 2 - 0
bin/v-add-user-sftp-key

@@ -2,6 +2,8 @@
 # info: add user sftp key
 # options: USER [TTL]
 #
+# v-add-user-sftp-key "user" 30
+#
 # This function creates and updates SSH keys for used with the File Manager.
 
 #----------------------------------------------------------#

+ 1 - 5
bin/v-add-user-wp-cli

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: add wp-cli for a user
-# options: USER
+# options: USER [UPDATE]
 #
 # example: v-add-user-wp-cli user
 #
@@ -14,10 +14,6 @@
 user=$1
 update=$2
 
-if [ -z "$HESTIA" ]; then
-	HESTIA="/usr/local/hestia"
-fi
-
 # shellcheck source=/etc/hestiacp/hestia.conf
 source /etc/hestiacp/hestia.conf
 # shellcheck source=/usr/local/hestia/func/main.sh

+ 3 - 1
bin/v-change-dns-domain-dnssec

@@ -2,7 +2,9 @@
 # info: change dns domain dnssec status
 # options: USER DOMAIN STATUS
 #
-# example: v-change-dns-domain-dnssec admin domain.pp.ua yes
+# example: v-change-dns-domain-dnssec user domain.com yes
+#
+# Enable/Disable domain DNSSEC status
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

+ 1 - 1
bin/v-change-sys-api

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: Enable / Disable API access
-# options: STATUS
+# options: STATUS VERSION
 #
 # example: v-change-sys-api enable legacy
 #          # Enable legacy api currently default on most of api based systems

+ 3 - 1
bin/v-change-sys-php

@@ -1,8 +1,10 @@
 #!/bin/bash
 # info: Change default php version server wide
 # options: VERSION
-
+#
 # example: v-change-sys-php 8.0
+#
+# Changes default PHP version server width usd by the "Default" template and Webmail
 
 version=$1
 

+ 4 - 4
bin/v-change-sys-webmail

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: change webmail alias url
-# options: WEBMAIL
+# options: WEBMAIL [RESTART]
 #
 # example: v-change-sys-webmail YourtrickyURLhere
 #
@@ -18,14 +18,14 @@ source $HESTIA/func/main.sh
 # load config file
 source_conf "$HESTIA/conf/hestia.conf"
 
+NEW_ALIAS=$1
+restart=${2-yes}
+
 # Get existing system webmail alias
 export WEBMAIL_ALIAS="$WEBMAIL_ALIAS"
 
 # Define aliases
 OLD_ALIAS=$WEBMAIL_ALIAS
-NEW_ALIAS=$1
-
-restart=${2-yes}
 
 # Perform verification if read-only mode is enabled
 check_hestia_demo_mode

+ 1 - 1
bin/v-change-web-domain-docroot

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: Changes the document root for an existing web domain
-# options: USER DOMAIN TARGET_DOMAIN [DIRECTORY] [PHP]
+# options: USER DOMAIN TARGET_DOMAIN [DIRECTORY] [PHP] [RESTART]
 #
 # example: v-change-web-domain-docroot admin domain.tld otherdomain.tld
 #          # add custom docroot

+ 1 - 1
bin/v-delete-cron-job

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: delete cron job
-# options: USER JOB
+# options: USER JOB [RESTART]
 #
 # example: v-delete-cron-job admin 9
 #

+ 2 - 2
bin/v-delete-database-temp-user

@@ -1,8 +1,8 @@
 #!/bin/bash
 # info: deletes temp database user
-# options: USER DBUSER [TYPE] [HOST]
+# options: USER DATABASE DBUSER [TYPE] [HOST]
 #
-# example: v-add-database-temp-user wordress hestia_sso_user mysql
+# example: v-delete-database-temp-user user wordress hestia_sso_user mysql
 #
 # Revokes "temp user" access to a database and removes the user
 # To be used in combination with v-add-database-temp-user

+ 1 - 1
bin/v-delete-dns-record

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: delete dns record
-# options: USER DOMAIN ID [RESTART]
+# options: USER DOMAIN ID [RESTART] [QUIET]
 #
 # example: v-delete-dns-record bob acme.com 42 yes
 #

+ 1 - 1
bin/v-delete-mail-domain-ssl

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: delete mail domain ssl support
-# options: USER DOMAIN
+# options: USER DOMAIN [RESTART]
 #
 # example: v-delete-mail-domain-ssl user demo.com
 #

+ 3 - 1
bin/v-delete-sys-api-ip

@@ -1,8 +1,10 @@
 #!/bin/bash
-# info: delete ip adresss from allowed ip list api
+# info: delete ip address from allowed ip list api
 # options: IP
 #
 # example: v-delete-sys-api-ip 1.1.1.1
+#
+# Removes ip from the api allowed list
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

+ 1 - 1
bin/v-delete-sys-filemanager

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: remove file manager functionality from Hestia Control Panel
-# options: [MODE]
+# options: [MODE] [FORCE]
 #
 # example: v-delete-sys-filemanager
 #

+ 1 - 1
bin/v-delete-sys-pma-sso

@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: disables support for single sign on PHPMYADMIN
-# options: [mode]
+# options: [MODE]
 #
 # example: v-delete-sys-pma-sso
 #

+ 3 - 0
bin/v-delete-user-auth-log

@@ -1,5 +1,8 @@
 #!/bin/bash
 # info: Delete auth log file for user
+# options: USER
+#
+# v-delete-user-auth-log user
 #
 # This function for deleting a users auth log file
 

+ 0 - 1
bin/v-delete-user-package

@@ -5,7 +5,6 @@
 # example: v-delete-user-package admin palegreen
 #
 # This function for deleting user package.
-#
 # If the package is in use, users will be updated to
 # use the default package.
 

+ 1 - 1
bin/v-delete-web-domain-redirect

@@ -2,7 +2,7 @@
 # info: Delete force redirect to domain
 # options: USER DOMAIN [RESTART]
 #
-# example: v-add-web-domain-redirect user domain.tld
+# example: v-delete-web-domain-redirect user domain.tld
 #
 # Function delete a forced redirect to a domain
 

+ 4 - 2
bin/v-export-rrd

@@ -1,8 +1,10 @@
 #!/bin/bash
 # info: export rrd charts as json
-# options: [CHART] [TIMESPAN]
+# options: CHART [TIMESPAN]
 #
-# example: v-export-rrd chart format
+# example: v-export-rrd chart weekly
+#
+# Exports RDD data chart as json format
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

File diff suppressed because it is too large
+ 179 - 107
docs/docs/reference/cli.md


+ 1 - 0
func/main.sh

@@ -1261,6 +1261,7 @@ is_format_valid() {
 				min) is_cron_format_valid "$arg" $arg_name ;;
 				month) is_cron_format_valid "$arg" $arg_name ;;
 				name) is_name_format_valid "$arg" "name" ;;
+				notice) format_no_quotes "$arg" "notice" ;;
 				nat_ip) is_ip_format_valid "$arg" ;;
 				netmask) is_ip_format_valid "$arg" 'netmask' ;;
 				newid) is_int_format_valid "$arg" 'id' ;;

Some files were not shown because too many files changed in this diff