Browse Source

Start on rework

Jaap Marcus 2 years ago
parent
commit
0eceac9634

+ 0 - 5
bin/v-acknowledge-user-notification

@@ -1,14 +1,9 @@
 #!/bin/bash
 # 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
-#
-# This function acknowledge user notification.
-#
-# note: Used only for testing
 
 
 #----------------------------------------------------------#

+ 3 - 4
bin/v-add-access-key

@@ -1,10 +1,9 @@
 #!/bin/bash
 # info: Generate access key
-# options: USER [PERMISSIONS] [COMMENT] [FORMAT]
-#
+# options: USER PERMISSIONS [COMMENT] [FORMAT]
+# variable: PERMISSIONS | Permission are defined in /usr/local/hestia/data/api or when the 'admin' user is used `*` can be used allowing commands to be executed.
+# variable: COMMENT | String is only used to display extra information
 # example: v-add-access-key admin v-purge-nginx-cache,v-list-mail-accounts comment json
-#
-# The "PERMISSIONS" argument is optional for the admin user only.
 # This function creates a key file in $HESTIA/data/access-keys/
 
 #----------------------------------------------------------#

+ 8 - 5
bin/v-add-backup-host

@@ -1,12 +1,15 @@
 #!/bin/bash
-# info: Add backup host
+# info: Add a new backup host
 # options: TYPE HOST USERNAME PASSWORD [PATH] [PORT]
-#
+# variable: TYPE | SFTP, FTP, RCLONE or B2 are supported
+# variable: HOST | Hostnam or Remote name or Bucket (B2)
+# variable: USERNAME | Username (S)FTP or Application ID (B2) or '' (Rclone)
+# variable: PASSWORD | Password (S)FTP or Application Key (B2) or '' (Rclone)
+# variable: PATH | Path (S)FTP / Rclone or bucket name... (Rclone)
+# variable: Port | Default port for service SFTP 22 or FTP 21
 # example: v-add-backup-host sftp backup.acme.com admin 'p4$$w@Rd'
-#
 # 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
+# Add a new remote backup location. Currently SFTP, FTP, Rclone and B2 ar supported how ever B2 might be dropped in favor of Rclone support.
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

+ 3 - 4
bin/v-add-cron-hestia-autoupdate

@@ -1,9 +1,8 @@
 #!/bin/bash
-# info: Add cron job for hestia automatic updates
+# info: Creates the cronjob to enable automatic updates via apt or git
 # options: MODE
-#
-# This function adds a cronjob for hestia automatic updates
-# that can be downloaded from apt or git.
+# variable: MODE | apt or git (Default apt) when providing "git" it will switch to the development version (main branch)
+# example: v-add-cron-hestia-autoupdate
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

+ 0 - 4
bin/v-add-cron-job

@@ -1,13 +1,9 @@
 #!/bin/bash
 # info: Creates a new cronjob
 # options: USER MIN HOUR DAY MONTH WDAY COMMAND [JOB] [RESTART]
-#
 # 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
-#
 # 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.
 
 

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


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