Local Development

To run the enterprise stack locally, you need Docker (v20.10.14) and a MongoDB database. Below, you find instructions on how to:

  1. use our quickstart repo to spin up the Enterprise API next to a local MongoDB database using docker-compose.
  2. run the Enterprise API without the local MongoDB. This setup can be useful if you want to connect to a custom MongoDB instance.

Quickstart

  1. Clone the enterprise quickstart repository
git clone https://github.com/walt-id/waltid-enterprise-quickstart.git
  1. Login to docker

$ docker login -u waltid

  1. At the password prompt, enter the personal access token you received from us.
  2. Start docker-compose
docker-compose up

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

Next Steps

  • Enterprise Stack Concepts - Learn more about the Enterprise Stack core concepts
  • Administration - Learn about organizations, tenants, and the details of authentication and access management.
  • Services - Explore various services (e.g., issuer, verifier) and their detailed usage.

Running Enterprise API (without MongoDB)

Pulling the Enterprise API Docker Image

  1. Login to docker

$ docker login -u waltid

  1. At the password prompt, enter the personal access token you received from us.
  2. Pull the image

docker pull waltid/waltid-enterprise-api:{version}

Running The Image

  1. Configuration Files

Please prepare all the configuration files required to start the enterprise stack in a folder called config . You can use the config folder in our waltid-enterprise-quickstart repo as a reference.

The folder should include the following files:

  • _features.conf
  • auth.conf
  • database.conf
  • enterprise.conf
  • superadmin-registration.conf
  • web.conf

You can learn more about each of them in the configuration section.

  1. Running the image

With the command below, we start the enterprise stack API, mount the folder with all the required configuration files into it, and make the API accessible via localhost:3000

docker run -p 3000:3000 -it -v $(pwd)/config: /config -t waltid/waltid-enterprise-api: 0.1.0
SetupAdministration