crossroads-mgr(1) - Linux man page

e-tunity

Name

Synopsis

o

crossroads-mgr [flags] start port: starts the web interface server

o

crossroads-mgr stop: stops the server

o

crossroads-mgr status: shows whether the server is running

Description

crossroads-mgr is a self-contained web server, written in Perl, providing a web interface to control Crossroads. The web interface allows one to:

o

View the states of back ends, and their usage;

o

Set the states of back ends (e.g., to take a back end out of service).

The web interface cannot be used to fully configure Crossroads (e.g., to add new back ends). This must be done via the configuration file crossroads.conf. Note furthermore that crossroads status and crossroads tell are commandline tools that achieve the same functionality as crossroads-mgr.

Options

crossroads-mgr recognizes the following flags:

o

-a ADDRESS: Specifies the address to which the manager binds. E.g., one may specify -a 127.0.0.1, after which only requests originating from localhost will be served.

o

-b UN:PW: Viewing the status is protected using simple basic authentication, requiring username UN and password PW.

For example one may specify: -b user:secret, after which

visitors to the web interface are prompted for a username and password.

Instead of the username, a colon, and a password, the special

word PROMPT may be used (in caps). In this case, crossroads-mgr prompts for the entry of a username and a password. Using PROMPT will have the effect that the username and password are not shown in a process listing.

o

-B UN:PW: Setting the status of a back end is protected using simple basic authentication, with username UN and password PW. The special word PROMPT may be used.

o

-f: crossroads-mgr stays in the foreground instead of daemonizing. Useful for debugging.

o

-l FILE: Verbose activity (when -v is given) is written to the stated file. Useful for debugging. Also, error messages are written to the file. The default is /tmp/crossroads-mgr.log. Note that file logging is not used in 'foreground' mode (flag -f; in that case all logging goes to terminal).

o

-v: Verbosity is increased.

o

-x CMD: This specifies how crossroads-mgr should invoke crossroads. The default is just crossroads. An example is: /usr/local/bin/crossroads -c /alternative/configuration which overrules the default configuration file name. Note that once -x is given, crossroads-mgr will no longer search along the PATH. When using -x, the full access path to crossroads must be specified.

o

-X XSLT: Causes crossroads-mgr to send the specified XSLT file, instead of the built-in. Useful for debugging.

Bugs

o

Basic authentication headers are logged when -v is active. Make sure that the log file is not in a world-readable place, or turn off -v.

o

When using basic authentication in the form -b UN:PW and -B UN:PW, the required credentials are visible in the process overview list. Use PROMPT to hide these.

o

crossroads-mgr stop and crossroads-mgr status use the process list to see which daemons are active. If you start more than one daemon, then crossroads-mgr stop will stop all of them.

Author

o

Author: Karel Kubat

o

Maintainer: Karel Kubat karel@kubat.nl