Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Znav
nextRunning the IcePatch2 Client
prevUsing icepatch2calc

This page describes how to run the IcePatch2 server.

On this page:

Table of Contents
maxLevel2

Starting icepatch2server

Once you have run icepatch2calc on the data directory, you can start the icepatch2server:

Wiki Markup
{zcode}
$ icepatch2server .
{zcode}

The server expects the data directory as its single command-line argument. If you omit to specify the data directory, the server uses the setting of the IcePatch2.Directory property to determine the data directory.

The server has two different sets of endpoints, one for regular operations, and one for administration:

  • IcePatch2.Endpoints
    This property determines the endpoint at which the server listens for client requests. This property must be specified.
  • IcePatch2.Admin.Endpoints
    If this property is not set, the only way to shut down the server is to kill it somehow, such as by interrupting the server from the command line. If this property is set, the server offers an additional IcePatch2::Admin interface:

    Wiki Markup
    {zcode:slice}
    interface Admin {
        void shutdown();
    };
    {zcode}
    By default, the identity of this object is IcePatch2/admin. You can change the category of this identity by setting the property IcePatch2.InstanceName.

    Calling the shutdown operation shuts down the server. Note that any client with access to the Admin interface's port can stop the server. Typically, you would set this property to a port that is not accessible to potentially hostile clients.
    Ztop

Anchor
options
options

icepatch2server Command Line Options

Regardless of whether you run the server under Windows or a Unix-like operating system, it provides the following options:

  • -h, --help
    Displays a help message.
  • -v, --version
    Displays a version number.

Additional command line options are supported, including those that allow the server to run as a Windows service or Unix daemon.

Ztop
See Also
Zret
Znav
nextRunning the IcePatch2 Client
prevUsing icepatch2calc