docs: Updated getting-started docs for v10

This commit is contained in:
ShahanaFarooqui
2025-11-12 14:26:34 -08:00
committed by Rusty Russell
parent 41e21d1d70
commit 4a6a667cc5
10 changed files with 65 additions and 62 deletions

View File

@@ -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
---

View File

@@ -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

View File

@@ -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! 🎉🥳
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! 🎉🥳

View File

@@ -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)
- [.onion addresses version 3](https://blog.torproject.org/we-want-you-test-next-gen-onion-services)

View File

@@ -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)**
## 4. **[Run your node](doc:beginners-guide)**

View File

@@ -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.

View File

@@ -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(?)
# Commercial Grade(?)

View File

@@ -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

File diff suppressed because one or more lines are too long

View File

@@ -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!)
> 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!)