Skip to main content
Version: v3.x

Installation and setup

Prerequisites​

Make sure you have the following tools installed on your system:

Getting Started​

Follow these steps to run the MACI Relayer service using Docker.

1. Clone the Repository​

First, clone the repository to your local machine.

git clone https://github.com/privacy-scaling-explorations/maci
cd maci

2. Configure Environment Variables​

The .env file contains sensitive configuration values that will be injected into the Docker containers at runtime. To set them up:

  1. Copy the .env.example file to .env.
cp .env.example .env
  1. Edit the .env file and configure the variables.

3. Build and Run the Docker Containers​

Now that your environment is set up, it's time to build and run the Docker containers.

Run the following command from the root directory of your project:

docker-compose up --build

This command does the following:

  • Builds the Docker images based on the Dockerfile and docker-compose.yml files.
  • Starts the service container (the MACI relayer application) and the mongodb container.

The MACI Relayer service will be available on port 3000 by default (you can modify this in the .env file).

4. Access the Service​

Once the containers are up and running, you can access the relayer service at:

http://localhost:3000

Additionally, the Swagger UI documentation for the Relayer service API can be accessed at:

http://localhost:3000/api

You can interact with the API through the Swagger interface, which provides a convenient way to test endpoints and view the API methods.

5. Check Logs​

To view the logs from the containers and troubleshoot any issues, run:

docker-compose logs

This will display logs from both the service (relayer) and mongodb containers.

6. Stop the Services​

To stop the containers and remove the containers (but keep the volumes), use the following command:

docker-compose down

This will stop and remove the containers but retain the volumes (like MongoDB data). To also remove the volumes, run:

docker-compose down --volumes

7. MongoDB Persistence​

MongoDB data is persisted using Docker volumes (mongodb-data). Even if you remove and recreate the MongoDB container, the data will persist.

This ensures that any data stored in the MongoDB database is not lost even if the container is restarted or removed.

If you'd like to remove the persisted data as well, you can remove the volume by running:

docker volume rm your-repo_mongodb-data

This will delete the volume, along with all the data stored in MongoDB.