Skip to content

Commit ac38c28

Browse files
ShahanaFarooquiShahanaFarooqui
committed
docs: Updated getting-started docs for v10
1 parent a3bb162 commit ac38c28

File tree

10 files changed

+65
-62
lines changed

10 files changed

+65
-62
lines changed

‎doc/getting-started/advanced-setup.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: "Advanced setup"
3-
slug: "advanced-setup"
4-
hidden: false
5-
createdAt: "2023-01-25T10:54:00.674Z"
6-
updatedAt: "2023-01-25T10:55:28.187Z"
2+
title: Advanced setup
3+
slug: advanced-setup
4+
privacy:
5+
view: public
76
---
7+

‎doc/getting-started/advanced-setup/bitcoin-core.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "Bitcoin Core"
3-
slug: "bitcoin-core"
4-
hidden: false
5-
createdAt: "2023-01-31T13:24:19.300Z"
6-
updatedAt: "2023-02-21T13:30:53.906Z"
2+
title: Bitcoin Core
3+
slug: bitcoin-core
4+
privacy:
5+
view: public
76
---
87
# Using a pruned Bitcoin Core node
98

‎doc/getting-started/advanced-setup/repro.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "Reproducible builds"
3-
slug: "repro"
4-
hidden: false
5-
createdAt: "2023-01-25T10:37:03.476Z"
6-
updatedAt: "2023-07-12T13:26:52.005Z"
2+
title: Reproducible builds
3+
slug: repro
4+
privacy:
5+
view: public
76
---
87
[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.
98

@@ -214,4 +213,4 @@ Notice that the two files we downloaded are marked as `OK`, but we're missing on
214213
sha256sum: WARNING: 1 computed checksum did NOT match
215214
```
216215

217-
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! 🎉🥳
216+
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! 🎉🥳

‎doc/getting-started/advanced-setup/tor.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "Using Tor"
3-
slug: "tor"
4-
hidden: false
5-
createdAt: "2023-01-25T10:55:50.059Z"
6-
updatedAt: "2023-02-21T13:30:33.294Z"
2+
title: Using Tor
3+
slug: tor
4+
privacy:
5+
view: public
76
---
87
To use any Tor features with Core Lightning you must have Tor installed and running.
98

@@ -396,4 +395,4 @@ always-use-proxy=true
396395
- [The Tor project](https://www.torproject.org/)
397396
- [Tor FAQ](https://www.torproject.org/docs/faq.html.en#WhatIsTor)
398397
- [Tor Hidden Service](https://www.torproject.org/docs/onion-services.html.en)
399-
- [.onion addresses version 3](https://blog.torproject.org/we-want-you-test-next-gen-onion-services)
398+
- [.onion addresses version 3](https://blog.torproject.org/we-want-you-test-next-gen-onion-services)

‎doc/getting-started/getting-started.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
2-
title: "Set up your node"
3-
slug: "getting-started"
4-
excerpt: "This guide will help you set up a Core Lightning node. You'll be up and running in a jiffy!"
5-
hidden: false
6-
createdAt: "2022-11-07T15:26:37.081Z"
7-
updatedAt: "2023-02-22T06:00:15.160Z"
2+
title: Set up your node
3+
slug: getting-started
4+
content:
5+
excerpt: >-
6+
This guide will help you set up a Core Lightning node. You'll be up and
7+
running in a jiffy!
8+
privacy:
9+
view: public
810
---
911
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.
1012

@@ -30,4 +32,4 @@ The following steps will get you up and running with Core Lightning:
3032

3133
## 3. [Configure your node](doc:configuration) as per your requirements (_optional_)
3234

33-
## 4. **[Run your node](doc:beginners-guide)**
35+
## 4. **[Run your node](doc:beginners-guide)**

‎doc/getting-started/getting-started/configuration.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "Configuring your node"
3-
slug: "configuration"
4-
excerpt: "Choose from a variety of configuration options as per your needs."
5-
hidden: false
6-
createdAt: "2022-11-18T14:32:13.821Z"
7-
updatedAt: "2023-02-21T13:26:18.280Z"
2+
title: Configuring your node
3+
slug: configuration
4+
content:
5+
excerpt: Choose from a variety of configuration options as per your needs.
6+
privacy:
7+
view: public
88
---
99
`lightningd` can be configured either by passing options via the command line, or via a configuration file.
1010

‎doc/getting-started/getting-started/hardware-considerations.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
2-
title: "Hardware considerations"
3-
slug: "hardware-considerations"
4-
excerpt: "A lightning node requires reasonable amount of memory and storage. Learn what's suitable for your scenario."
5-
hidden: true
6-
createdAt: "2022-11-18T14:31:38.695Z"
7-
updatedAt: "2023-04-01T00:09:20.148Z"
2+
title: Hardware considerations
3+
slug: hardware-considerations
4+
content:
5+
excerpt: >-
6+
A lightning node requires reasonable amount of memory and storage.
7+
Learn what's suitable for your scenario.
8+
privacy:
9+
view: anyone_with_link
810
---
911
# Hobbyist
1012

@@ -40,4 +42,4 @@ A checksumming filesystem, such as BTRFS or ZFS, compliments ECC memory by compu
4042

4143
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
4244

43-
# Commercial Grade(?)
45+
# Commercial Grade(?)

‎doc/getting-started/getting-started/installation.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: "Installation"
3-
slug: "installation"
4-
excerpt: "Core lightning is available on many platforms and environments. Learn how to install on your preferred platform."
5-
hidden: false
6-
createdAt: "2022-11-18T14:32:02.251Z"
7-
updatedAt: "2023-07-13T05:08:44.966Z"
2+
title: Installation
3+
slug: installation
4+
content:
5+
excerpt: >-
6+
Core lightning is available on many platforms and environments. Learn how to install on your preferred platform.
7+
privacy:
8+
view: public
89
---
910
# Binaries
1011

‎doc/getting-started/home.md‎

Lines changed: 8 additions & 7 deletions
Large diffs are not rendered by default.

‎doc/getting-started/upgrade.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: "Upgrade"
3-
slug: "upgrade"
4-
excerpt: "Upgrade to the latest stable releases without interruption."
5-
hidden: false
6-
createdAt: "2022-11-18T14:32:58.821Z"
7-
updatedAt: "2023-01-25T10:54:43.810Z"
2+
title: Upgrade
3+
slug: upgrade
4+
content:
5+
excerpt: Upgrade to the latest stable releases without interruption.
6+
privacy:
7+
view: public
88
---
99
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.
1010

1111
> 🚧
1212
>
1313
> 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.
1414
>
15-
> 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!)
15+
> 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!)

0 commit comments

Comments
 (0)