Running Project AirSim with Docker (Licensed)

This section explains how to run Project AirSim Enterprise using Docker and a valid license. The process is intentionally simple and requires no knowledge of the internal system architecture.

If the license is mounted correctly, the system will start and work automatically.

---

Requirements

Before starting, ensure the following:

• Docker is installed
• NVIDIA GPU drivers are installed and working
• You have received a valid license.jwt file from IAMAI

No additional configuration is required.

---

License Handling (Important)

Project AirSim expects the license file at a fixed location inside the container:

/home/airsim_user/licenses/license.jwt

You must not copy the license into the Docker image.

Instead, the license is provided at runtime by mounting it from the host filesystem.

---

Recommended Host Setup

Store your license file anywhere on the host machine. For example:

/home/user/projectairsim/license/license.jwt

Rules:

• The file name must be exactly license.jwt
• The file should not be modified
• Keep the license outside source repositories

---

Running the Container

Use the following command to start Project AirSim with the Web UI and simulation enabled.

docker run --rm -it \
  --gpus all \
  -e DISPLAY=$DISPLAY \
  -v /tmp/.X11-unix:/tmp/.X11-unix \
  -v /home/user/projectairsim/license/license.jwt:/home/airsim_user/licenses/license.jwt:ro \
  -p 8080:8080 \
  -p 41451:41451 \
  -p 8090:8090 \
  -p 4657:4657 \
  projectairsim-enterprise:latest \
  --web-server=true \
  --run-sim=true \
  --env=Blocks

If the license is valid and correctly mounted, the container will start without further input.

---

What Happens Automatically

At startup, the container performs the following steps:

1. Verifies that the license file exists at the expected path

2. Stops immediately if the license is missing or invalid

3. Copies the license internally to:

   • the Web UI backend
   • the selected Unreal Engine simulation package

4. Starts the simulation and the Web UI

No manual license management inside the container is required.

---

Accessing the Web UI

Once the container is running, open the Web UI in your browser:

http://localhost:8080

From the Web UI you can:

• create and edit scenes
• configure agents and sensors
• launch and monitor simulations

---

Common Errors and Fixes

License not found

[ERROR] License file not found at: /home/airsim_user/licenses/license.jwt

Cause: The license file was not mounted or the mount path is incorrect.

Fix: Verify the host path and ensure the filename is exactly license.jwt.

---

Invalid environment name

[ERROR] Package license directory not found

Cause: The value passed to --env does not match an installed simulation package.

Fix: Use a valid environment name, for example:

--env=Blocks

(Environment names are case-sensitive.)

---

Best Practices

• Always mount the license as read-only (:ro)
• Do not embed licenses into Docker images
• Use one license per running container
• Keep licenses stored securely on the host system

---

Summary

To run Project AirSim with Docker:

1. Obtain license.jwt
2. Mount it to /home/airsim_user/licenses/license.jwt
3. Run the container
4. Open the Web UI

That is all that is required.