Skip to content

Commit 1d32e0b

Browse files
committed
chore: updated readme to mention the vault service
1 parent 8b09895 commit 1d32e0b

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

docker-compose/README.md

+38
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,51 @@ above command again.
1616
docker-compose down
1717
```
1818

19+
### Starting services selectively
20+
21+
It is possible to start services selectively, including their dependencies.
22+
23+
#### Start the demo wallet and all dependant services
24+
25+
```console
26+
docker compose up waltid-demo-wallet
27+
```
28+
29+
will start automatically:
30+
- caddy
31+
- postgres
32+
- wallet-api
33+
- and waltid-web-wallet
34+
35+
#### Start services using compose profiles
36+
37+
`COMPOSE_PROFILES` environment variable located in the .env file allows the selection of
38+
profiles to start the services for. Currently, the services are available with 2 profiles:
39+
40+
- identity - for the waltid-identity services
41+
- tse - for the Hashicorp<sup>1</sup> vault services
42+
43+
Profiles can be combined, e.g. `COMPOSE_PROFILES=identity,tse` - will start the
44+
waltid-identity services and the vault (also can be done with the `all` profile).
45+
46+
47+
<sup>1</sup> - a hashicorp vault service that will be initialized with:
48+
49+
- a transit secrets engine
50+
- authentication methods
51+
- approle - for my-role, where role-id and secret-id will be output in the console
52+
- userpass - for myuser with mypassword
53+
- access-token - with dev-only-token
54+
55+
1956
## Port mapping
2057

2158
### Services
2259

2360
- Wallet API: [http://localhost:7001](http://localhost:7001)
2461
- Issuer API: [http://localhost:7002](http://localhost:7002)
2562
- Verifier API: [http://localhost:7003](http://localhost:7003)
63+
- Hashicorp vault: [http://localhost:8200](http://localhost:8200)
2664

2765
### Apps
2866

docker-compose/vault/init.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ echo "Enable Userpass Authentication"
2121
vault auth enable userpass
2222

2323
echo "Create a User with Userpass Authentication"
24-
vault write auth/userpass/users/my-user password=my-password policies=transit-policy
24+
vault write auth/userpass/users/myuser password=mypassword policies=transit-policy
2525

2626
echo "Enable AppRole Authentication"
2727
vault auth enable approle

0 commit comments

Comments
 (0)