Added documentation for WEB functions.

serghey-rodin · serghey-rodin · commit b9d399804a1b · 2012-01-12T15:03:54.000+02:00
diff --git a/bin/v_add_web_domain b/bin/v_add_web_domain
@@ -1,5 +1,14 @@
 #!/bin/bash
-# info: adding web domain
+# info: add web domain
+# options: user domain ip [template]
+#
+# The function adds virtual host to a server. In cases when a template is
+# undefined in the script, the template "default" will be used. The alias of
+# www.domain.tld type will be automatically assigned to the domain. If ip have
+# assocated dns name, this domain will also get the alias domain-tpl.$ipname.
+# An alias with the ip name is useful during the site testing while dns isn't
+# moved to a server yet.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_add_web_domain_alias b/bin/v_add_web_domain_alias
@@ -1,5 +1,10 @@
 #!/bin/bash
-# info: adding web domain alias
+# info: add web domain alias
+# options: user domain alias
+#
+# The call is intended for adding aliases to a domain (it is also called
+# "domain parking"). The function supports wildcards *.domain.tpl.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_add_web_domain_cgi b/bin/v_add_web_domain_cgi
@@ -1,5 +1,12 @@
 #!/bin/bash
-# info: adding cgi support for domain
+# info: add cgi support for domain
+# options: user domain
+#
+# The function switches on cgi support by adding +ExecCGI directive into
+# webserver configuration file. The use of this function is provided for
+# cases, when temporary cgi support is necessary, for other cases use of
+# templates is recommended.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_add_web_domain_elog b/bin/v_add_web_domain_elog
@@ -1,5 +1,10 @@
 #!/bin/bash
-# info: adding error log for domain
+# info: add error logging for domain
+# options: user domain
+#
+# The function enables a separate ErrorLog file for a domain, accessible for
+# reading by users.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_add_web_domain_nginx b/bin/v_add_web_domain_nginx
@@ -1,5 +1,10 @@
 #!/bin/bash
-# info: adding nginx support
+# info: add webdomain nginx support
+# options: user domain
+#
+# The function enables nginx support for a domain. It can significantly improve
+# website speed.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_add_web_domain_ssl b/bin/v_add_web_domain_ssl
@@ -1,5 +1,14 @@
 #!/bin/bash
 # info: adding ssl for domain
+# options: user domain ssl_dir [ssl_home]
+#
+# The function turns on SSL support for a domain. Parameter ssl_dir is a path
+# to directory where 2 or 3 ssl files can be found. Certificate file 
+# domain.tld.crt and its key domain.tld.key  are mandatory. Certificate
+# authority domain.tld.ca file is optional. If home directory  parameter
+# (ssl_home) is not set, https domain uses public_shtml as separate
+# documentroot directory.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_add_web_domain_stat b/bin/v_add_web_domain_stat
@@ -1,5 +1,13 @@
 #!/bin/bash
-# info: adding stats for domain
+# info: add log analyzer to generate domain statitics
+# options: user domain type
+#
+# The call is used for enabling log analyzer system to a domain.  At this time
+# two types of these system is supported - awstats and webalizer. For viewing
+# the domain statistics use http://domain.tld/vstats/ link. Access this page
+# is not protected by default. If you want to secure it with passwords you
+# should use v_add_web_domain_stat_auth script.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_add_web_domain_stat_auth b/bin/v_add_web_domain_stat_auth
@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: adding web domain
+# info: add password protection to web domain statistics
+# options: user domain auth_user auth_password
+#
+# The call is used for securing the web statistics page.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_change_web_domain_ip b/bin/v_change_web_domain_ip
@@ -1,5 +1,10 @@
 #!/bin/bash
-# info: changing domain ip
+# info: change web domain ip address
+# options: user domain ip
+#
+# The call is used for changing the site ip address. The ip change will be
+# performed for a virtual apache host and for a configuration nginx file both.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_change_web_domain_sslcert b/bin/v_change_web_domain_sslcert
@@ -1,5 +1,10 @@
 #!/bin/bash
