Docker Installation
Before you begin
Before you begin:
- Install Docker Engine 19.03+ on a 64-bit machine with admin permissions for executing Docker commands. Ensure the Docker Engine is configured to run a Docker image with a root user.
- Ensure your Linux host kernel is version 6 or higher for full DeviceHub driver support.
- Allocate at least 2-4 CPUs and 4-8 GB RAM if you plan to specify CPU and RAM limits for the container that's initialized from the Docker image. Then scale up as needed.
Note: You can't upgrade the Litmus Edge Docker version using a software update file (UPD). Instead, follow the Docker recommended approach for Docker image upgrade and volume management.
Step 1: Launch a Litmus Edge Docker Image
Note: Some features are unavailable when running Litmus Edge in Docker due to container best practices and specific constraints of a containerized environment. For more information, see Litmus Edge Appliance and Docker Models Compared.
To launch a Litmus Edge Docker image:
- Run the following command to download and launch the Litmus Edge Docker container.
docker run --name LE -d --cap-add=NET_ADMIN -p 8443:443 -v data-volume:/var litmusedge.azurecr.io/litmusedge-std-docker:latestwhere:
- --name LE defines the container name. You can change this to a name other than LE.
- -p 8443:443 maps the container port 443 to host port 8443. You can change the host port to any value.
- -v data-volume:/var command mounts all container data to a volume called data-volume. You can name the volume to your preference.
- Optionally, expose ports for services that you run on Litmus Edge, such as port 4840 for an OPC UA server, port 4778 for an Ignition driver, and port 4222 for NATS integration. This example shows how to expose the ports.
docker run --name LE -d --cap-add=NET_ADMIN -p 8443:443 -p 4840:4840 -p 4778:4778 -p 4222:4222 -v data-volume:/var litmusedge.azurecr.io/litmusedge-std-docker:latest- Optionally, use the following command to mount external storage to the volume and enable efficient file transfer between the host system and Litmus Edge: -v /path/to/folder/in/host:/var/lib/customer/ftp-data
where:
- /path/to/folder/in/host specifies the path to the folder on your host machine.
- /var/lib/customer/ftp-data defines the mirrored folder location in Litmus Edge.
Note: The --sysctl net.ipv4.ping_group_range="0 2147483647" parameter is not always required. However, if you are using Utilities and ping encounters errors due to host system limitations, add this parameter before initiating the container.
Step 2: Log in to Litmus Edge
The Docker terminal window displays the IP address that you need to access the Litmus Edge device through the Web UI. Enter the IP address into your browser URL bar to access the device.
See Access the Litmus Edge Web UI for more details on logging in.