Skip to content

Commit

Permalink
update docker-compose readme
Browse files Browse the repository at this point in the history
  • Loading branch information
taminobaumann authored Dec 21, 2023
1 parent 0f2a21b commit 7fe79a1
Showing 1 changed file with 26 additions and 47 deletions.
73 changes: 26 additions & 47 deletions docker-compose/readme.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,44 @@
# Web-wallet package
# walt.id Identity Package

This package is a docker compose configuration that starts all the services required to
run a complete credential flow:
- issue - using issuer-portal
- store - using web-wallet
- verify - using verifier-portal
This package is a docker compose configuration that starts all the services and apps of the identity repo

## Services
## Executing The Package

The complete list of services and their port mapping is as follows:
- web-wallet-frontend: `3000`
- web-wallet-backend: `4545` (not published)
- web-portal: `4000`
- vc-repo: `5000`
- issuer: `8000`
- verifier: `9000`
```bash
docker compose up
```

## Configurations
## Services Exposed
port mapping below

Config locations:
- Issuer API: `8000`
- Verifier API: `9000`
- Wallet API: `4545`

- web-wallet: `wallet-backend/config`
- issuer: `issuer/config`
- verifier: `verifier/config`
- ingress: `ingress.conf`
- environment: `.env`
## Apps
port mapping below

## Examples
- Web Wallet: `3000`
- Web Portal: `4000`
- VC Repo: `5000`

### Issue VerifiableId credential

1. go to issuer-portal (http://localhost:8000)
2. select _Verifiable ID document_
3. click '_Start issuance_'
4. on the popup, click '_walt.id web wallet_'
1. redirect to web-wallet
2. sign in to web-wallet
5. on the '_Receive single credential_' page, click '_Accept_'
1. redirect to credentials list page
## Configurations

### Verify VerifiableId credential
Config locations:

1. go to verifier-portal (http://localhost:9000)
2. click '_Connect Wallet using Verifiable ID_'
3. redirect to web-wallet
1. sign in to web-wallet
4. on the '_Present_' page, click '_Accept_'
1. redirect to verification result
- wallet API: `wallet-backend`
- issuer API: `issuer-api/config`
- verifier API: `verifier-api/config`
- ingress: `ingress.conf`
- environment: `.env`

## Troubleshooting

---
#### Display of VC verification result on success page of portal doesn't work

#### Redirect to web-wallet doesn't work (http://host.docker.internal:3000)

Make sure the hostname mapping is available in the hosts file:
- Linux: `/etc/hosts`
- MacOS: `/private/etc/hosts`
- Windows: `C:\Windows\System32\drivers\etc\hosts`

It should contain a record similar to `127.0.0.1 host.docker.internal`.
We are working on fixing this issue.

---

Expand All @@ -73,4 +52,4 @@ Make sure the ports are also updated in:
- wallet-config.json
- wallet-backend/config
- wallet.conf
- web.conf
- web.conf

0 comments on commit 7fe79a1

Please sign in to comment.