Docker parameters

Reference information for Docker run parameters used to start
FactoryTalk® Optix™ Runtime
 containers with online or offline entitlements.
Common parameters
Parameter
Importance
Description
--publish 49100:49100
Required
Maps the deployment and update service port. External port 49100 must map to internal port 49100. Do not map this service to a different external port.
--env ADMIN_PASSWORD=
admin_password
Required
Sets the administrator password that the container requires at startup.
--name
container_name
Recommended
The name for the
Docker
 container to run.
--publish
external_port
:
internal_port
Optional
Maps the web interface port from port 49100. Use this parameter if the application uses a web presentation engine.
external_port
An unused port available on the machine that runs the
Docker
 container.
internal_port
(only for applications with GUI) The
Port
 property value of the web presentation engine from
FactoryTalk Optix Studio
.
--restart unless-stopped
Recommended
Restarts the container automatically after a failure or host restart, or if the FactoryTalk Optix Application Update Service stops working.
-d
Optional
Runs the container in the background.
-v
local_folder
:/root/FTOptixApplication/Projects/
app_name
Optional
Binds the application folder to a local folder to persist changes made at
FactoryTalk Optix Application
 runtime.
local_folder
Folder on a local volume to bind the application folder to.
app_name
Name of the
FactoryTalk Optix Application
.
image_name
Required
Name of the
Docker
 image to run in the
Docker
 container.
TIP: You can check the available
Docker
 images by entering
docker images
 in the terminal.
Online entitlement parameter
Parameter
Importance
Description
--env FTOPTIX_ENTITLEMENT_SERIAL_NUMBER=
entitlement_serial_number
Required
Passes the entitlement serial number to the container when you start the container. Use this environment variable for online entitlement validation.
Offline entitlement parameter
Parameter
Importance
Description
--env
license_environment_variable
=
offline_entitlement_value
Required
Pass the offline entitlement value as an environment variable when you start the container. Use the offline entitlement value for the offline entitlement activated on the host.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal