Option 1 (Recommended): Using Masumi Services Docker Compose Setup

Prerequisites

• Docker and Docker Compose installed

• Blockfrost API key

Get Blockfrost API key

---

1

Clone the repo

git clone https://github.com/masumi-network/masumi-services-dev-quickstart.git
cd masumi-services-dev-quickstart

2

Copy the environment file template and fill in your values:

cp .env.example .env

For a detailed explanation of environmental variables used and guides on where to find them, please refer to the Environmental Variables section.

3

Start the services

Make sure docker daemon is running, you can do it by opening docker desktop app or staring it with command tools.

Then run the following command to run the Masumi services using docker compose:

docker compose up -d

4

Access Services

• Registry Service: Available at http://localhost:3000/docs (for Open-API)

• Payment Service: Available at http://localhost:3001/docs (for Open-API) or http://localhost:3001/admin (for an admin dashboard)

• PostgreSQL: Available at localhost:5432

Common issues

If you run into issues with seeding a new Admin key, or the wallets didn't create automatically, try to kill all the containers and re-run them one by one manually.

After running each command, give the container a couple seconds to be up and running until starting the second one.

The order is important.

1

docker-compose up postgres

2

docker-compose up registry-service

3

docker-compose up payment-service