Item14409: Document CLI wizard operation

And add validations, since CLI doesn't have benefit of dropdown lists.
foswiki · May 29, 2017 · cb119db · cb119db
1 parent b4acaf1
commit cb119db
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 2 deletions.
diff --git a/data/System/VirtualHostingContrib.txt b/data/System/VirtualHostingContrib.txt
@@ -213,6 +213,22 @@ the master site's configured names, then a custom =virtualhost.conf= *must* be
 used.
 </div>
 
+---++++ Running the wizard with =tools/configure=
+
+The =CreateVHost= wizard can be run from the CLI as well.   The arguments are:
+
+| *Parameter* | *Description* | *default* | *Example* |
+| =name= | virtual hostname to create | (required) | =-args name=foo.mysite.com= |
+| =createpasswd= | Create the =.htpasswd= file. | no password file created | =-args createpasswd=1= |
+| =template= | Template host to copy | host will be copied from master webs | =-args template=_templateweb= |
+| =templatecfg= | Template file to copy into configuration | no config created | =-args templatecfg=_template.conf= |
+
+*Caution:* Always run this wizard using the web server's userid
+<verbatim>
+sudo -u www-data tools/configure -wizard CreateVHost -method create_vhost_2 -args name=foo.site.com -args createpasswd=1
+sudo -u www-data tools/configure -wizard CreateVHost -method create_vhost_2 -args name=foo2.site.com -args template=_template templatecfg=_template.conf
+</verbatim>
+
 
 ---++++ Managing virtual hosts
 

diff --git a/lib/Foswiki/Configure/Wizards/CreateVHost.pm b/lib/Foswiki/Configure/Wizards/CreateVHost.pm
@@ -83,7 +83,7 @@ sub create_vhost_1 {
     $reporter->NOTE($form);
     my %data = (
         wizard => 'CreateVHost',
-        method => 'create_vhost_2',
+        method => 'run_create',
         form   => '#create_vhost',
         args   => {
 
@@ -100,7 +100,7 @@ sub create_vhost_1 {
 
 =cut
 
-sub create_vhost_2 {
+sub run_create {
     my ( $this, $reporter ) = @_;
 
     my $args = $this->param('args');
@@ -146,6 +146,16 @@ sub _create_vhost {
         return 0;
     }
 
+    # Validate input
+    if ( $template && ! -d "$vdir/$template" ) {
+        $reporter->ERROR("Requested template host =$template= does not exist in =$vdir=!");
+        return 0;
+    }
+    if ( $cfgtemplate && ! -f "$vdir/$cfgtemplate" ) {
+        $reporter->ERROR("Requested template configuration =$cfgtemplate= does not exist in =$vdir=!");
+        return 0;
+    }
+
     if ( $template && -d "$vdir/$template" ) {
         $this->_createFromTemplate($reporter);
     }