Documentation Portal
Documentation

Welcome to Core Lightning Documentation Portal

Here you can find everything you need to jump-start your journey to running and building on Core Lightning.

Suggest Edits

📘

Help us improve!

The Core Lightning documentation and API reference is a work-in-progress, feel free to suggest edits or send us your feedback by clicking on Suggest Edits at the top-right of every page (login required) or via Telegram.

Getting Started

Installation

Core lightning is available on many platforms and environments. Learn how to install on your preferred platform.

Configure your node

Choose from a variety of configuration options as per your needs.

Upgrade your node

Upgrade to the latest stable releases without interruption.

Beginner's guide

A guide to all the basics you need to get up and running immediately.

For Node Operators

Analytics

Analyse your node data for effective node management.

Plugins

Leverage a plethora of plugins on Core Lightning.

Troubleshooting & FAQ

Common issues and frequently asked questions on operating a CLN node.

For Developers

Setting up a dev environment

Get up and running in your local environment with essential tools and libraries in your preferred programming language.

App Development

Build a lightning app using Core Lightning APIs.

Plugin Development

Customise your Core Lightning node by leveraging its powerful modular architecture via plugins.

Recipes

Explore working recipes for common use cases.

API Reference

View all API methods, attributes and responses.

For Contributors

CLN Architecture

Familiarise yourself with the core components of Core Lightning.

Contributor Workflow

Learn the practical process and guidelines for contributing.

Testing

Understand the testing and code review practices.

Security policy

Learn how to responsibly report a security issue.

Updated 11 months ago