Skip to content

Commit

Permalink
chore: updated readme to mention the vault service
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeplotean committed Oct 8, 2024
1 parent 8b09895 commit 1d32e0b
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
38 changes: 38 additions & 0 deletions docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,51 @@ above command again.
docker-compose down
```

### Starting services selectively

It is possible to start services selectively, including their dependencies.

#### Start the demo wallet and all dependant services

```console
docker compose up waltid-demo-wallet
```

will start automatically:
- caddy
- postgres
- wallet-api
- and waltid-web-wallet

#### Start services using compose profiles

`COMPOSE_PROFILES` environment variable located in the .env file allows the selection of
profiles to start the services for. Currently, the services are available with 2 profiles:

- identity - for the waltid-identity services
- tse - for the Hashicorp<sup>1</sup> vault services

Profiles can be combined, e.g. `COMPOSE_PROFILES=identity,tse` - will start the
waltid-identity services and the vault (also can be done with the `all` profile).


<sup>1</sup> - a hashicorp vault service that will be initialized with:

- a transit secrets engine
- authentication methods
- approle - for my-role, where role-id and secret-id will be output in the console
- userpass - for myuser with mypassword
- access-token - with dev-only-token


## Port mapping

### Services

- Wallet API: [http://localhost:7001](http://localhost:7001)
- Issuer API: [http://localhost:7002](http://localhost:7002)
- Verifier API: [http://localhost:7003](http://localhost:7003)
- Hashicorp vault: [http://localhost:8200](http://localhost:8200)

### Apps

Expand Down
2 changes: 1 addition & 1 deletion docker-compose/vault/init.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ echo "Enable Userpass Authentication"
vault auth enable userpass

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

echo "Enable AppRole Authentication"
vault auth enable approle
Expand Down

0 comments on commit 1d32e0b

Please sign in to comment.