-# info: changing domain ssl certificate
+# info: change domain ssl certificate
+# options: user domain ssl_dir
+#
+# The function changes SSL domain certificate and the key. If ca file present
+# it will be replaced as well.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_change_web_domain_tpl b/bin/v_change_web_domain_tpl
@@ -1,5 +1,10 @@
 #!/bin/bash
-# info: changing domain template
+# info: change web domain template
+# options: user domain template
+#
+# The function changes template of httpd.conf configuration file. The content
+# of webdomain directories remains untouched.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_delete_web_domain b/bin/v_delete_web_domain
@@ -1,5 +1,12 @@
 #!/bin/bash
-# info: deliting web domain
+# info: delete web domain
+# options: user domain
+#
+# The call of function leads to the removal of domain and all its components
+# (statistics, folders contents, ssl certificates, etc.). This operation is
+# not fully supported by "undo" function, so the data recovery is possible
+# only with a help of reserve copy.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_delete_web_domain_alias b/bin/v_delete_web_domain_alias
@@ -1,5 +1,10 @@
 #!/bin/bash
-# info: deliting web domain alias
+# info: delete web domain alias
+# options user domain alias
+#
+# The function of deleting the alias domain (parked domain). By this call
+# default www aliase can be removed as well.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_delete_web_domain_cgi b/bin/v_delete_web_domain_cgi
@@ -1,5 +1,12 @@
 #!/bin/bash
-# info: deliting cgi for domain
+# info: delete web domain cgi support
+# options: user domain
+#
+# The function for deleting cgi support (adds -ExecCGI directive into
+# configuration file). It is recommended to apply this function only for a
+# temporary use (for lightening the consequences of DDoS, for example);
+# otherwise it is preferable to use templates.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_delete_web_domain_elog b/bin/v_delete_web_domain_elog
@@ -1,5 +1,11 @@
 #!/bin/bash
-# info: deleting error log for domain
+# info: delete web domain error loggin support
+# options: user domain
+#
+# The function of disabling error logging feature. It comments  ErrorLog 
+# direcitve in apache or/and nginx configuration. The data already collected
+# remains untouched.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_delete_web_domain_nginx b/bin/v_delete_web_domain_nginx
@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: deleting web domain nginx config
+# info: deleting web domain nginx configuration
+# options: user domain
+#
+# The function of deleting the virtualhost nginx configuration.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_delete_web_domain_ssl b/bin/v_delete_web_domain_ssl
@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: deliting web domain ssl
+# info: delete web domain ssl support
+# options: user domain
+#
+# The function disable https support and deletes SSL certificates.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_delete_web_domain_stat b/bin/v_delete_web_domain_stat
@@ -1,5 +1,10 @@
 #!/bin/bash
-# info: adding web domain
+# info: delete web domain statistics
+# options: user domain
+#
+# The function of deleting site's system of statistics. Its type is
+# automatically chooses from client's configuration file.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_delete_web_domain_stat_auth b/bin/v_delete_web_domain_stat_auth
@@ -1,5 +1,12 @@
 #!/bin/bash
-# info: adding web domain
+# info: disable webdomain stats  authentication support
+# options: user domain [auth_user]
+#
+# The function removes authentication of statistics system. If the script is
+# called without naming a certain user, all users will be removed. After
+# deleting all of them statistics will be accessible for view without an
+# authentication.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_delete_web_domains b/bin/v_delete_web_domains
@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: deleteing all user web domains
+# info: delete web domains
+# options: user
+#
+# The function deteles all user's webdomains.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_get_web_domain_value b/bin/v_get_web_domain_value
@@ -1,5 +1,11 @@
 #!/bin/bash
-# info: Getting web domain value
+# info: get web domain value
+# options: user domain key
+#
+# The function is intended for obtaining a domain value by the key. This call
+# is useful for arranging composite queries. The answer is displayed only in
+# raw form; output formats aren't supported.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_list_web_domain b/bin/v_list_web_domain
@@ -1,5 +1,10 @@
 #!/bin/bash
