Skip to content

Commit

Permalink
doc: readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
nitin-vavdiya committed May 29, 2024
1 parent 7d75be3 commit 456201d
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Managed Identity Wallets (MIW) service implements the Self-Sovereign-Identit

# Usage

See [INSTALL.md](INSTALL.md)
See [INSTALL.md](INSTALL.md)

# Developer Documentation

Expand Down Expand Up @@ -157,13 +157,13 @@ directory, but without ".dist" at the end.

Description of the env files:

- **env.local**: Set up everything to get ready for flow "local". You need to fill in the passwords.
- **env.local**: Set up everything to get ready for flow "local". You need to fill in the passwords.
- **env.docker**: Set up everything to get ready for flow "docker". You need to fill in the passwords.

> **IMPORTANT**: ssi-lib is resolving DID documents over the network. There are two endpoints that rely on this resolution:
> - Verifiable Credentials - Validation
> - Verifiable Presentations - Validation
>
>
> The following parameters are set in env.local or env.docker file per default:
> ENFORCE_HTTPS_IN_DID_RESOLUTION=false
> MIW_HOST_NAME=localhost
Expand Down Expand Up @@ -210,10 +210,11 @@ When you just run `task` without parameters, you will see all tasks available.

### pgAdmin

This local environment contains [pgAdmin](https://www.pgadmin.org/), which is also started (default: http://localhost:8888).
This local environment contains [pgAdmin](https://www.pgadmin.org/), which is also started (
default: http://localhost:8888).
The default login is:

```
```
user: pg@admin.com (you can change it in the env.* files)
password: the one you set for "POSTGRES_PASSWORD" in the env.* files
```
Expand Down Expand Up @@ -312,6 +313,8 @@ This process ensures that any issues with the database schema are resolved by re
| ENFORCE_HTTPS_IN_DID_RESOLUTION | Enforce https during web did resolution | true |
| CONTRACT_TEMPLATES_URL | Contract templates URL used in summary VC | https://public.catena-x.org/contracts/ |
| APP_LOG_LEVEL | Log level of application | INFO |
| AUTHORITY_SIGNING_SERVICE_TYPE | Base wallet signing type, Currency only LOCAL is supported | Local |
| LOCAL_SIGNING_KEY_STORAGE_TYPE | Key storage type, currently only DB is supported | DB |
| | | |

# Technical Debts and Known issue
Expand Down

0 comments on commit 456201d

Please sign in to comment.