mintlayer/api-web-server repository overview

⁠Mintlayer Docker Images

⁠Docker Compose Generator

To simplify the process of setting up these Docker images, Mintlayer provides a Docker Compose generator. You can access this tool at:

https://docs.mintlayer.org/docker-compose.html⁠

This generator allows you to:

1. Select the components you need
2. Configure network settings (testnet/mainnet)
3. Set custom passwords and ports
4. Generate a docker-compose.yml file tailored to your requirements

Using the generated Docker Compose file, you can easily spin up a complete Mintlayer environment with just a few commands.

Remember to review and modify any sensitive information (such as passwords) in the generated file before using it in a production environment.

Mintlayer provides several Docker images to run different components of its blockchain ecosystem. These images can be easily orchestrated using Docker Compose. Here's an overview of the main images:

⁠1. mintlayer/node-daemon

This image runs the Mintlayer node daemon, which is responsible for maintaining the blockchain network.

• Image: mintlayer/node-daemon:latest
• Purpose: Runs a full node on the Mintlayer network
• Key Features:
  • Configurable for testnet or mainnet
  • Exposes RPC and P2P ports
  • Customizable logging levels

⁠2. mintlayer/wallet-rpc-daemon

This image runs the Mintlayer wallet RPC daemon, which provides a remote procedure call interface for wallet operations.

• Image: mintlayer/wallet-rpc-daemon:latest
• Purpose: Provides RPC access to wallet functionality
• Key Features:
  • Connects to the node daemon
  • Exposes an RPC interface for wallet operations
  • Configurable authentication

⁠3. mintlayer/wallet-cli

This image provides a command-line interface for interacting with the Mintlayer wallet.

• Image: mintlayer/wallet-cli:latest
• Purpose: Allows users to manage their Mintlayer wallet via CLI
• Key Features:
  • Connects to the node daemon
  • Provides a full set of wallet management commands
  • Useful for scripting and automation

⁠4. mintlayer/api-blockchain-scanner-daemon

This image runs a daemon that scans the blockchain and populates a database for API use.

• Image: mintlayer/api-blockchain-scanner-daemon:latest
• Purpose: Scans the blockchain and stores data for API queries
• Key Features:
  • Connects to both the node daemon and a PostgreSQL database
  • Indexes blockchain data for efficient querying

⁠5. mintlayer/api-web-server

This image runs a web server that provides API access to the Mintlayer blockchain data.

• Image: mintlayer/api-web-server:latest
• Purpose: Serves blockchain data via a RESTful API
• Key Features:
  • Connects to the PostgreSQL database populated by the blockchain scanner
  • Provides a configurable web server for API access