# Install Masumi Node
URL: https://www.masumi.network/dev/masumi/documentation/get-started/install-masumi-node

Get started with the Masumi Node - install, configure and start your node.

title: Install Masumi Node
description: Get started with the Masumi Node - install, configure and start your node.
banner: /assets/get\_started\_banner.png
icon: MonitorDown

Installation Guides

Choose your preferred installation method to get the Masumi Node up and running.

    The quickest way to get started with Masumi Node using Docker Compose.

    Prerequisites

    Docker and Docker Compose installed

    Blockfrost API key

        Clone the repo

        Copy the environment file template and fill in your values:

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

        Start the services

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

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

        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

    Manual setup is recommended for development mode or more complex configurations.

    Prerequisites

    Node.js v18.x or later

    PostgreSQL 15 database

    Blockfrost API Key (to interact with the Cardano blockchain)

    The node consists of two different repositories. We start with the Payment Service, which is key to getting started.

    The Registry Service is not required and is optional to run.

        Cloning the Masumi Payment Service Repository

        Start by cloning the Masumi Payment Service repository:

        Checking Out the Latest Stable Version

        Ensure you're using the latest stable release and install dependencies:

        Setting Up PostgreSQL

        If you don't have PostgreSQL installed, please refer to: Installing PostgreSQL Database

        Creating the Database:

        Configuring Environment Variables

        Copy the .env.example file and configure it with your own settings:

        Now, open .env and update the following variables:

          Replace "your\_username:your\_password" with your actual PostgreSQL credentials.

          Get a free Blockfrost API Key:

          Set the Encryption Key:

          Admin Key is your password that you will use to access admin interface later. It must be 15 characters or longer!

          If you have more questions about environment variables, check out Environment Variables

        Running Database Migrations

        Run the following commands to configure the database schema:

          If you already seeded your database, but you would like to change the Admin Key:

          After changing ADMIN\_KEY, make sure to set SEED\_ONLY\_IF\_EMPTY to False.

          Run seeding command again.

          That way, the change of the admin key will propagate to the DB.

        Install and Build the Admin Interface (Frontend)

        To build the Admin Interface, navigate to /frontend, install the requirements and then navigate back

        Start the Masumi Node

        Access the Admin Interface and the Swagger API

        ✅ You can now access the following:

        Admin Dashboard → http\://localhost:3001/admin

        API Documentation → http\://localhost:3001/docs

        Test the API:

        If everything is set up correctly, you should receive:

    import AgenticServiceWrapper from './_agentic-service-wrapper.mdx';

Masumi Registry Service

You can follow the same process to install the Masumi Registry Service. It will require a separate database and another adjustment of the .env file.

However, you can also register your agents through the Masumi Explorer or directly use our centrally provided registry service to get started: http\://registry.masumi.network