--- title: "Welcome to Core Lightning Documentation Portal" slug: "home" excerpt: "Here you can find everything you need to jump-start your journey to running and building on Core Lightning." hidden: false createdAt: "2023-01-30T15:53:40.926Z" updatedAt: "2023-02-13T15:43:05.463Z" --- > 📘 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](https://t.me/lightningd)**. *** [block:html] { "html": "
\n \t

\n

\n

Getting Started

\n
\n \n \n \n \n \n

Installation

\n

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

\n
\n \n \n \n \n

Configure your node

\n

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

\n
\n \n \n \n \n

Upgrade your node

\n

Upgrade to the latest stable releases without interruption.

\n
\n \n \n \n \n

Beginner's guide

\n

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

\n
\n
\n

For Node Operators

\n
\n \n \n \n \n \n

Analytics

\n

Analyse your node data for effective node management.

\n
\n \n \n \n \n

Plugins

\n

Leverage a plethora of plugins on Core Lightning.

\n
\n \n \n \n \n

Troubleshooting & FAQ

\n

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

\n
\n
\n

For Developers

\n
\n \n \n \n \n

Setting up a dev environment

\n

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

\n
\n \n \n \n \n

App Development

\n

Build a lightning app using Core Lightning APIs.

\n
\n \n \n \n \n

Plugin Development

\n

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

\n
\n \n \n \n \n

Recipes

\n

Explore working recipes for common use cases.

\n
\n \n \n \n \n

API Reference

\n

View all API methods, attributes and responses.

\n
\n
\n

For Contributors

\n
\n \n \n \n \n

CLN Architecture

\n

Familiarise yourself with the core components of Core Lightning.

\n
\n \n \n \n \n

Contributor Workflow

\n

Learn the practical process and guidelines for contributing.

\n
\n \n \n \n \n

Testing

\n

Understand the testing and code review practices.

\n
\n \n \n \n \n

Security policy

\n

Learn how to responsibly report a security issue.

\n
\n
\n
" } [/block]