---
title: Docker Installation
slug: litmusedge-v2/quickstart-guide/installation-and-deployments/docker-installation
description: You can use Docker to install Litmus Edge. 
docTags: 
createdAt: 2022-03-30T21:24:33.000Z
---

You can use Docker to install Litmus Edge. 

:::hint{type="info"}
**Note**: You can't upgrade the Litmus Edge Docker version using a software update file (UPD). You can follow the Docker recommended approach for Docker image upgrade and volume management.
:::

# Before you begin 

- Install [Docker Engine 19.03+](https://docs.docker.com/get-docker/) on an Intel 64-bit machine that you have administrative permissions required for executing Docker commands.
- Ensure the Docker Engine is configured to run a Docker image with a root user.
- Contact your Litmus account representative to get access to the service account *.json* file. 

To use Docker to install Litmus Edge, you will need to do the following:

- Step 1: Launch a Litmus Edge Docker Image
- Step 2: Log in to Litmus Edge

# Step 1: Launch a Litmus Edge Docker Image

**To launch a Litmus Edge Docker image:**

1\. Download the service account *.json* file, which you obtained from your Litmus account representative. 
2\. Open a Command Prompt Terminal (CTRL+R) on the Intel 64-bit machine.
3\. Use the following Linux or Windows command to launch the Docker image: 

:::CodeblockTabs
```linux
cat <file_name>.json | docker login -u _json_key --password-stdin https://us-docker.pkg.dev
```

```windows
type <file_name>.json | docker login -u _json_key --password-stdin https://us-docker.pkg.dev
```
:::

The `<file_name>.json` parameter is the service account file from step 1.&#x20;

:::hint{type="info"}
**Example:** If the .json file is named abc123.json, execute: `cat abc123.json | docker login -u _json_key --password-stdin https://us-docker.pkg.dev`
:::

Refer to [Google's Setting Up Authentication: Service Account Key](https://cloud.google.com/artifact-registry/docs/docker/authentication#json-key) for more information.

:::hint{type="info"}
**Note:** If you specify CPU/RAM limits for the Docker container that's initialized from the Docker image, allocate at least 2-4 CPUs and 4-8 GB RAM. Then scale up as needed.
:::

4\. Execute the following command to initialize the Litmus Edge Docker container from the Docker image that you downloaded.

```linux
docker run --name LE -d --cap-add=NET_ADMIN -p 8443:443 -v vol1:/var us-docker.pkg.dev/litmus-sales-enablement/litmusedge/litmusedge-std-docker:latest
```

where:

- `--name LE` defines the container name. You can change this from a different name 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`. The internal `443` port can be mapped to any other external port other than 8443 as desired.
- `-v vol1:/var` command mounts all container data to a volume called `vol1`. You can name the volume to your preference.

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.

:::hint{type="info"}
**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.
:::

5\. From the Docker terminal window, it will display the IP address to access the Litmus Edge device through the Web UI. Enter the IP address into an internet browser URL bar to access the Litmus Edge device.

# Step 2: Log in to Litmus Edge

See [Access the Litmus Edge Web UI](docId\:Y_HKza2PmC4IRUk-EBOuK) for details on logging in.&#x20;