Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

The shibd command runs the Shibboleth SP daemon process that handles state management and most of the SAML and security processing of the software. It On Windows, it is designed to run either from the command line or as a "service". On Unix platforms prior to V2.2, it will not put itself into the background, but can be backgrounded by the controlling shell in the usual manner. On Windows, it is designed to run either from the command line or as a "service". As of V2.2, the process backgrounds itself by default, but can be kept in the foreground with a command line option.

The following command line options are available based on the platform.

...

Option

Explanation

-check

Runs in console mode and loads the configuration, logging any serious issues to the console, then exits.

-console

Runs the program as a console application in the foreground rather than as a service.

-prefix path

Sets the top level location to which the software was installed (the shibd program should be in sbin/shibd.exe relative to this location) Alternative to SHIBSP_PREFIX environment variable.

-config pathname

Identifies the primary configuration file to use (defaults to etc/shibboleth/shibboleth2.xml relative to the installation prefix. Alternative to SHIBSP_CONFIG environment variable.

-catalogs pathname1;pathname2

Semicolon-delimited set of pathnames of XML Schema catalog files to use when parsing XML Alternative to SHIBSP_SCHEMAS environment variable.

-install name

Installs the program as a service using a provided name to distinguish it from other copies.

-remove name

Removes the named service definition.

Version 2.5 and Above

 

-stdout path

Routes stdout stream to the designated file.

-stderr path

Routes stderr stream to the designated file.

Unix

Option

Explanation

-t

Loads the configuration, logging any serious issues to the console, then exits.

-d path

Sets the top level location to which the software was installed (the shibd program should be in sbin/shibd.exe relative to this location). Alternative to SHIBSP_PREFIX environment variable.

-c pathname

Identifies the primary configuration file to use (defaults to etc/shibboleth/shibboleth2.xml relative to the installation prefix (unless the prefix is /usr). Alternative to SHIBSP_CONFIG environment variable.

-x pathname1:pathname2

Colon-delimited set of pathnames of XML Schema catalog files to use when parsing XML Alternative to SHIBSP_SCHEMAS environment variable.

-f

Forces removal of Unix domain socket file if the file is present when starting up.

-p pathname

Path to pid file to create.

-v

Prints software version.

-h

Help message.

Version 2.2 and Above

Option

Explanation

-w

Seconds to wait for the background process to fully initialize before returning success or failure to the shell.

-F

Keep the process in the foreground.

Version 2.5 and Above

Option

Explanation

-u

Username to run as.

-g

Group name to run as.