Environment Configuration Variables - solace-cto-labs/platform-api GitHub Wiki
The following environment variables modify the configuration of the API Server.
| Variable Name | Description | Default | Required | Example |
|---|---|---|---|---|
| General | ||||
| LOG_LEVEL | Enabled log level, all higher severity logs will also be emitted; uses pino log levels | debug | N | debug |
| DB_URL | The mongo db connection URL. Any database referenced in the URL will be ignored. The server uses the platform database for configuration data and a dedicated database per organization. |
Y | Local database: mongodb://localhost:27017/solace-platform?retryWrites=true, Cloud (Atlas): mongodb+srv://user:[email protected]/solace-platform?retryWrites=true&w=majority |
|
| PLATFORM_PORT | HTTP port of the server, defaults to 3000 if omitted |
3000 | N | 9090 |
| HTTPS_PROXY | proxy to use for HTTPS requests. Outbound calls from the connector are nearly exclusively using HTTPS. | N | http://localhost:8080 | |
| HTTP_PROXY | proxy to use for HTTP requests | N | http://localhost:8080 | |
| NO_PROXY | a comma-separated list of DNS suffixes or IP addresses that can be accessed without passing through the proxy | N | *.internal,localhost | |
| APIS_PROXY_MODE | Switch the APIS resource into Event Portal proxy mode, which automatically exposes all Event API products | false | N | true |
| Authentication/IdP | ||||
| FILE_USER_REGISTRY | Path to the user registry file for basic authentication. | Y | /home/admin/users.json | |
| AUTH_EXTRACTION_USER_PRINCIPAL | JSON path to locate the attribute containing the user name in the JWT | $.upn | N | $.preferred_username |
| AUTH_EXTRACTION_ORGS | JSON path to locate the attribute containing the organization membership information in the JWT | $.groups | N | $.organization |
| AUTH_EXTRACTION_ROLES | JSON path to locate the attribute containing the roles information in the JWT | $.resource_access['platform-api-server'].roles | N | $.roles |
| AUTH_VERIFICATION_KEY | Path to the file containing the IdP's public key or certificate in PEM format | Y | /home/admin/public_key.pem | |
| AUTH_VERIFICATION_AUD | The expected value in the JWT aud (audience) attribute |
Y | platform-api-server | |
| AUTH_VERIFICATION_ISSUER | The expected value in the JWT iss (issuer) attribute |
Y | http://localhost/authserver | |
| AUTH_DISCOVERY_OIDC_URL | URL of the IdP's OpenIdConnect discovery endpoint. If omitted the API Explorer does not render OAuth/OpenId Connect authentication mechanisms. Any API client generated based on the Open API specification may not be able to obtain a JWT | N |