Quick Start

Get the Project

Make sure you have docker installed on your machine.

CLI

1. Cloning the waltid-identity

git clone https://github.com/walt-id/waltid-identity.git

Launch the Wallet

A docker-compose configuration is provided as a convenience for quick-start. It sets up and starts all modules required to fully benefit from the wallet's functions. The runtime configuration files should be available in the same folder as the docker-compose file. There are sample configuration files provided, except walt.yaml which should be updated with the corresponding API keys.

If the web-wallet fails to render, make sure the hosts file contains the correct hostname. Check the troubleshooting for more details.

Docker

1. Change working directory

cd docker-compose

1. Start services

docker-compose up

Modules

The following modules were enabled, to make use of all the functionality offered by the web-wallet.

• Wallet-Kit - exposes an API used by the wallet to enable the management of VCs, DIDs and their related keys.

• NFT-Kit - used as a native dependency to enable the display of NFTs in the wallet.

• Issuer Portal - the web page with which the wallet interacts to receive credentials.

• Verifier Portal - the web page with which the wallet interacts to do credential verification.

Runtime configurations

Find configuration options available for your wallet below. The docker-compose used a default setup for quick start.

Wallet-backend

• web.conf - host configuration

• storage configuration:

  • db.conf - database configuration

  • db.<database>.conf - datasource configuration

• wallet.conf - to enable credential, key and DID functions (wallet configuration)

• walt.yaml - to enable token display functions (NFTKit configuration)

Refer to the Configurations section for more details.

Wallet-frontend

When the wallet user starts an issuance flow from the wallet by clicking "request credential", the web-wallet needs to know the location where it should redirect the user to. This location is configured on the wallet-frontend side with the IssuerUrl environment variable.

Wallet Kit

Wallet Kit needs to be configured for the following modules:

• backend - refer to Wallet backend setup

• issuer portal - refer to Issuer portal setup

• verifier portal - refer to Verifier portal setup