velocity-webserver

Manages the run state of the embedded web server that is installed as a part of Watson Explorer Engine.

Synopsis

velocity-webserver [-help]
    [-installation-dir /path/to/engine/installation]
    [-quiet]
    [start|stop|restart|graceful|configtest|uninstall|install|info]

Description

The velocity-webserver command is located in the bin subdirectory of a Watson Explorer Engine installation. (On Microsoft Windows systems, this command has the .exe file extension.) Executing this command with one of the start|stop|restart|graceful changes the execution state of the Watson Explorer Engine web server in the indicated fashion. Executing this command with the configtest option enables you to verify that the web server's configuration file is syntactically correct. Executing this command with the info options displays information about the status of the web server and the URL at which it can be contacted. The graceful option is only available on Linux systems, and restarts the Watson Explorer Engine embedded web server without terminating any activae connections. The uninstall and install options are only available on Microsoft Windows systems, and respectively uninstall or install Watson Explorer Engine's embedded web server as a Window service.

Note: When starting the embedded Watson Explorer Engine web server for the first time on Microsoft Windows systems that are running the Windows firewall or which support User Account Control (UAC) warnings, your system will display a dialog requesting that you unblock the program in your firewall or otherwise grant the application access to your network. You must approve whichever of these access requests you see in order for applications to use this web server.

Options

-help: Displays a usage message and exits without performing any other actions.
-installation-dir/path/to/engine/installation: Enables you to specify the location of the Watson Explorer Engine installation that contains the web server which you want to configure. If no installation directory is specified, the velocity-webserver command assumes that the webserver directory and binaries are located in the Watson Explorer Engine installation directory which is the parent of the directory in which the velocity-webserver application is located.
-quiet: Suppresses normal output and warnings. Errors will still be displayed. On Windows systems, this option also suppresses the "Press return to continue" message that is shown at the end of each Watson Explorer Engine administrative command.
configtest: Checks the syntax of the web server configuration files (INSTALLDIR/webserver/webserver.conf) and any customized configuration files (webserver.something.conf) that you may have created in the data subdirectory of your Watson Explorer Engine installation directory. If an error is present in any of these files, the command displays detailed information about the syntax error. If no syntax errors are present, the command displays the message "Syntax OK".
graceful: (Linux only) Gracefully restarts the embedded web server by sending it a signal, which does not abort or close any connections that are currently open to the web server (including connections from the web server to its log files). If the web server process (httpd) is not running, it is started. This command automatically checks the configuration files via configtest before initiating the restart to make sure that the embedded web server will be able to restart with those configuration files.
Note: The graceful option is not supported by the velocity-webserver command on Microsoft Windows systems.
info: Displays information about the status of the webserver and the URL to use to contact the Watson Explorer Engine administration tool through the webserver. This command will display one of the following messages, depending upon its configuration and execution state:
1. If the webserver has not been enabled, it cannot be running, so you will see a message like the following:
```
The webserver is not enabled.
```
  You can enable the embedded webserver using the velocity-config, and then start it using the velocity-webserver start command. Once enabled, the web server will be started automatically by the velocity command.
2. If the webserver has been enabled, but is not running, you will see a message like the following:
```
The webserver is enabled and not running.

The url for the Velocity administrative interface is:
        http://localhost:9080/vivisimo/cgi-bin/admin

To access the administrative interface from another computer, replace
'localhost' with the DNS name or IP address of this
server.
```
  You can start the web server manually by executing the velocity-webserver start command. Once enabled, the web server will be started automatically by the velocity command.
3. If the webserver has been enabled and is running, you will see a message like the following:
```
The webserver is enabled and running.

The url for the Velocity administrative interface is:
        http://localhost:9080/vivisimo/cgi-bin/admin

To access the administrative interface from another computer, replace
'localhost' with the DNS name or IP address of this server.
```
install: (Microsoft Windows only) Installs Watson Explorer Engine's embedded web server as a Window service.
restart: Restarts the embedded web server by sending it a SIGHUP signal. If the web server process (httpd) is not running, it is started. This command automatically checks the configuration files via configtest before initiating the restart to make sure that the embedded web server will be able to restart with those configuration files.
start: Starts the embedded web server that is included with Watson Explorer Engine.
stop: Stops the embedded web server.
uninstall: (Microsoft Windows only) Uninstalls` the Watson Explorer Engine embedded web server as a Window service.

When executed with no arguments, the velocity-webserver command displays the same output as if it had been called with its --help option.

Messages

Depending on the command-line options that you specify, you may be prompted for other information or see additional messages, such as the following:

"The command must be one of start, stop, restart, graceful, configtest": You supplied an unknown keyword as an argument to the velocity-webserver command.
"Press Return to continue": (Microsoft Windows only) Shown after the velocity-webserver completes the webserver startup process but before it exits, in order to enable you to see any messages that may have been generated in the command window during the startup process.

See the Watson Explorer Engine Message Reference Manual for detailed information about any other messages that you may receive from the velocity-webserver command.

Exit Status

Exits with status 0 when the command is successful.

Note: On Linux systems, exit codes above 127 are returned by the shell. Please consult the documentation for the shell that you are using for more information.