ASPNETCORE_Kestrel__Certificates__Default__Password

The password of the PFX file used to support HTTPS/SSL communications on the Vera Server.

Note: This variable is not needed when HTTPS/SSL is not used. When it is used, this variable must be used with the ASPNETCORE_Kestrel__Certificates__Default__Path variable.

N/A

ASPNETCORE_Kestrel__Certificates__Default__Path

The name of the PFX file used to support HTTPS/SSL communications on the Vera Server. This value must be a fully qualified path to the certificate file.

Note: This variable is not needed when HTTPS/SSL is not used. When it is used, this variable must be used with the ASPNETCORE_Kestrel__Certificates__Default__Password variable.

N/A

ASPNETCORE_URLS

The URLs (with ports) that will be bound to by the Vera Server.

Note: When using Docker, these URLs refer to the internal URLs of the Docker network.

https://+:5001;http://+:5000

VERA_MAXREQUESTBODYSIZE

The maximum total size of HTTP requests sent within Vera. This value can be updated to adjust the maximum length of requests - especially when attaching large files to items.

Negative value will disable the limit completely.

209715200 (200MB)

VERA_MULTIPARTBODYLENGTHLIMIT

The maximum size of a single part within an HTTP multi-part message. This can be updated to adjust the maximum size of a single file attachment.

209715200 (200MB)

VERA_SERVER_DATA_DIR

The path of the Vera Server's data directory. The Certificates, Configs, Logs, and Policies sub-directories must be located within this directory.

ProgramData\Tx3 Services

VERA_SERVER_ENCRYPTION_KEY

The encryption key that was used to encrypt service account passwords in the Synchronization Policy file.

N/A

VERA_SERVER_JWT_CERT_NAME

The PFX file that is used for signing the JSON Web Tokens used by the VERA Server.. This configuration must reference the name of a file in the server's Certificates directory; absolute paths are not supported.

Tx3Jwt.pfx

VERA_SERVER_JWT_CERT_PASSWORD

The password of the PFX file used for signing the JSON web tokens.

***REDACTED***

VERA_SERVER_LOG_LEVEL

The logging level used by the web portal. Valid options include INFO and FULL and NONE.

INFO

VERA_SERVER_MONGO_URL

The MongoDB connection string that should be used by the Vera Server to connect to its backend database.

mongodb://localhost:27017

VERA_SERVER_URL

The preferred URL that should be used by Vera for internal module communications.

http://localhost:5000

VERA_SERVER_MAX_FAILED_LOGINS

The maximum number of consecutive failed logins before a user is locked out of their account.

5

VERA_SERVER_MAX_LOCK_PERIOD

The amount of time (in whole minutes) that a user will be locked out of their account.

10

VERA_SERVER_URL

The URL of the back-end Vera Server.

Read from the config.yaml configuration file (as veraServerUrl).

VERA_USER_GUIDE_URL

