Environment (env)

Environments are used to distinguish between multiple ssoca installations. Aliases are used to reference environments in a more memorable way and are specified through the -e/--environment option or the SSOCA_ENVIRONMENT environment variable.

Client Commands

The environments can be managed through env subcommands.

  • info (details) – show environment information
  • list (details) – list all locally-configured environments
  • rename (details) – set a new name for the environment
  • services (details) – show current services available from the environment
  • set (details) – configure the connection to an environment
  • set-option (details) – set a local client option in the environment
  • unset (details) – remove all configuration for an environment
  • update-client (details) – download the latest client from the environment

Server Configuration Options

These options must be configured with the top-level env section rather than a service.

  • url – a fully-qualified URI for where the server can be reached
  • banner – a custom message which may be shown to users when they first connect
  • name – a default alias name which may be suggested to users
  • title a human friendly name for the environment which may be shown to users
  • metadata – a hash of arbitrary string keys and values which is opaque to the server and returned in the /env/info API endpoint
  • default_auth_service – a default authentication service to use (applies when multiple authentication services are configured)
  • update_service – the name of a configured file service which can provide ssoca client binaries