Skip to content

Commit 45784dd

Browse files
pmbittneribbem
authored andcommitted
docker setup instructions on windows
1 parent 29f45c8 commit 45784dd

1 file changed

Lines changed: 25 additions & 6 deletions

File tree

INSTALL.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,25 +42,44 @@ Check the requirements needed for the Docker setup in the [REQUIREMENTS.md](REQU
4242

4343
More detailed instructions on starting the deamon are given [here](https://docs.docker.com/config/daemon/start/) on the docker website.
4444

45-
You can use the `docker.sh` script to build and execute the Demo using [Docker](https://www.docker.com/get-started) as described below.
45+
### Docker Setup on Windows
46+
47+
Open a terminal (preferably Windows PowerShell) and navigate to the repository's directory (the directory containing this `INSTALL.md`).
48+
Then, create the docker image
49+
```shell
50+
docker build -t diffdetective-demo .
51+
```
52+
You can verify that the image was created successfully by running
53+
```shell
54+
docker images
55+
```
56+
and checking that an image called `diffdetective-demo` is listed.
57+
You can run the image and thus the demo with the following command:
58+
```shell
59+
docker run --net=host -e DISPLAY=host.docker.internal:0 -t diffdetective-demo
60+
```
61+
You may get some font errors, which you can ignore (see Troubleshooting below).
62+
63+
64+
### Docker Setup on Linux
4665

47-
### Hints for Linux users
48-
The following hints apply for most Linux users:
4966
> You might require elevated privileges to execute Docker commands (e.g., `sudo ./docker.sh build` or adding the user to the `docker` or `wheel` group).
5067
> See Docker's [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/) for more information.
5168
5269
> It is best to install required software (e.g., Docker, Maven) using your distro's package manager if it is available.
5370
54-
### Setup
55-
Clone and navigate to this repository.
71+
You can use the `docker.sh` script to build and execute the Demo using [Docker](https://www.docker.com/get-started) as described below.
72+
73+
#### Setup
74+
Clone and navigate to this repository (the directory containing this `INSTALL.md`).
5675
Then, simply build the image using the provided script:
5776
```shell
5877
./docker.sh build
5978
```
6079

6180
This will automatically build the Docker container using Nix if Nix is installed on your system.
6281

63-
### Execution
82+
#### Execution
6483
Once the image has been build, you can start the demo with
6584
```shell
6685
./docker.sh demo

0 commit comments

Comments
 (0)