The Vera User Guide link is pre-configured to go to Tricentis Vera Documentation (https://tx3.atlassian.net/wiki/display/VUI) site, but can be changed to a different URL

Read from the config.yaml configuration file (as userGuideUrl).

VERA_WEB_DATA_DIR

The path of the Vera Web Portal's data directory. The Certificates, Configs, and Logs sub-directories must be located within this directory.

Note: The config.yaml file must be located within the Configs sub-directory of this configured directory.

../../Data

VERA_WEB_HTTP_PORT

The port that the Web Portal will bind to for HTTP communications.

Read from the config.yaml configuration file (as nodePort).

VERA_WEB_HTTPS_FILE

The PFX file that is used for configuring HTTPS/SSL communications on the Web Portal. This configuration must reference the name of a file in the Web Portal's Certificates directory; absolute paths are not supported.

Note: This variable is not needed when HTTPS/SSL is not used. When it is used, this variable must be used with the VERA_WEB_HTTPS_PASS and VERA_WEB_HTTPS_PORT variables.

Read from the config.yaml configuration file (as httpsCertFile).

VERA_WEB_HTTPS_PASS

The password of the PFX file that is used for configuring HTTPS/SSL communications on the Web Portal.

Note: This variable is not needed when HTTPS/SSL is not used. When it is used, this variable must be used with the VERA_WEB_HTTPS_FILE and VERA_WEB_HTTPS_PORT variables.

Read from the config.yaml configuration file (as httpsCertPassphrase).

VERA_WEB_HTTPS_PORT

The port that the Web Portal will bind to for HTTPS communications.

Note: This variable is not needed when HTTPS/SSL is not used. When it is used, this variable must be used with the VERA_WEB_HTTPS_FILE and VERA_WEB_HTTPS_PASS variables.

Read from the config.yaml configuration file (as nodePortHttps).

VERA_WEB_MONGO_ARGS

Additional arguments than should be appended to the MongoDB connection string.  The value must be configured as a URL query string with variables separated by ampersands (&) and with individual keys and values joined by equal signs (=).

Example:  ssl=true&sslValidate=true

Read from the config.yaml configuration file (as mongoDbArgs).

VERA_WEB_MONGO_URL

The MongoDB connection string that should be used by the Vera Web Portal to connect to its backend database.

Read from the config.yaml configuration file (as mongoDbUrl).

VERA_WEB_PREFER_HTTPS

Setting this to true will cause Vera Web Portal to redirect any HTTP traffic to HTTPS.

Note: If HTTPS is not set up properly, then all traffic will fail.

false

Read from the config.yaml configuration file (as preferHttps).

VERA_WEB_SECURE_COOKIES

Setting this to true will cause Vera Web Portal use the secure flag on all cookies. This will cause cookies to only be sent over HTTPS.

Note: This may prevent users from logging into VERA Web Portal over a HTTP connection.

false

Read from the config.yaml configuration file (as secureCookie).

VERA_WEB_URL

The base url of the web portal (e.g. https://vera.tx3helios.com). This is used only for the SAML  Service Provider configuration. Do not include a trailing slash.

Read from the config.yaml configuration file (as webPortalUrl).

VERA_ALLOW_IDP_ACCOUNT_REUSE

Setting this to true will allow the same Identity Provider Account to be used for multiple Vera accounts. This is useful for having multiple test accounts associated with one SSO account. This is not recommended for production systems.

Read from the config.yaml configuration file (as allowIdpAccountReuse).

VERA_WEB_LOG_LEVEL

The logging level used by the web portal. Valid options include debug, info, and error.

Read from the config.yaml configuration file (as logLevel).

VERA_WEB_SAML_SIG_SP_ID

The ID that is used to identify the Vera Signatures Service Provider with connected Identity Providers.

Read from the config.yaml configuration file (as samlSignatureEntityId).

VERA_WEB_SAML_SP_ID

The ID that is used to identify the Vera Service Provider with connected Identity Providers.

Read from the config.yaml configuration file (as samlEntityId).

VERA_WEB_SAML_SP_PRIVATE_KEY_FILE

The private security key used to encrypt communications between Vera's services providers and connected Identity Providers.

Read from the config.yaml configuration file (as samlPrivateKeyFile).

VERA_WEB_SAML_SP_PUBLIC_CERT_FILE

The public security key used to encrypt communications between Vera's services providers and connected Identity Providers.

Read from the config.yaml configuration file (as samlPublicCertFile).

VERA_WEB_COOKIE_MAX_AGE

This has been deprecated and will no longer be used.

Read from config.yaml.

VERA_WEB_PORTAL_IDLE_TIMEOUT_MINUTES

The maximum amount of minutes of inactivity the Vera Web Portal will allow before logging out a user.

10 (in minutes). Read from the config.yaml configuration file (as idleTimeoutMinutes).

VERA_WEB_PORTAL_IDLE_PROMPT_SECONDS

The number of seconds before logging out a user for inactivity that the Vera Web Portal will warn the user of the impending logout.

120 (in seconds). Read from the config.yaml configuration file (as idlePromptSeconds).

VERA_VERIFICATION_EXPIRATION_DAYS

The number of days after which a successful verification will expire. i.e. Each individual Vera signature will be re-verified after this number of days.

30

VERA_VERIFICATION_START_TIME

The time in 24-hour format at which the verification service will run daily. Expected format is: HH:mm. Example: 23:59

00:01

(one minute after midnight)

VERA_VERIFICATION_URL

The full URL of the Verification Service, if hosted on a server different than the API server.

Read from the config.yaml configuration file (as  verificationServiceUrl).