From 4a6a667cc5454c2ff91316988783752e79b3ebe3 Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 12 Nov 2025 14:26:34 -0800 Subject: [PATCH] docs: Updated `getting-started` docs for v10 --- doc/getting-started/advanced-setup.md | 10 +++++----- .../advanced-setup/bitcoin-core.md | 9 ++++----- doc/getting-started/advanced-setup/repro.md | 11 +++++------ doc/getting-started/advanced-setup/tor.md | 11 +++++------ doc/getting-started/getting-started.md | 16 +++++++++------- .../getting-started/configuration.md | 12 ++++++------ .../getting-started/hardware-considerations.md | 16 +++++++++------- .../getting-started/installation.md | 13 +++++++------ doc/getting-started/home.md | 15 ++++++++------- doc/getting-started/upgrade.md | 14 +++++++------- 10 files changed, 65 insertions(+), 62 deletions(-) diff --git a/doc/getting-started/advanced-setup.md b/doc/getting-started/advanced-setup.md index ccd68aa1c..a811c5478 100644 --- a/doc/getting-started/advanced-setup.md +++ b/doc/getting-started/advanced-setup.md @@ -1,7 +1,7 @@ --- -title: "Advanced setup" -slug: "advanced-setup" -hidden: false -createdAt: "2023-01-25T10:54:00.674Z" -updatedAt: "2023-01-25T10:55:28.187Z" +title: Advanced setup +slug: advanced-setup +privacy: + view: public --- + diff --git a/doc/getting-started/advanced-setup/bitcoin-core.md b/doc/getting-started/advanced-setup/bitcoin-core.md index 657c4a27b..588b4258f 100644 --- a/doc/getting-started/advanced-setup/bitcoin-core.md +++ b/doc/getting-started/advanced-setup/bitcoin-core.md @@ -1,9 +1,8 @@ --- -title: "Bitcoin Core" -slug: "bitcoin-core" -hidden: false -createdAt: "2023-01-31T13:24:19.300Z" -updatedAt: "2023-02-21T13:30:53.906Z" +title: Bitcoin Core +slug: bitcoin-core +privacy: + view: public --- # Using a pruned Bitcoin Core node diff --git a/doc/getting-started/advanced-setup/repro.md b/doc/getting-started/advanced-setup/repro.md index fbf2f954c..971835ca3 100644 --- a/doc/getting-started/advanced-setup/repro.md +++ b/doc/getting-started/advanced-setup/repro.md @@ -1,9 +1,8 @@ --- -title: "Reproducible builds" -slug: "repro" -hidden: false -createdAt: "2023-01-25T10:37:03.476Z" -updatedAt: "2023-07-12T13:26:52.005Z" +title: Reproducible builds +slug: repro +privacy: + view: public --- [Reproducible builds](https://reproducible-builds.org/) close the final gap in the lifecycle of open-source projects by allowing anyone to verify that a given binary was produced by compiling publicly available source code. @@ -214,4 +213,4 @@ Notice that the two files we downloaded are marked as `OK`, but we're missing on sha256sum: WARNING: 1 computed checksum did NOT match ``` -If both the signature verification and the manifest checksum verification succeeded, then you have just successfully verified a reproducible build and, assuming you trust the maintainers, are good to install and use the binaries. Congratulations! 🎉🥳 \ No newline at end of file +If both the signature verification and the manifest checksum verification succeeded, then you have just successfully verified a reproducible build and, assuming you trust the maintainers, are good to install and use the binaries. Congratulations! 🎉🥳 diff --git a/doc/getting-started/advanced-setup/tor.md b/doc/getting-started/advanced-setup/tor.md index a4d8ef85b..65af41bef 100644 --- a/doc/getting-started/advanced-setup/tor.md +++ b/doc/getting-started/advanced-setup/tor.md @@ -1,9 +1,8 @@ --- -title: "Using Tor" -slug: "tor" -hidden: false -createdAt: "2023-01-25T10:55:50.059Z" -updatedAt: "2023-02-21T13:30:33.294Z" +title: Using Tor +slug: tor +privacy: + view: public --- To use any Tor features with Core Lightning you must have Tor installed and running. @@ -396,4 +395,4 @@ always-use-proxy=true - [The Tor project](https://www.torproject.org/) - [Tor FAQ](https://www.torproject.org/docs/faq.html.en#WhatIsTor) - [Tor Hidden Service](https://www.torproject.org/docs/onion-services.html.en) -- [.onion addresses version 3](https://blog.torproject.org/we-want-you-test-next-gen-onion-services) \ No newline at end of file +- [.onion addresses version 3](https://blog.torproject.org/we-want-you-test-next-gen-onion-services) diff --git a/doc/getting-started/getting-started.md b/doc/getting-started/getting-started.md index 0faa8f1bb..a886105a8 100644 --- a/doc/getting-started/getting-started.md +++ b/doc/getting-started/getting-started.md @@ -1,10 +1,12 @@ --- -title: "Set up your node" -slug: "getting-started" -excerpt: "This guide will help you set up a Core Lightning node. You'll be up and running in a jiffy!" -hidden: false -createdAt: "2022-11-07T15:26:37.081Z" -updatedAt: "2023-02-22T06:00:15.160Z" +title: Set up your node +slug: getting-started +content: + excerpt: >- + This guide will help you set up a Core Lightning node. You'll be up and + running in a jiffy! +privacy: + view: public --- The Core Lightning implementation has been in production use on the Bitcoin mainnet since early 2018, with the launch of the [Blockstream Store](https://blockstream.com/2018/01/16/en-lightning-charge/). We recommend getting started by experimenting on `testnet` (or `regtest`), but the implementation is considered stable and can be safely used on mainnet. @@ -30,4 +32,4 @@ The following steps will get you up and running with Core Lightning: ## 3. [Configure your node](doc:configuration) as per your requirements (_optional_) -## 4. **[Run your node](doc:beginners-guide)** \ No newline at end of file +## 4. **[Run your node](doc:beginners-guide)** diff --git a/doc/getting-started/getting-started/configuration.md b/doc/getting-started/getting-started/configuration.md index d527d9adb..a2420264d 100644 --- a/doc/getting-started/getting-started/configuration.md +++ b/doc/getting-started/getting-started/configuration.md @@ -1,10 +1,10 @@ --- -title: "Configuring your node" -slug: "configuration" -excerpt: "Choose from a variety of configuration options as per your needs." -hidden: false -createdAt: "2022-11-18T14:32:13.821Z" -updatedAt: "2023-02-21T13:26:18.280Z" +title: Configuring your node +slug: configuration +content: + excerpt: Choose from a variety of configuration options as per your needs. +privacy: + view: public --- `lightningd` can be configured either by passing options via the command line, or via a configuration file. diff --git a/doc/getting-started/getting-started/hardware-considerations.md b/doc/getting-started/getting-started/hardware-considerations.md index 0d32a7e0b..8805a5024 100644 --- a/doc/getting-started/getting-started/hardware-considerations.md +++ b/doc/getting-started/getting-started/hardware-considerations.md @@ -1,10 +1,12 @@ --- -title: "Hardware considerations" -slug: "hardware-considerations" -excerpt: "A lightning node requires reasonable amount of memory and storage. Learn what's suitable for your scenario." -hidden: true -createdAt: "2022-11-18T14:31:38.695Z" -updatedAt: "2023-04-01T00:09:20.148Z" +title: Hardware considerations +slug: hardware-considerations +content: + excerpt: >- + A lightning node requires reasonable amount of memory and storage. + Learn what's suitable for your scenario. +privacy: + view: anyone_with_link --- # Hobbyist @@ -40,4 +42,4 @@ A checksumming filesystem, such as BTRFS or ZFS, compliments ECC memory by compu Despite the data resiliency assurances we gain using ECC memory, storage mirroring, and filesystem-level checksumming, a Lightning node is still subject to other events such as fires or floods that could compromise the integrity of the node's data. Because of this, it's important to have offsite -# Commercial Grade(?) \ No newline at end of file +# Commercial Grade(?) diff --git a/doc/getting-started/getting-started/installation.md b/doc/getting-started/getting-started/installation.md index 59a19c57e..6bfa50e32 100644 --- a/doc/getting-started/getting-started/installation.md +++ b/doc/getting-started/getting-started/installation.md @@ -1,10 +1,11 @@ --- -title: "Installation" -slug: "installation" -excerpt: "Core lightning is available on many platforms and environments. Learn how to install on your preferred platform." -hidden: false -createdAt: "2022-11-18T14:32:02.251Z" -updatedAt: "2023-07-13T05:08:44.966Z" +title: Installation +slug: installation +content: + excerpt: >- + Core lightning is available on many platforms and environments. Learn how to install on your preferred platform. +privacy: + view: public --- # Binaries diff --git a/doc/getting-started/home.md b/doc/getting-started/home.md index 5e9c99f0a..d245c35a0 100644 --- a/doc/getting-started/home.md +++ b/doc/getting-started/home.md @@ -1,10 +1,11 @@ --- -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" +title: Welcome to Core Lightning Documentation Portal +slug: home +content: + excerpt: >- + Here you can find everything you need to jump-start your journey to running and building on Core Lightning. +privacy: + view: public --- > 📘 Help us improve! > @@ -18,4 +19,4 @@ updatedAt: "2023-02-13T15:43:05.463Z" { "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] \ No newline at end of file +[/block] diff --git a/doc/getting-started/upgrade.md b/doc/getting-started/upgrade.md index 098fac1fd..64dca983b 100644 --- a/doc/getting-started/upgrade.md +++ b/doc/getting-started/upgrade.md @@ -1,10 +1,10 @@ --- -title: "Upgrade" -slug: "upgrade" -excerpt: "Upgrade to the latest stable releases without interruption." -hidden: false -createdAt: "2022-11-18T14:32:58.821Z" -updatedAt: "2023-01-25T10:54:43.810Z" +title: Upgrade +slug: upgrade +content: + excerpt: Upgrade to the latest stable releases without interruption. +privacy: + view: public --- Upgrading your Core Lightning node is the same as installing it. So if you previously installed it using a release binary, download the latest binary in the same directory as before. If you previously built it from the source, fetch the latest source and build it again. @@ -12,4 +12,4 @@ Upgrading your Core Lightning node is the same as installing it. So if you previ > > Upgrades to Core Lightning often change the database: once this is done, downgrades are not generally possible. By default, Core Lightning will exit with an error rather than upgrade, unless this is an official released version. > -> If you really want to upgrade to a non-release version, you can set `database-upgrade=true` in your configuration file, or start `lightningd` with `--database-upgrade=true`(or set to false to never allow a non-reversible upgrade!) \ No newline at end of file +> If you really want to upgrade to a non-release version, you can set `database-upgrade=true` in your configuration file, or start `lightningd` with `--database-upgrade=true`(or set to false to never allow a non-reversible upgrade!)