8.75 HTTP (Start, stop, modify and display HTTP server)

8.75.1 Function

The HTTP console command configures the HTTP server. 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. Given without an argument
the HTTP command displays the current state of the HTTP server.

8.75.2 Syntax

Descriptive

HTTP path port userid password

Diagram

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

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

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

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

¬¬¬ port

userid password

8.75.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.

8.75.4 Examples

Example 1:

Display the HTTP server status.

HHC00013I Herc command: 'http'

HHC01809I HTTP server is waiting for requests

HHC01811I HTTP server root directory D:/HERCULES/HTML/

HHC01808I HTTP server port is port=80 noauth

Figure 152: HTTP command (display HTTP server status)

Example 2:

Stop the HTTP server.

HHC00013I Herc command: 'http stop'

HHC01805I HTTP server signaled to stop

HHC00101I Thread id 0000097C, prio 0, name 'HTTP server' ended

Figure 153: HTTP command (stop HTTP server)

Example 3:

Set the HTTP server root directory to “D:\Hercules\html”.

HHC00013I Herc command: 'http root D:/Hercules/html'

HHC02204I httproot set to D:/Hercules/html/

Figure 154: HTTP command (set HTTP server root directory)