walt.id Enterprise Stack Quickstart

by walt.id

Quickstart to get you up and running with the walt.id Enterprise Stack

This repository contains the quickstart CLI and docker-compose files to get you up and running with the walt.id Enterprise Stack for local development. It also contains useful resources to help you with the Enterprise Stack such as configuration files, migration scripts, deployment files and more.

Get Started

Bring up the whole stack using docker-compose and explore the enterprise features via our CLI tool.

⚠️ Please note: You need to be an Enterprise Stack customer & have access to the private enterprise stack images, to use this quickstart.

1. Docker-Compose: Run The Enterprise Stack

Use docker-compose to bring up the Enterprise Stack API, UI and a MongoDB database (storage of the Enterprise Stack).

You can update the version of the enterprise stack via the .env file.

Use docker-compose

Clone the repo

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

Change Working Directory

cd waltid-enterprise-quickstart

Run The Stack

docker compose pull 
docker compose up

In case you want to only run the API, run:

docker compose -f docker-compose-api.yml up

Once the docker-compose is running, you can visit enterprise.localhost/swagger to access the Enterprise Stack APIs.

The UI is running at http://enterprise.localhost/login

Using custom organisation names

The caddy setup is configured only for the "waltid" organisation. If you want to use a custom organisation name, you can update the Caddyfile to add your own organisation domains.

  caddy:
    image: caddy:2-alpine
    container_name: caddy
    restart: unless-stopped
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - ./Caddyfile:/etc/caddy/Caddyfile
    networks:
      mongodb_network:
        aliases:
          - enterprise.localhost
          - waltid.enterprise.localhost
          # add your own organisation domains here
    depends_on:
      - waltid-enterprise
      - waltid-enterprise-ui

2. Enterprise CLI

A TypeScript CLI tool for setting up and testing the walt.id Enterprise Stack.

# Clone the repo
git clone https://github.com/walt-id/waltid-enterprise-quickstart.git
cd waltid-enterprise-quickstart

# Install dependencies
cd cli
npm install

# Run full setup + primary use case (mDL issuance & verification)
npx tsx walt.ts --recreate

# Subsequence calls don't need to recreate the DB:
npx tsx walt.ts

Common Commands

Command	Description
npx tsx walt.ts	Full setup + primary use case (default)
npx tsx walt.ts --recreate	Recreate database and run full setup
npx tsx walt.ts --setup-all	Run all setup commands
npx tsx walt.ts --run-all	Run primary use case only
npx tsx walt.ts --help	Show all available commands

Configuration

Superadmin credentials are read from config/superadmin-registration.conf.

For detailed documentation, see cli/README.md.

Next Steps

Visit our docs to learn more about features and configurations of the enterprise stack.

Interested to see what releases are available? Checkout our changelogs to see the latest releases and pre-releases of the Enterprise Stack.

Need Support? As an Enterprise customer you should also have a support contract with us. Please raise any issues via the , or reach out to the team over email if you need to be given access.

Join the community

• Connect and get the latest updates: Discord | Newsletter | YouTube | LinkedIn
• Get help, request features and report bugs: Support Portal
• Find more indepth documentation on our docs site

License

Licensed under our Enterprise License.