-# info: listing web domain
+# info: list web domain
+# options: user domain [format]
+#
+# The function of obtaining the list of domain parameters. This call, just as
+# all v_list_* calls, supports 3 formats - json, shell and plain.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_list_web_domain_ssl b/bin/v_list_web_domain_ssl
@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: listing web ssl certificate
+# info: list web domain ssl certificate
+# options: user domain [format]
+#
+# The function of obtaining domain ssl files.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_list_web_domains b/bin/v_list_web_domains
@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: listing web domains
+# info: list web domains
+# options user [format]
+#
+# The function of obtaining the list of all user domains.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_list_web_domains_alias b/bin/v_list_web_domains_alias
@@ -1,5 +1,11 @@
 #!/bin/bash
-# info: listing web domains
+# info: list web domains and alias key
+# options: user [format]
+#
+# The function for obtaining the list of aliases of all user's domains. This
+# call was arranged for filling in the lack of information by applying
+# v_list_web_domains call in the shell format.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_list_web_domains_elog b/bin/v_list_web_domains_elog
@@ -1,5 +1,11 @@
 #!/bin/bash
-# info: listing web domain
+# info: list web domains and elog key
+# options: user [format]
+#
+# The function for obtaining the list of domains with parameter ErrorLog
+# displayed. This call was arranged for filling in the lack of information by
+# applying v_list_web_domains call in the shell format.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_list_web_domains_nginx b/bin/v_list_web_domains_nginx
@@ -1,5 +1,11 @@
 #!/bin/bash
-# info: listing web domains
+# info: list web domains and nginx key
+# options: user [format]
+#
+# The function for obtaining the list of domains with nginx parameter
+# displayed. This call was arranged for filling in the lack of information by
+# applying v_list_web_domains call in the shell format.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_list_web_domains_ssl b/bin/v_list_web_domains_ssl
@@ -1,5 +1,11 @@
 #!/bin/bash
-# info: listing web domain
+# info: list web domains and alias key
+# options: user [format]
+#
+# The function for obtaining the list of domains with SSL parameter displayed.
+# This call was arranged for filling in the lack of information by applying
+# v_list_web_domains call in the shell format.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_list_web_domains_stats b/bin/v_list_web_domains_stats
@@ -1,5 +1,12 @@
 #!/bin/bash
-# info: listing web domain
+# info: list web domains and stats key
+# options: user [format]
+#
+# The function for obtaining the list of domains with statistics parameter
+# displayed, including authentication settings. This call was arranged for
+# filling in the lack of information by applying v_list_web_domains call in
+# the shell format.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_list_web_templates b/bin/v_list_web_templates
@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: listing web templates
+# info: list web templates
+# options: user [format]
+#
+# The function for obtaining the list of apache templates available to a user.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_list_web_templates_nginx b/bin/v_list_web_templates_nginx
@@ -1,5 +1,9 @@
 #!/bin/bash
 # info: listing nginx templates
+# options: user [format]
+#
+# The function for obtaining the list of nginx templates available to a user.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_rebuild_web_domains b/bin/v_rebuild_web_domains
@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: rebuilding web domains
+# info: rebuild dns domains
+# options: user
+#
+# The function rebuilds BIND configuration files for all dns domains.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v_restart_web b/bin/v_restart_web
diff --git a/bin/v_suspend_web_domain b/bin/v_suspend_web_domain
diff --git a/bin/v_suspend_web_domains b/bin/v_suspend_web_domains
diff --git a/bin/v_unsuspend_web_domain b/bin/v_unsuspend_web_domain
diff --git a/bin/v_unsuspend_web_domains b/bin/v_unsuspend_web_domains
diff --git a/bin/v_update_web_domain_disk b/bin/v_update_web_domain_disk
diff --git a/bin/v_update_web_domain_stat b/bin/v_update_web_domain_stat
diff --git a/bin/v_update_web_domain_traff b/bin/v_update_web_domain_traff
diff --git a/bin/v_update_web_domains_disk b/bin/v_update_web_domains_disk
diff --git a/bin/v_update_web_domains_stat b/bin/v_update_web_domains_stat
diff --git a/bin/v_update_web_domains_traff b/bin/v_update_web_domains_traff
