embedded-webserver-config

Synopsis

embedded-webserver-config [-h|-help|-?|
    [-base-url virtual_dir]
    [-disable-debugging]
    [-disable-webserver]
    [-enable-debugging]
    [-enable-webserver]
    [-group groupname]
    [-host hostname]
    [-language language]
    [-port port]
    [-quiet]
    [-service-name service_name]
    [-user username]

Description

The embedded-webserver-config command is located in the bin subdirectory of Watson Explorer Engine installation (on Microsoft operating systems this command has the .exe file extension. When no command line flags are set, embedded-webserver-config starts in dialogue mode which steps through every configuration option with the user. Every option is explained and the current value presented so the user can choose to keep that value or update it.

If the user provides any command line flags dialogue mode is not run. Instead the values set by the user on the command-line are updated, all other values are unchanged and no additional user interaction is required.

Options

• -h|-help|-? Display the command line help message and exit.
• -base-url virtual_dir The virtual directory the embedded web server should use to serve Watson Explorer Engine from. If not specified the default is vivisimo.
  Note: This value cannot be empty (that is, Watson Explorer Engine cannot be served from the root of a URL.
• -disable-debugging Disable debugging mode for the embedded web server. If debugging mode is not enabled no change is made.
  Note: This option cannot be set in the same invocation as -enable-debugging.
• -disable-webserver Disable the embedded web server. If the embedded web server is not enabled no change is made.
  Note: This option cannot be set in the same invocation as -enable-webserver
• -enable-debugging Enable debugging more for the embedded web server. If debugging mode is already disabled no change is made.
  Note: This option cannot be set in the same invocation as -disable-debugging
• -enable-webserver Enable the embedded web server to use with Watson Explorer Engine. When enabled calling engine-start will also start the embedded web server. If the embedded web server is already enabled no change is made.
  Note: The embedded web server provided with Watson Explorer Engine is not supported in production environments and should only be used in testing or development.
  Note: This option cannot be set in the same invocation as -disable-webserver.
• -group groupname (Linux only) Set the group for the embedded web server's processes to run in. By default apache is used since Watson Explorer Engine is installed with all files owned by the apache group.
  Note: The root group should not be used by the web server processes.
• -host host Specify the hostname the webserver should use. When not specified the operating system's default hostname is used.
• -language language Choose the language that embedded-webserver-config should use in messages, errors and prompts. The default is 'en' (English).
• -port port_number The port that the Watson Explorer Engine embedded web server will listen on when running to handle clients. The default is 9080
  Note: Because the Watson Explorer Engine embedded web server is not supported in production it is also not recommended to assign it to port 80 or indeed any restricted port (all ports below 1024).
• -quiet Suppress standard messages and only print fatal errors.
• -service-name name (Microsoft operating sytems only) Specify the name of the Service that the Watson Explorer Engine embedded web server will use to register itself and run in the background. By default the value is EngineWebServer
• -user username The user that the Watson Explorer Engine embedded web server processes should use. On Linux the default is apache. On Windows the default is Administrator
  Note: On Linux, the root user should not be used for the web server user.

Exit Status

• 0 - Command executed successfully
• 1 - Command encountered an error
• 2 - Usage requested by user