Skip to content

Commit 5fa8b0a

Browse files
author
Maikel Maas
committed
VDX-308 Added WSL2 configuration to documentation
1 parent f87b8f4 commit 5fa8b0a

1 file changed

Lines changed: 39 additions & 3 deletions

File tree

README.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,27 @@ introduction on how credential branding actually works.
7272
- [Setting up VCI frontend](./documents/vci-front-end.md)
7373
- [Credential Branding](./documents/credential-branding.md)
7474

75-
### Docker
75+
### Docker
76+
77+
### Windows 10 (WSL2) - Clone repository
78+
79+
- Make sure to have an installation of Docker Desktop with the default options (recommended WSL2);
80+
- Clone the repository:
81+
```shell
82+
# to not mess up the LF -> CRLF in the bash script
83+
git config --global core.autocrlf false
84+
git clone git@github.com:Sphereon-Opensource/OID4VC-demo.git
85+
```
86+
87+
### Ubuntu 23.10 - Clone repository
88+
89+
- Make sure to have a default Docker installation;
90+
- Clone the repository:
91+
```shell
92+
git clone git@github.com:Sphereon-Opensource/OID4VC-demo.git
93+
```
94+
95+
### Ubuntu 23.10 and Windows 10 (WSL2) - Install the configuration files
7696

7797
We maintain Docker a setup for building and testing in directory `docker/compose/build`.
7898
We have created a script to install and patch the agent configurations for you required to build and run the Docker
@@ -107,6 +127,24 @@ All ecosystems present in packages/agent/conf/demos can be installed using the i
107127

108128
To build and run the Docker containers, execute the following commands from within the respective directory:
109129

130+
### Windows 10 - Build the image and run the container
131+
132+
- DOS shell:
133+
```cmd
134+
cd .\OID4VC-demo\docker\compose\build
135+
docker compose build
136+
enter: (adjust path and IP)
137+
docker run --name ubuntu-temp --rm -v C:/Users/Sphereon/_dev/ssi/OID4VC-demo:/OID4VC-demo -w /OID4VC-demo/docker/compose/build ubuntu /bin/bash -c "apt update && apt install -y jq && ./install-configs.sh 'sphereon' 'http://192.168.1.215:5000'"
138+
docker compose up -d
139+
```
140+
141+
- make sure you do unmount the config & env files before running the install-configs.sh again
142+
```shell
143+
docker compose down
144+
```
145+
146+
### Ubuntu 23.10 - Build the image and run the container
147+
110148
```bash
111149
docker compose build # This builds the Docker images
112150
docker compose up -d # This starts the Docker containers, this will require the .env & config files to be installed
@@ -131,5 +169,3 @@ docker build -f ./docker/Dockerfile -t oid4vc-demo-ssi-agent:latest --build-arg=
131169
docker build -f ./docker/Dockerfile -t oid4vci-demo-frontend:latest --build-arg="PACKAGE_PATH=packages/oid4vci-demo-frontend" --build-arg="NODE_SCRIPT=start:prod" .
132170
docker build -f ./docker/Dockerfile -t oid4vp-demo-frontend:latest --build-arg="PACKAGE_PATH=packages/oid4vp-demo-frontend" --build-arg="NODE_SCRIPT=start:prod" .
133171
```
134-
135-

0 commit comments

Comments
 (0)