Skip to content

Configure the PLOSSYS CLI Environment

When using an OIDC identity provider for user authentication, the following environment variables have to be set in Windows for calling PLOSSYS CLI:

  • AUTH_CLIENT_ID: Client name configured in the OIDC identity provider for the seal-plossycli client, by default seal-plossyscli

  • AUTH_CLIENT_SECRET: Client secret generated in the OIDC identity provider for the seal-plossycli client (required).

  • AUTH_ISSUER_URL: The OIDC identity provider's auth issuer URL (required).

  • CONSUL_URL: URL of the Consul server (required if PLOSSYS CLI is executed on a server different to the PLOSSYS 5 server for managing the jobs and printers)

  • ID_PROVIDER_NAME: The name of the OIDC identity provider (required for some identity providers).

Example - environment variables for PLOSSYS CLI

AUTH_CLIENT_ID=seal-plossyscli

AUTH_CLIENT_SECRET=<client_secret_plossyscli>

AUTH_ISSUER_URL=https://p5_server:32769/realms/SEAL

CONSUL_URL=https://p5_server:8500

Hint - no consul

Please note, the environment variables for PLOSSYS CLI won't be read from Consul. They have to be set directly in the environment, for example in the current PowerShell:

$env:AUTH_CLIENT_ID='seal-plossyscli'

Hint - changed AUTH_ISSUER_URL as of Keycloak 21.0.1

As of SEAL-specific Keycloak version 21.0.1, the URL needed for `AUTH_ISSUER_URL has been changed.

  • old value: AUTH_ISSUER_URL=https://<hostname>:32769/auth/realms/SEAL

  • new value: AUTH_ISSUER_URL=https://<hostname>:32769/realms/SEAL

Literature - keys

For further information about the keys, refer to the description of the Service Keys.

Caution - validity

The environment variables set globally in Windows are valid for other services as well, seal-plossysadmin for example. Make sure that the settings for seal-plossysadmin are specified explicitly in the configuration, refer to Configure the PLOSSYS Administrator Environment.

Back to top