Skip to content

Commit c059664

Browse files
Enhance README with Docker and Python setup instructions
Added detailed setup instructions for Docker and Python3, including steps for running the application on different operating systems.
1 parent e81063f commit c059664

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

docker-launcher/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,38 @@ chmod +x eSim-Launcher-Linux
5757
chmod +x eSim-Launcher-macOS
5858
./eSim-Launcher-macOS
5959
```
60+
### OR
61+
### Step 1: Get Docker
62+
63+
Download [Docker Desktop](https://www.docker.com/products/docker-desktop) and make sure it's running.
64+
65+
### Step 2: Get Python3
66+
67+
Download and install[Python3](https://www.python.org/downloads/).
68+
69+
### Step 3: Download the files
70+
71+
- Download ```Dockerfile```. Note that the ```Dockerfile``` should be without extension. If the ```Dockerfile``` downloads with extension rename the file and remove the extension.
72+
- Download ```run_esim_docker.py```.
73+
74+
### Step 3: Run it
75+
Make sure docker is already running in the background.
76+
**Windows:** Open terminal and run:
77+
```
78+
python3 run_esim_docker.py
79+
```
80+
81+
**Linux:** Open terminal and run:
82+
```bash
83+
chmod +x run_esim_docker.py
84+
python3 run_esim_docker.py
85+
```
86+
87+
**macOS:** Open terminal and run:
88+
```bash
89+
chmod +x run_esim_docker.py
90+
python3 run_esim_docker.py
91+
```
6092

6193
---
6294

@@ -77,6 +109,18 @@ The launcher offers two display modes:
77109

78110
Both modes work on all platforms - the launcher will guide you through any required setup.
79111

112+
Note for MAC to be run in X11 mode:
113+
-- Install XQuartz on the Mac if you haven't already. You can download it from the [XQuartz](https://www.xquartz.org/) website.
114+
-- Enable network connections in XQuartz: Go to XQuartz > Preferences > Security tab, and check "Allow connections from network clients".
115+
-- Restart XQuartz and then restart your Docker application after making changes to the security settings.
116+
-- Run xhost +localhost in your Mac's terminal before running the Docker container. This allows local connections to your X server. 
117+
Run the following command in a terminal:
118+
```
119+
xhost +localhost
120+
docker run --platform linux/amd64 -it --env="DISPLAY=host.docker.internal:0" -v /tmp/.X11-unix/:/tmp/.X11-unix/:rw esim:latest
121+
```
122+
123+
80124
---
81125

82126
## Command Line Usage

0 commit comments

Comments
 (0)