QuickStart Guide
Installation and Deployments
Docker Installation
4 min
before you begin before you begin install https //docs docker com/get docker/ 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 to launch a litmus edge docker image execute 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\ latest where \ name le defines the container name you can change this to a name other than le \ cap add=net admin should not be changed as net admin is required p 8443 443 defines the port mapping you can change the value to a port other than 8443 you can map the internal 443 port to any other external port other than 8443 as desired p 4840 4222 is a port mapping example that opens port 4222 on your container and maps it to the external 4222 port 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 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 docid\ hqybg3t5t6irowc2rbbhf for more details on logging in