Skip to main content
This guide explains how to host your own RGB Lightning Node for use with KaleidoSwap. Self-hosting gives you full control over your node and can be a great option for users familiar with running servers.

Overview

The RGB Lightning Node (RLN) is a specialized Lightning Network node that supports RGB assets on the Lightning Network. It allows you to:
  • Create payment channels containing RGB assets
  • Route RGB asset-denominated payments across multiple channels
  • Transfer RGB assets with the same user experience and security as regular Bitcoin Lightning payments

Hosting Methods Comparison

There are several ways to host an RGB Lightning Node, each with their own advantages and requirements: Choose the method that best aligns with your technical skills and requirements:
  • Docker-based installation: Best for most users - provides an easy setup with the option to run full infrastructure or just the node.
  • Direct installation on a VPS: Best for advanced users who need complete control over the system configuration.
  • Hosted solution (ThunderStack): Best for users who want a professionally managed solution with minimal technical overhead.

Network Options

Regardless of your hosting method, you can run your node on different Bitcoin networks: With our Docker solution, you can easily run your own Bitcoin Core and Electrs instances for any of these networks, giving you complete control over your stack.

Trust Considerations

The infrastructure components you choose to run yourself vs. connect to externally impacts the level of trust required:
  • Zero-Trust Setup: Run your own Bitcoin Core, Electrs, RGB Proxy, and RGB Lightning Node
  • Minimal Trust Setup: Run only the RGB Lightning Node and connect to hosted instances for other services

Option 1: Docker-Based Installation

Our Docker solution provides the easiest way to run an RGB Lightning Node. You can run the complete stack or just the node component.

Prerequisites

  • Docker and Docker Compose installed
  • At least 4GB RAM and 50GB storage
  • Basic knowledge of terminal commands

Quick Start with Makefile

The easiest way to get started is using the included Makefile:
  1. Clone the repository:
  1. Choose how you want to run the stack:
Have a look at the README.md file for more information on the different commands and options.

Option 2: Direct Installation on a VPS

For advanced users who prefer complete control over their server environment, you can install the RGB Lightning Node directly on a VPS or bare-metal server.

Prerequisites

  • A VPS or server running Linux (Ubuntu/Debian recommended)
  • Rust development environment
  • Properly configured firewall (opening ports 3001 for API and 9735 for Lightning)
  • Sufficient storage for blockchain data

Installation

  1. Clone the repository:
  1. Install the binary:
  1. Start the node:
Replace:
  • <data-dir> with your chosen data directory
  • <network> with regtest, testnet, or signet (for Mutinynet)
  1. When unlocking the node, you’ll need to provide:
  • Bitcoin RPC connection details
  • Indexer URL
  • RGB proxy endpoint

VPS Firewall Configuration

When running on a VPS, you’ll need to configure the firewall to allow necessary connections

Running as a System Service

For a production setup, create a systemd service:
Add the following content:
Enable and start the service:

Option 3: Hosted Provider (ThunderStack)

If you prefer a professionally managed solution without the technical overhead of self-hosting, ThunderStack offers cloud-based RGB Lightning Node hosting.

What is ThunderStack?

ThunderStack is a cloud-based solution designed to provide seamless node management for RGB and Lightning applications. It ensures high availability, enhanced security, and ease of management without the technical overhead of self-hosting.

Key Features

  • 24/7 Availability: Always-on infrastructure ensures uninterrupted operations
  • No Maintenance: Leave the operational complexities of node management to ThunderStack
  • Scalability: Add or remove nodes on demand as your needs evolve
  • Security: Advanced security protocols like mTLS and Cognito for access control
  • Integration Ready: Supports APIs, webhooks, and SDKs for easy integration

ThunderStack vs. Self-Hosting

Choose ThunderStack if you prioritize convenience, reliability, and professional support. Choose self-hosting if you prioritize complete control, customization, and minimal third-party trust.

Network Environments

Connection Details for Different Networks

Regtest Environment

For regtest testing, you can use these connection details:

Testnet Environment

For testnet3 testing, you can use:

Signet (Mutinynet) Environment

For signet testing, you can use:

Mutinynet: A Custom Bitcoin Signet for Testing

Mutinynet is a custom Bitcoin Signet network designed specifically for testing Lightning Network applications. It offers:
  • Extremely fast block times (30 seconds per block vs. 10 minutes on mainnet)
  • Stable testnet environment without competition for block space
  • Pre-configured for compatibility with RGB Lightning Nodes
  • Ideal for testing RGB assets on Lightning
Mutinynet Resources:

Node Operation

Once your node is running, it can be operated via REST APIs.

API Overview

The node exposes a comprehensive API for managing your node:
  • Channel management: open/close channels, connect/disconnect peers
  • Asset operations: issue, send, and manage RGB assets
  • Payment handling: create/pay invoices, keysend, etc.
  • Node information and control
For detailed API documentation, see the OpenAPI specification.

Basic Operations

Here are some common operations:

Get a Bitcoin Address

Get Node Information

Check Bitcoin Balance

Hardware Requirements

For optimal performance:

Security Considerations

When hosting your own node:
  1. Firewall Configuration: Only expose necessary ports (3001 for API, 9735 for LN peers)
  2. Authentication: Use strong passwords and consider adding API authentication
  3. Backups: Regularly backup your node’s data directory
  4. Updates: Keep all components updated to patch security vulnerabilities

Download the Desktop App

Get the latest KaleidoSwap Desktop App release for macOS, Windows, or Linux.