Server Options

Each configuration option may be specified by either a CLI option or an Environment Variable. For example, the Server may be started on a different port through:

$ precept start --http.port=8081
$ # OR
$ PRECEPT_HTTP_PORT=8081 precept start

List Options (denoted by a [] suffix on their Type in the table below) may be supplied multiple times as a CLI option, or as a comma-separated list when supplied an an Environment Variable:

$ precept start \
$   --http.cors=https://my.origin.com \
$   --http.cors=https://other.origin.com
$ # OR
$ PRECEPT_HTTP_CORS="https://my.origin.com,https://other.origin.com" \
$   precept start

Please consult the following table for a comprehensive list of Options expected by the Server:

Option	Environment Variable	Description
--http.port	PRECEPT_HTTP_PORT	Port number to listen for HTTP requests on Type: number Default: 8080
--http.cors	PRECEPT_HTTP_CORS	Allowed CORS origins. May be specified multiple times. Type: string[] Default: []
--http.base-url	PRECEPT_HTTP_BASE_URL	Required External base URL that the HTTP server is reachable from. Type: string
--http.auth.issuer-base-url	PRECEPT_HTTP_AUTH_ISSUER_BASE_URL	Required Base URL of the OAuth2 provider Type: string
--http.auth.audience	PRECEPT_HTTP_AUTH_AUDIENCE	Required Expected audience of JWT tokens Type: string
--http.auth.ui.client-id	PRECEPT_HTTP_AUTH_UI_CLIENT_ID	Required Client ID that the UI should use. Type: string
--http.auth.ui.authority	PRECEPT_HTTP_AUTH_UI_AUTHORITY	Required Base URL that the UI will attempt to use for oAuth2 authentication. Defaults to the same URL given to `--http.auth.issuer-base-url`. Type: string
--http.auth.ui.query-params	PRECEPT_HTTP_AUTH_UI_QUERY_PARAMS	Required JSON-encoded query params that the UI will pass through to the IDP during login. Supported query params vary across IDP implementations. Type: string
--http.auth.ui.query-params-whitelist	PRECEPT_HTTP_AUTH_UI_QUERY_PARAMS_WHITELIST	Required List of query params that may be manually specified in the login URL before passing through to IDP. Type: string[]
--http.ui.custom-logo-url	PRECEPT_HTTP_UI_CUSTOM_LOGO_URL	Required Custom logo URL to replace the default Precept logo in the UI. Type: string
--datapack	PRECEPT_DATAPACK_PATHS	Path to a Datapack file or glob pattern. May be specified multiple times. Type: string[] Default: []
--storage.connection	PRECEPT_STORAGE_CONNECTION	Required PostgreSQL Storage Driver connection string Type: string
--secrets-jwe.secret	PRECEPT_SECRETS_JWE_SECRET	Required Path to the JWK-formatted secret key that will be used for JWE encryption/decryption. Type: string
--secrets-jwe.allow-plaintext-passthru	PRECEPT_SECRETS_JWE_ALLOW_PLAINTEXT_PASSTHRU	Allow config values already stored in plaintext to be passed through to Resource Actions. Type: string
--license.key	PRECEPT_LICENSE_KEY	Required License key specified as a JWT string Type: string
--license.file	PRECEPT_LICENSE_FILE	Required Path to the file containing the license key in JWT format Type: string
--license.public-key	PRECEPT_LICENSE_PUBLIC_KEY	Required Public key for license validation Type: string
--license.public-key-file	PRECEPT_LICENSE_PUBLIC_KEY_FILE	Required Path to the file containing the public key Type: string