Supported Environment Variables
  • 02 Feb 2024
  • 3 Minutes to read
  • Dark
    Light
  • PDF

Supported Environment Variables

  • Dark
    Light
  • PDF

Article Summary

Environment variables can be used to specify certain values that are normally stored in your Inedo product's configuration file. Environment variables are intended for use with Docker, but may be used on any platform.

BuildMaster

Environment VariableDescription
BUILDMASTER_SQL_CONNECTION_STRINGThe connection string for your SQL Server. The value specified in the example here assumes you are using the buildmaster-sql container. To connect to a different instance, just change this connection string to the appropriate value. Enclosed in single quotes.

Example: -e BUILDMASTER_SQL_CONNECTION_STRING='Data Source=inedo-sql; Initial Catalog=BuildMaster; User ID=sa; Password=«YourStrong!Passw0rd»'
BUILDMASTER_SQL_CONNECTION_STRING_FILECan be used instead of the connection string above to read the connection string from file location within the container. This facilitates the use of Docker secrets to prevent passing clear text passwords in a Docker stack file. A Docker secret must be set first and 'called' within the stack file.

Example: -e BUILDMASTER_SQL_CONNECTION_STRING_FILE='/home/buildmaster/secrets/buildmaster_connection_string'
TZUsed to specify the timezone of the container. Can be set to any TZ database name

Example: -e TZ='America/Denver'
BUILDMASTER_ENCRYPTION_KEYThis specifies the 32-character hex encryption key BuildMaster uses to store some secrets.

Example: -e BUILDMASTER_ENCRYPTION_KEY='37D27A670394F7D82CE57F1F07D69747'
BUILDMASTER_ENCRYPTION_KEY_FILEThis specifies the full path of a text file that contains the encryption key described above.

Example: -e BUILDMASTER_ENCRYPTION_KEY_FILE='/home/buildmaster/secrets/buildmaster_encryption_key'
ASPNETCORE_URLSThis specifies the host and port Docker uses for HTTP connections.

Example: -e ASPNETCORE_URLS='http://*:8181'

ProGet

Environment VariableDescription
PROGET_SQL_CONNECTION_STRINGThe connection string for your SQL Server. The value specified in the example here assumes you are using the proget-sql container. To connect to a different instance, just change this connection string to the appropriate value. Enclosed in single quotes.

Example: -e PROGET_SQL_CONNECTION_STRING='Data Source=inedo-sql; Initial Catalog=ProGet; User ID=sa; Password=«YourStrong!Passw0rd»'
PROGET_SQL_CONNECTION_STRING_FILECan be used instead of the connection string above to read the connection string from file location within the container. This facilitates the use of Docker secrets to prevent passing clear text passwords in a Docker stack file. A Docker secret must be set first and 'called' within the stack file.

Example: -e PROGET_SQL_CONNECTION_STRING_FILE='/home/proget/secrets/proget_connection_string'
TZUsed to specify the timezone of the container. Can be set to any TZ database name

Example: -e TZ='America/Denver'
PROGET_ENCRYPTION_KEYThis specifies the 32-character hex encryption key ProGet uses to store some secrets.

Example: -e PROGET_ENCRYPTION_KEY='37D27A670394F7D82CE57F1F07D69747'
PROGET_ENCRYPTION_KEY_FILEThis specifies the full path of a text file that contains the encryption key described above.

Example: -e PROGET_ENCRYPTION_KEY_FILE='/home/proget/secrets/proget_encryption_key'
ASPNETCORE_URLSThis specifies the host and port Docker uses for HTTP and HTTPS connections.

Example HTTP: -e ASPNETCORE_URLS='http://*:8181'
Example HTTPS: ProGet v2022.18+ ONLY -e ASPNETCORE_URLS='http://*:80;https://*:443'
SSL_CERT_FILEProGet v2022.18+ ONLY Specifies the name of the ".pem" certificate file in the /var/proger/ssl/ directory.
SSL_KEY_FILEProGet v2022.18+ ONLY Specifies the name of the certificate kye file in the /var/proger/ssl/ directory.

For ProGet 5.3 and earlier, use SQL_CONNECTION_STRING instead of PROGET_SQL_CONNECTION_STRING, and also add -e PROGET_DB_TYPE=SqlServer.

Otter

Environment VariableDescription
OTTER_SQL_CONNECTION_STRINGThe connection string for your SQL Server. The value specified in the example here assumes you are using the otter-sql container. To connect to a different instance, just change this connection string to the appropriate value. Enclosed in single quotes.

Example: -e OTTER_SQL_CONNECTION_STRING='Data Source=inedo-sql; Initial Catalog=Otter; User ID=sa; Password=«YourStrong!Passw0rd»'
OTTER_SQL_CONNECTION_STRING_FILECan be used instead of the connection string above to read the connection string from file location within the container. This facilitates the use of Docker secrets to prevent passing clear text passwords in a docker stack file. A docker secret must be set first and 'called' within the stack file.

Example: -e OTTER_SQL_CONNECTION_STRING_FILE='/home/otter/secrets/otter_connection_string'
TZUsed to specify the timezone of the container. Can be set to any TZ database name

Example: -e TZ='America/Denver'
OTTER_ENCRYPTION_KEYThis specifies the 32-character hex encryption key Otter uses to store some secrets.

Example: -e OTTER_ENCRYPTION_KEY='37D27A670394F7D82CE57F1F07D69747'
OTTER_ENCRYPTION_KEY_FILEThis specifies the full path of a text file that contains the encryption key described above.

Example: -e OTTER_ENCRYPTION_KEY_FILE='/home/otter/secrets/otter_encryption_key'
ASPNETCORE_URLSThis specifies the host and port Docker uses for HTTP connections.

Example: -e ASPNETCORE_URLS='http://*:8181'

Was this article helpful?