5.33 HTTP (HTTP server configuration)

5.33.1 Function

The HTTP statement configures the HTTP server. More than one HTTP statement can be coded in the
configuration file. Depending on the given arguments the port on which the HTTP server will listen and
the authorization (if any) or the location of the HTTP server files can be specified. Additional arguments
allow to start or to stop the HTTP server. Please note, that the HTTP server is not started by default (i.e.
without a “HTTP START” statement).

5.33.2 Syntax

Descriptive

HTT path port userid password

Diagram

Êʬ¬¬ HTTP ¬¬¬§
¬¬¬ ¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬¬¬¬¬¬¬¬ÊÍ

¬¬¬ ¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬«

path ¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬«

¬¬¬ port

userid password

5.33.3 Parameter

START

Start the HTTP server (if it is stopped).

STOP

Stop the HTTP server (if it is started).

ROOT

Keyword to specify the root directory of the HTTP server files. The HTTP root can
only be set if the HTTP server is in the stopped state.

path

The full path of the root directory where the HTTP server files reside. If this para-
meter is not specified the default value for Win32 builds of Hercules is the directory
where the Hercules executables themselves reside. For non-Win32 builds it is the
directory specified as the default package installation directory when the Hercules
executables were built. This can vary depending on how the Hercules package was
built, it is commonly “/usr/local/share/hercules”.

PORT

Keyword to specify the port on which the HTTP server will listen (including optional
authorization information). The HTTP port and authorization information can only
be set if the HTTP server is in the stopped state.

port

The port number must be either 80 or within the range of 1024 to 65535 inclusive.

NOAUTH

NOAUTH indicates that no userid and password are required to access the HTTP
server.

AUTH

AUTH indicates that a userid and a password are required to access the HTTP
server. The userid and password have to be coded after the AUTH parameter.

userid

The userid can be any valid string.

password

The password can be any valid string.

5.33.4 Examples

Example 1:

Activate the HTTP server under a Linux system listening on port 8081 and with the HTTP server files
residing on “/usr/local/share/Hercules”. Specify that authorization is required to access the HTTP server.
The userid should be UID0001 and the password should be PSWD0001.

HTTP PORT 8081 AUTH UID0001 PSWD0001

HTTP ROOT /usr/local/share/Hercules

HTTP START

Example 2:

Activate the HTTP server under a Windows system listening on port 8088 and with the HTTP server files
residing on “D:\Hercules\HTML”. Specify that authorization is not required to access the HTTP server.

HTTP PORT 8088 NOAUTH

HTTP ROOT D:\Hercules\HTML

HTTP START