Skip to main content
Version: 8.2411.x.x RR

Server command-line interface

The server command-line interface (CLI) provides a low level interface to run the server process. It can be used by higher level tools like the administrative CLI or by the user directly.

Use the server CLI to start nevisAuth without involvement of other system components like for example systemd.

You find the script at /opt/nevisauth/bin/nevisauth-server. It provides the next command line options:

  • -c, --config PATH

    Required. Path to the configuration file nevisauth.yml.

  • -n, --name NAME

    Unique name for that Nevis component node. Overrides the value of the property server.name (in the nevisauth.yml file).

  • -p, --port PORT

    The HTTP/S port to listen on. TLS must be configured in the config file and not as an argument. Overrides the value of the property server.port (in the nevisauth.yml file).

  • -H, --host HOST

    The HTTP/S host to bind on. By default binds on all IPv4 and IPv6 interfaces. Overrides the value of the property server.host (in the nevisauth.yml file).

  • --log-config PATH

    Log configuration file to be used. If a log configuration is provided, nevisAuth will use the given configuration file to determine how logging should behave. If no configuration file is provided, nevisAuth will log to the console by default.

  • -V, --version

    Display version and exit with status code 0.

  • -h, --help

    Show complete and detailed usage and exit with status code 0.

info

Command-line arguments always prevail over the configuration in the nevisauth.yml file!

Example usage of the standalone CLI​

To start an existing nevisAuth instance named "default" without using systemd to manage the service, set the following commands:

# set working directory
cd /var/opt/nevisauth/default
/opt/nevisauth/bin/nevisauth-server --config /var/opt/nevisauth/default/conf/nevisauth.yml --log-config /var/opt/nevisauth/default/conf/log4j.xml