|
You must provide a keystore to start the container if HTTPS is enabled. Otherwise, the container exits.
|
|
Where PASSWORD appears in the files, you must replace it with the password for ThingWorx or for the database.
|
|
The initial memory is set to 2 GB, and the maximum memory is set to 4 GB.
|
Variable Names
|
Values
|
Defaults
|
Comments
|
---|---|---|---|
INITIAL_HEAP
|
Number
|
2
|
Sets the initial memory size for the instance in GB.
|
MAX_HEAP
|
Number
|
4
|
Sets the maximum memory size for the instance in GB
|
ENABLE_HTTP
|
true/false
|
true
|
Enables the HTTP connector on Tomcat for unsecured traffic to the container.
|
ENABLE_HTTPS
|
true/false
|
false
|
Enables the HTTPS connector on Tomcat for secured traffic to the container. You must also provide a keystore and SSL_KEYSTORE_PASSWORD must be set.
|
SSL_KEYSTORE_PASSWORD
|
String
|
PASSWORD
|
Sets the password to the keystore used for SSL communication in Tomcat.
|
SSL_KEYSTORE_BASE_PATH
|
String
|
/ThingworxPlatform
|
Sets the path to the Tomcat SSL keystore. If you store the keystore in a location in the container other than the default folder, you must set this variable.
|
SSL_KEYSTORE_FILENAME
|
String
|
keystore.jks
|
Sets the file name for the Tomcat SSL keystore. If your keystore has a file name other than the default, you must set this variable.
|
TOMCAT_SSL_PROTOCOLS
|
String
|
TLSv1.2
|
Specifies the Tomcat SSL protocol. Set this if you want to override the accepted SSL protocols in Tomcat.
|
SERVER_HTTP_PORT
|
String
|
8080
|
Specifies the port that Tomcat monitors for HTTP communication. Note that if this port is changed, you must change the exposed ports in the Compose file.
|
SERVER_HTTPS_PORT
|
String
|
8443
|
Specifies the port that Tomcat monitors for HTTPS communication. Note that if this port is changed, you must change the exposed ports in the Compose file.
|
DOCKER_DEBUG
|
true/false
|
false
|
Toggles the option for recording debugging information when the container starts up. Note that this might contain sensitive information.
|
LS_USERNAME
|
String
|
""
|
Specifies your PTC login user name to get your ThingWorx License.
|
LS_PASSWORD
|
String
|
""
|
Specifies your PTC login password to get your ThingWorx License.
|
ENABLE_BACKUP
|
true/false
|
false
|
Toggles the option for backups.
|
ENABLE_LOGGING
|
true/false
|
true
|
Toggles the option for logging.
|
ENCRYPT_CREDENTIALS
|
true/false
|
false
|
Toggles the option to encrypt passwords for databases and licensing in the platform-settings.json file.
|
THINGWORX_INITIAL_PASSWORD
|
String
|
""
|
Sets the initial password for the Administrator user in ThingWorx. This variable must be manually set before starting the ThingWorx Platform. This password may be changed after ThingWorx starts up successfully.
|
EXTPKG_IMPORT_POLICY_ENABLED
|
true/false
|
false
|
Controls global enable/disable of Extension Package import through the Extension Package Uploader.
|
EXTPKG_IMPORT_POLICY_ALLOW_JARRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain Jar (Java) resources. If false and the Extension contains jar files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_JSRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain Javascript resources. If false and the Extension contains javascript files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_CSSRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain CSS resources. If false and the Extension contains css files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_JSONRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain JSON resources. If false and the Extension contains json files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_WEBAPPRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain WebApps resources. If false and the Extension contains WebApp resource files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_ENTITIES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain non-extensible entity definitions. If false and the Extension contains non-extensible entity definitions, other than the Extension Package entity, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_EXTENTITIES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain extensible entity definitions. If false and the Extension contains extensible entity definitions, other than the Extension Package entity, the import will fail.
|
|
When updating the volume path, change only the local mount as the mount points of the internal container never change.
|
|
The initial memory is set to 2 GB and the maximum memory is set to 4 GB. The volume mounts are relative to docker-compose files. This is the location where the logs and configuration files are stored to enable persistence in the containers.
|
Variable Names
|
Values
|
Defaults
|
Comments
|
---|---|---|---|
INITIAL_HEAP
|
Number
|
2
|
Sets the initial memory size for the instance in GB.
|
MAX_HEAP
|
Number
|
4
|
Sets the maximum memory size for the instance in GB.
|
DATABASE_HOST
|
String
|
mssql
|
Specifies the hostname, service name, or IP address of the SQL Server database host.
|
DATABASE_PORT
|
Number
|
1433
|
Specifies the port number for the SQL Server database.
|
DATABASE_ADMIN_USERNAME
|
String
|
SA
|
Specifies the administrator user name for the SQL Server database.
|
DATABASE_ADMIN_PASSWORD
|
String
|
PASSWORD
|
Specifies the administrator password for the SQL Server database.
|
ENABLE_HTTP
|
true/false
|
true
|
Enables the HTTP connector on Tomcat for unsecured traffic to the container
|
ENABLE_HTTPS
|
true/false
|
false
|
Enables the HTTPS connector on Tomcat for secured traffic to the container. You must also provide a keystore and set SSL_KEYSTORE_PASSWORD.
|
SSL_KEYSTORE_PASSWORD
|
String
|
PASSWORD
|
Specifies the password to keystore used for SSL communication in Tomcat.
|
SSL_KEYSTORE_BASE_PATH
|
String
|
/ThingworxPlatform
|
Specifies the path to the Tomcat SSL keystore. If you store the keystore in a location in the container other than the default folder, you must set this variable.
|
SSL_KEYSTORE_FILENAME
|
String
|
keystore.jks
|
Specifies the file name for the Tomcat SSL keystore. If your keystore has a file name other than the default, you must set this variable.
|
TOMCAT_SSL_PROTOCOLS
|
String
|
TLSv1.2
|
Specifies the Tomcat SSL protocol. Set this if you want to override the accepted SSL protocols in Tomcat.
|
SERVER_HTTP_PORT
|
String
|
8080
|
Specifies the port that Tomcat monitors for HTTP communication. Note that if this port is changed, you must change the exposed ports in the Compose file.
|
SERVER_HTTPS_PORT
|
String
|
8443
|
Specifies the port that Tomcat monitors for HTTPS communication. Note that if this port is changed, you must change the exposed ports in the Compose file.
|
DOCKER_DEBUG
|
true/false
|
false
|
Toggles the option for recording debugging information when the container starts up. Note that this might contain sensitive information.
|
TWX_DATABASE_USERNAME
|
String
|
""
|
Specifies the ThingWorx user that will be created for the database. This variable must be manually set before starting the ThingWorx Platform.
|
TWX_DATABASE_PASSWORD
|
String
|
""
|
Specifies the password for the ThingWorx user for the database. This variable must be manually set before starting the ThingWorx Platform.
|
TWX_DATABASE_SCHEMA
|
String
|
""
|
Specifies the schema name for the ThingWorx instance. This variable must be manually set before starting the ThingWorx Platform.
|
LS_USERNAME
|
String
|
""
|
Specifies the PTC login user name to get your ThingWorx License.
|
LS_PASSWORD
|
String
|
""
|
Specifies your PTC login password to get your ThingWorx License.
|
ENABLE_BACKUP
|
true/false
|
false
|
Toggles the option for backups.
|
ENABLE_LOGGING
|
true/false
|
true
|
Toggles the option for logging.
|
ENCRYPT_CREDENTIALS
|
true/false
|
false
|
Toggles the option to encrypt passwords for databases and licensing in the platform-settings.json file.
|
THINGWORX_INITIAL_PASSWORD
|
String
|
""
|
Sets the initial password for the Administrator user in ThingWorx. This variable must be manually set before starting the ThingWorx Platform. This password may be changed after ThingWorx starts up successfully.
|
EXTPKG_IMPORT_POLICY_ENABLED
|
true/false
|
false
|
Controls global enable/disable of Extension Package import through the Extension Package Uploader.
|
EXTPKG_IMPORT_POLICY_ALLOW_JARRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain Jar (Java) resources. If false and the Extension contains jar files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_JSRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain Javascript resources. If false and the Extension contains javascript files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_CSSRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain CSS resources. If false and the Extension contains css files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_JSONRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain JSON resources. If false and the Extension contains json files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_WEBAPPRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain WebApps resources. If false and the Extension contains WebApp resource files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_ENTITIES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain non-extensible entity definitions. If false and the Extension contains non-extensible entity definitions, other than the Extension Package entity, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_EXTENTITIES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain extensible entity definitions. If false and the Extension contains extensible entity definitions, other than the Extension Package entity, the import will fail.
|
|
When updating the volume path, change only the local mount as the mount points of the internal container never change.
|
|
The initial memory is set to 2 GB and the maximum memory is set to 4 GB. The volume mounts are relative to docker-compose files. This is the location where the logs and configuration files are stored to enable persistence in the containers.
|
Variable Names
|
Values
|
Defaults
|
Comments
|
---|---|---|---|
INITIAL_HEAP
|
Number
|
2
|
Sets the initial memory size for the instance in GB.
|
MAX_HEAP
|
Number
|
4
|
Sets the maximum memory size for the instance in GB.
|
DATABASE_HOST
|
String
|
postgressql
|
Specifies the hostname, service name, or IP address of the PostgreSQL database host.
|
DATABASE_PORT
|
Number
|
5432
|
Specifies the port number for the PostgreSQL database.
|
DATABASE_ADMIN_USERNAME
|
String
|
postgres
|
Specifies the administrator user name for the PostgreSQL database.
|
DATABASE_ADMIN_PASSWORD
|
String
|
PASSWORD
|
Specifies the administrator password for the PostgreSQL database.
|
ENABLE_HTTP
|
true/false
|
true
|
Enables the HTTP connector on Tomcat for unsecured traffic to the container.
|
ENABLE_HTTPS
|
true/false
|
false
|
Enables the HTTPS connector on Tomcat for secured traffic to the container. You must also provide a keystore and set SSL_KEYSTORE_PASSWORD
|
SSL_KEYSTORE_PASSWORD
|
String
|
PASSWORD
|
Specifies the password to keystore used for SSL communication in Tomcat.
|
SSL_KEYSTORE_BASE_PATH
|
String
|
/ThingworxPlatform
|
Specifies the path to the Tomcat SSL keystore. If you store the keystore in a location in the container other than the default folder, you must set this variable.
|
SSL_KEYSTORE_FILENAME
|
String
|
keystore.jks
|
Specifies the file name for the Tomcat SSL keystore. If your keystore has a file name other than the default, you must set this variable.
|
TOMCAT_SSL_PROTOCOLS
|
String
|
TLSv1.2
|
Specifies the Tomcat SSL protocol. Set this if you want to override the accepted SSL protocols in Tomcat.
|
SERVER_HTTP_PORT
|
String
|
8080
|
Specifies the port that Tomcat monitors for HTTP communication. Note that if this port is changed, you must change the exposed ports in the Compose file.
|
SERVER_HTTPS_PORT
|
String
|
8443
|
Specifies the port that Tomcat monitors for HTTPS communication. Note that if this port is changed, you must change the exposed ports in the Compose file.
|
DOCKER_DEBUG
|
true/false
|
false
|
Toggles the option for recording debugging information when the container starts up. Note that this might contain sensitive information.
|
TWX_DATABASE_USERNAME
|
String
|
""
|
Specifies the ThingWorx user that will be created for the database. This variable must be manually set before starting the ThingWorx Platform. Note that for PostgreSQL, TWX_DATABASE_USERNAME:
• Should match TWX_DATABASE_SCHEMA due to a limitation of the existing implementation
• Should not be postgres
|
TWX_DATABASE_PASSWORD
|
String
|
""
|
Specifies the password for the ThingWorx user for the database. This variable must be manually set before starting the ThingWorx Platform.
|
TWX_DATABASE_SCHEMA
|
String
|
""
|
Specifies the schema name for the ThingWorx instance. This variable must be manually set before starting the ThingWorx Platform. Note that for PostgreSQL, TWX_DATABASE_USERNAME should match TWX_DATABASE_SCHEMA due to a limitation of the existing implementation.
|
TABLESPACE_LOCATION
|
String
|
/ThingworxPostgresqlStorage
|
Specifies the location of the tablespace on the database server.
|
IS_RDS
|
yes/no
|
no
|
Toggles the option for connecting to an RDS PostgreSQL database.
|
LS_USERNAME
|
String
|
""
|
Specifies the PTC login user name to get your ThingWorx License.
|
LS_PASSWORD
|
String
|
""
|
Specifies the PTC login password to get your ThingWorx License.
|
ENABLE_BACKUP
|
true/false
|
false
|
Toggles the option for backups.
|
ENABLE_LOGGING
|
true/false
|
true
|
Toggles the option for logging.
|
ENCRYPT_CREDENTIALS
|
true/false
|
false
|
Toggles the option to encrypt passwords for databases and licensing in the platform-settings.json file.
|
THINGWORX_INITIAL_PASSWORD
|
String
|
""
|
Sets the initial password for the Administrator user in ThingWorx. This variable must be manually set before starting the ThingWorx Platform. This password may be changed after ThingWorx starts up successfully.
|
EXTPKG_IMPORT_POLICY_ENABLED
|
true/false
|
false
|
Controls global enable/disable of Extension Package import through the Extension Package Uploader.
|
EXTPKG_IMPORT_POLICY_ALLOW_JARRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain Jar (Java) resources. If false and the Extension contains jar files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_JSRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain Javascript resources. If false and the Extension contains javascript files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_CSSRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain CSS resources. If false and the Extension contains css files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_JSONRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain JSON resources. If false and the Extension contains json files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_WEBAPPRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain WebApps resources. If false and the Extension contains WebApp resource files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_ENTITIES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain non-extensible entity definitions. If false and the Extension contains non-extensible entity definitions, other than the Extension Package entity, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_EXTENTITIES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain extensible entity definitions. If false and the Extension contains extensible entity definitions, other than the Extension Package entity, the import will fail.
|
POSTGRES_USER
|
String
|
""
|
Specifies the administrator user name for the PostgreSQL database.
|
POSTGRES_PASSWORD
|
String
|
""
|
Specifies the administrator password for the PostgreSQL database.
|
POSTGRES_DB
|
String
|
""
|
Specifies the name of the PostgreSQL database.
Additional variables for POSTGRESQL and their details can be found at the Docker Hub.
|
|
When updating the volume path, change only the local mount as the mount points of the internal container never change.
|
|
You must have an Azure SQL database configured in Microsoft Azure to use it with ThingWorx Dockerfiles. For information on setting up an AzureSQL database, see Using Azure SQL Server as the Persistence Provider.
|
|
The initial memory is set to 2 GB and the maximum memory is set to 4 GB.
|
Variable Names
|
Values
|
Defaults
|
Comments
|
---|---|---|---|
INITIAL_HEAP
|
Number
|
2
|
Sets the initial memory size for the instance in GB.
|
MAX_HEAP
|
Number
|
4
|
Sets the maximum memory size for the instance in GB.
|
DATABASE_HOST
|
String
|
N/A
|
Specifies the URL for the Azure SQL database.
|
DATABASE_ADMIN_USERNAME
|
String
|
N/A
|
Specifies the administrator user name for the Azure SQL database. Set only if you want the docker container to create TWX_DATABASE_USERNAME and initialize ThingWorx database tables.
|
DATABASE_ADMIN_PASSWORD
|
String
|
N/A
|
Specifies the administrator password for the Azure SQL database. Set only if you want the docker container to create TWX_DATABASE_USERNAME and initialize ThingWorx database tables.
|
ENABLE_HTTP
|
true/false
|
true
|
Enables the HTTP connector on Tomcat for unsecured traffic to the container
|
ENABLE_HTTPS
|
true/false
|
false
|
Enables the HTTPS connector on Tomcat for secured traffic to the container. You must also provide a keystore and set SSL_KEYSTORE_PASSWORD
|
SSL_KEYSTORE_PASSWORD
|
String
|
PASSWORD
|
Specifies the password to keystore used for SSL communication in Tomcat.
|
SSL_KEYSTORE_BASE_PATH
|
String
|
/ThingworxPlatform
|
Specifies the path to the Tomcat SSL keystore. If you store the keystore in a location in the container other than the default folder, you must set this variable.
|
SSL_KEYSTORE_FILENAME
|
String
|
keystore.jks
|
Specifies the file name for the Tomcat SSL keystore. If your keystore has a file name other than the default, you must set this variable.
|
TOMCAT_SSL_PROTOCOLS
|
String
|
TLSv1.2
|
Specifies the Tomcat SSL protocol. Set this if you want to override the accepted SSL protocols in Tomcat.
|
SERVER_HTTP_PORT
|
String
|
8080
|
Specifies the port that Tomcat monitors for HTTP communication. Note that if this port is changed, you must change the exposed ports in the Compose file.
|
SERVER_HTTPS_PORT
|
String
|
8443
|
Specifies the port that Tomcat monitors for HTTPS communication. Note that if this port is changed, you must change the exposed ports in the Compose file.
|
DOCKER_DEBUG
|
true/false
|
false
|
Toggles the option for recording debugging information when the container starts up. Note that this might contain sensitive information.
|
TWX_DATABASE_USERNAME
|
String
|
""
|
Specifies the ThingWorx user that will be created for the database. This variable must be manually set before starting the ThingWorx Platform.
|
TWX_DATABASE_PASSWORD
|
String
|
""
|
Specifies the password for the ThingWorx user for the database. This variable must be manually set before starting the ThingWorx Platform. The variable must also conform to the password policy for Azure SQL Database. See Password Policy for details.
|
TWX_DATABASE_SCHEMA
|
String
|
""
|
Specifies the schema name for the ThingWorx instance. This variable must be manually set before starting the ThingWorx Platform.
|
LS_USERNAME
|
String
|
""
|
Specifies the PTC login user name to get your ThingWorx License.
|
LS_PASSWORD
|
String
|
""
|
Specifies the PTC login password to get your ThingWorx License.
|
ENABLE_BACKUP
|
true/false
|
false
|
Toggles the option for backups.
|
ENABLE_LOGGING
|
true/false
|
true
|
Toggles the option for logging.
|
ENCRYPT_CREDENTIALS
|
true/false
|
false
|
Toggles the option to encrypt passwords for databases and licensing in the platform-settings.json file.
|
THINGWORX_INITIAL_PASSWORD
|
String
|
""
|
Sets the initial password for the Administrator user in ThingWorx. This variable must be manually set before starting the ThingWorx Platform. This password may be changed after ThingWorx starts up successfully.
|
EXTPKG_IMPORT_POLICY_ENABLED
|
true/false
|
false
|
Controls global enable/disable of Extension Package import through the Extension Package Uploader.
|
EXTPKG_IMPORT_POLICY_ALLOW_JARRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain Jar (Java) resources. If false and the Extension contains jar files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_JSRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain Javascript resources. If false and the Extension contains javascript files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_CSSRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain CSS resources. If false and the Extension contains css files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_JSONRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain JSON resources. If false and the Extension contains json files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_WEBAPPRES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain WebApps resources. If false and the Extension contains WebApp resource files, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_ENTITIES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain non-extensible entity definitions. If false and the Extension contains non-extensible entity definitions, other than the Extension Package entity, the import will fail.
|
EXTPKG_IMPORT_POLICY_ALLOW_EXTENTITIES
|
true/false
|
false
|
Controls import permissions for Extension Packages that contain extensible entity definitions. If false and the Extension contains extensible entity definitions, other than the Extension Package entity, the import will fail.
|
|
When updating the volume path, change only the local mount as the mount points of the internal container never change.
|