diff --git a/bin/v_add_web_domain b/bin/v_add_web_domain index 82d543ae..aa7aec50 100755 --- 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 index e4e30f75..46aebedf 100755 --- 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 index 4a216b2a..ff85ec5a 100755 --- 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 index bd1b35e4..dfef7453 100755 --- 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 index 4a0439e3..07a4034e 100755 --- 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 index 25931050..228070af 100755 --- 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 index 3351f2db..c6889f0f 100755 --- 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 index 1a592e32..8b3de9a6 100755 --- 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 index 091e895b..aa270750 100755 --- 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 index 923c3476..3d97a0f4 100755 --- 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 index aedf9665..14188f17 100755 --- 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 index e4ab5093..19ee439f 100755 --- 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 index a8ddaa59..26f79143 100755 --- 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 index 7033cb84..a7c37e2e 100755 --- 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 index 403c828c..afd6d9b5 100755 --- 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 index bcb1c658..c121b168 100755 --- 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 index b9b1140c..34ba5a6f 100755 --- 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 index 1d28f745..b7e733e6 100755 --- 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 index 2d659845..03d02d74 100755 --- 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 index df804928..576df453 100755 --- 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 index 196505c7..d024d80e 100755 --- 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 index 44d63a49..112ceaee 100755 --- 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 index 9d206c18..180554fa 100755 --- 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 index 3ae6d77b..ec4956cf 100755 --- 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 index d49af9c9..8e551322 100755 --- 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 index b26e4f67..c816f837 100755 --- 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 index 00c1dcf2..08b961fe 100755 --- 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 index c7f837bc..f5605e0e 100755 --- 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 index bc15fbe2..7c68f050 100755 --- 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 index 1f6fc3d0..59e5a52d 100755 --- 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 index 492cf169..3ad321e6 100755 --- 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 index e5a893b3..ee0a45e0 100755 --- 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 index d317d637..a7aef160 100755 --- a/bin/v_restart_web +++ b/bin/v_restart_web @@ -1,6 +1,13 @@ #!/bin/bash -# Internal vesta function -# web system restart +# info: restart dns service +# options: none +# +# The function tells BIND service to reload dns zone files. + + +#----------------------------------------------------------# +# Variable&Function # +#----------------------------------------------------------# # Importing variables source $VESTA/conf/vars.conf @@ -23,6 +30,11 @@ nginx() { fi } + +#----------------------------------------------------------# +# Action # +#----------------------------------------------------------# + # Checking system if [ "$WEB_SYSTEM" = 'apache' ]; then apache @@ -32,5 +44,10 @@ if [ "$PROXY_SYSTEM" = 'nginx' ]; then nginx fi + +#----------------------------------------------------------# +# Vesta # +#----------------------------------------------------------# + # Logging exit diff --git a/bin/v_suspend_web_domain b/bin/v_suspend_web_domain index 48d80859..fa6c7820 100755 --- a/bin/v_suspend_web_domain +++ b/bin/v_suspend_web_domain @@ -1,5 +1,11 @@ #!/bin/bash -# info: suspening web domain (with ssl) +# info: suspend web domain +# options: user domain +# +# The function for suspending the site's operation. After blocking it all +# visitors will be redirected to a web page explaining the reason of suspend. +# By blocking the site the content of all its directories remains untouched. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_suspend_web_domains b/bin/v_suspend_web_domains index 7a2a81ea..2b464107 100755 --- a/bin/v_suspend_web_domains +++ b/bin/v_suspend_web_domains @@ -1,5 +1,9 @@ #!/bin/bash -# info: suspening web domains (with ssl) +# info: suspend web domains +# options: user +# +# The function of suspending all user's sites. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_unsuspend_web_domain b/bin/v_unsuspend_web_domain index 06f6d345..4f193276 100755 --- a/bin/v_unsuspend_web_domain +++ b/bin/v_unsuspend_web_domain @@ -1,5 +1,9 @@ #!/bin/bash -# info: unsuspening web domain (with ssl) +# info: unsuspend web domain +# options: user domain +# +# The function of unsuspending the domain. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_unsuspend_web_domains b/bin/v_unsuspend_web_domains index 0597de0b..bd981ad2 100755 --- a/bin/v_unsuspend_web_domains +++ b/bin/v_unsuspend_web_domains @@ -1,5 +1,9 @@ #!/bin/bash -# info: unsuspening web domain (with ssl) +# info: unsuspend web domains +# options: user +# +# The function of unsuspending all user's sites. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_update_web_domain_disk b/bin/v_update_web_domain_disk index 7beaa5e6..881d3199 100755 --- a/bin/v_update_web_domain_disk +++ b/bin/v_update_web_domain_disk @@ -1,5 +1,9 @@ #!/bin/bash -# info: updating disk usage for domain +# info: update disk usage for domain +# options: user domain +# +# The function recalculates disk usage for speciefic webdomain. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_update_web_domain_stat b/bin/v_update_web_domain_stat index 80ac30ff..7f1d0b08 100755 --- a/bin/v_update_web_domain_stat +++ b/bin/v_update_web_domain_stat @@ -1,5 +1,9 @@ #!/bin/bash -# info: updating domain web statistics +# info: update domain statistics +# options: user domain +# +# The function runs log analyzer for speciefic webdomain. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_update_web_domain_traff b/bin/v_update_web_domain_traff index 750a47c8..d8c838ee 100755 --- a/bin/v_update_web_domain_traff +++ b/bin/v_update_web_domain_traff @@ -1,5 +1,9 @@ #!/bin/bash -# info: updating traffic usage for domain +# info: update domain bandwidth usage +# options: user domain +# +# The function recalculates bandwidth usage for speciefic domain. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_update_web_domains_disk b/bin/v_update_web_domains_disk index ceff8bd4..5bd0f249 100755 --- a/bin/v_update_web_domains_disk +++ b/bin/v_update_web_domains_disk @@ -1,5 +1,9 @@ #!/bin/bash -# info: updating disk usage for all user domains +# info: update domains disk usage +# options: user +# +# The function recalculates disk usage for all user webdomains. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_update_web_domains_stat b/bin/v_update_web_domains_stat index 12ade0c0..9692090a 100755 --- a/bin/v_update_web_domains_stat +++ b/bin/v_update_web_domains_stat @@ -1,5 +1,9 @@ #!/bin/bash -# info: updating web statistics for all domains +# info: update domains statistics +# options: user +# +# The function runs log analyzer usage for all user webdomains. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_update_web_domains_traff b/bin/v_update_web_domains_traff index 3cc642bf..6901debc 100755 --- a/bin/v_update_web_domains_traff +++ b/bin/v_update_web_domains_traff @@ -1,5 +1,9 @@ #!/bin/bash -# info: updating traffic usage for domains +# info: update domains bandwidth usage +# options: user +# +# The function recalculates bandwidth usage for all user webdomains. + #----------------------------------------------------------# # Variable&Function #