From 5d907ca7190d3f07fb9f1b3bc56c4dff855f1200 Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 12 Nov 2025 14:28:23 -0800 Subject: [PATCH] docs: Updated `beginners-guide` docs for v10 --- .../backup-and-recovery/advanced-db-backup.md | 10 ++++++---- .../backup-and-recovery/hsm-secret.md | 10 ++++++---- .../backup-and-recovery/recovery.md | 10 ++++++---- doc/beginners-guide/backup.md | 12 ++++++------ doc/beginners-guide/beginners-guide.md | 12 ++++++------ doc/beginners-guide/opening-channels.md | 11 +++++------ .../sending-and-receiving-payments.md | 11 +++++------ doc/beginners-guide/watchtowers.md | 14 +++++++------- 8 files changed, 47 insertions(+), 43 deletions(-) diff --git a/doc/beginners-guide/backup-and-recovery/advanced-db-backup.md b/doc/beginners-guide/backup-and-recovery/advanced-db-backup.md index 900c62763..c8ee49ddd 100644 --- a/doc/beginners-guide/backup-and-recovery/advanced-db-backup.md +++ b/doc/beginners-guide/backup-and-recovery/advanced-db-backup.md @@ -1,8 +1,10 @@ --- -title: "Advanced DB Backup" -slug: "advanced-db-backup" -excerpt: "Learn the various DB backup techniques." -hidden: false +title: Advanced DB Backup +slug: advanced-db-backup +content: + excerpt: Learn the various DB backup techniques. +privacy: + view: public --- To recover in-channel funds, you need to use one or more of the backup strategies below. diff --git a/doc/beginners-guide/backup-and-recovery/hsm-secret.md b/doc/beginners-guide/backup-and-recovery/hsm-secret.md index 59be59611..e1fa3a02b 100644 --- a/doc/beginners-guide/backup-and-recovery/hsm-secret.md +++ b/doc/beginners-guide/backup-and-recovery/hsm-secret.md @@ -1,8 +1,10 @@ --- -title: "HSM Secret" -slug: "hsm-secret" -excerpt: "Learn about various cool HSM secret methods." -hidden: false +title: HSM Secret +slug: hsm-secret +content: + excerpt: Learn about various cool HSM secret methods. +privacy: + view: public --- diff --git a/doc/beginners-guide/backup-and-recovery/recovery.md b/doc/beginners-guide/backup-and-recovery/recovery.md index 5e8def0b0..34b55e7ba 100644 --- a/doc/beginners-guide/backup-and-recovery/recovery.md +++ b/doc/beginners-guide/backup-and-recovery/recovery.md @@ -1,8 +1,10 @@ --- -title: "Wallet recovery" -slug: "recovery" -excerpt: "Learn about various recovery methods." -hidden: false +title: Wallet recovery +slug: recovery +content: + excerpt: Learn about various recovery methods. +privacy: + view: public --- diff --git a/doc/beginners-guide/backup.md b/doc/beginners-guide/backup.md index a8413a96c..dc31df168 100644 --- a/doc/beginners-guide/backup.md +++ b/doc/beginners-guide/backup.md @@ -1,10 +1,10 @@ --- -title: "Backup your wallet" -slug: "backup" -excerpt: "Learn the various backup options available for your Core Lightning node." -hidden: false -createdAt: "2022-11-18T16:28:17.292Z" -updatedAt: "2023-04-22T12:51:49.775Z" +title: Backup your wallet +slug: backup +content: + excerpt: Learn the various backup options available for your Core Lightning node. +privacy: + view: public --- In Lightning, since _you_ are the only one storing all your financial information, you **_cannot_** recover this financial information from anywhere else.This means that on Lightning, **you have to** responsibly back up your financial information yourself, using various processes and automation. diff --git a/doc/beginners-guide/beginners-guide.md b/doc/beginners-guide/beginners-guide.md index cae17de7d..3aaff13a5 100644 --- a/doc/beginners-guide/beginners-guide.md +++ b/doc/beginners-guide/beginners-guide.md @@ -1,10 +1,10 @@ --- -title: "Running your node" -slug: "beginners-guide" -excerpt: "A guide to all the basics you need to get up and running immediately." -hidden: false -createdAt: "2022-11-18T14:27:50.098Z" -updatedAt: "2023-02-21T13:49:20.132Z" +title: Running your node +slug: beginners-guide +content: + excerpt: A guide to all the basics you need to get up and running immediately. +privacy: + view: public --- ## Starting `lightningd` diff --git a/doc/beginners-guide/opening-channels.md b/doc/beginners-guide/opening-channels.md index 8c7b87b36..2d7800a6a 100644 --- a/doc/beginners-guide/opening-channels.md +++ b/doc/beginners-guide/opening-channels.md @@ -1,9 +1,8 @@ --- -title: "Opening channels" -slug: "opening-channels" -hidden: false -createdAt: "2022-11-18T16:26:57.798Z" -updatedAt: "2023-01-31T15:07:08.196Z" +title: Opening channels +slug: opening-channels +privacy: + view: public --- First you need to transfer some funds to `lightningd` so that it can open a channel: @@ -47,4 +46,4 @@ This opens a connection and, on top of that connection, then opens a channel. The funding transaction needs 3 confirmations in order for the channel to be usable, and 6 to be announced for others to use. -You can check the status of the channel using `lightning-cli listpeers`, which after 3 confirmations (1 on testnet) should say that `state` is `CHANNELD_NORMAL`; after 6 confirmations you can use `lightning-cli listchannels` to verify that the `public` field is now `true`. \ No newline at end of file +You can check the status of the channel using `lightning-cli listpeers`, which after 3 confirmations (1 on testnet) should say that `state` is `CHANNELD_NORMAL`; after 6 confirmations you can use `lightning-cli listchannels` to verify that the `public` field is now `true`. diff --git a/doc/beginners-guide/sending-and-receiving-payments.md b/doc/beginners-guide/sending-and-receiving-payments.md index cbc757218..d354d05c7 100644 --- a/doc/beginners-guide/sending-and-receiving-payments.md +++ b/doc/beginners-guide/sending-and-receiving-payments.md @@ -1,9 +1,8 @@ --- -title: "Sending and receiving payments" -slug: "sending-and-receiving-payments" -hidden: false -createdAt: "2022-11-18T16:27:07.625Z" -updatedAt: "2023-01-31T15:06:02.214Z" +title: Sending and receiving payments +slug: sending-and-receiving-payments +privacy: + view: public --- Payments in Lightning are invoice based. @@ -21,4 +20,4 @@ The sender can feed this `bolt11` string to the `decodepay` command to see what lightning-cli pay ``` -Note that there are lower-level interfaces (and more options to these interfaces) for more sophisticated use. \ No newline at end of file +Note that there are lower-level interfaces (and more options to these interfaces) for more sophisticated use. diff --git a/doc/beginners-guide/watchtowers.md b/doc/beginners-guide/watchtowers.md index 527694b4b..f577ec715 100644 --- a/doc/beginners-guide/watchtowers.md +++ b/doc/beginners-guide/watchtowers.md @@ -1,13 +1,13 @@ --- -title: "Watchtowers" -slug: "watchtowers" -excerpt: "Defend your node against breaches using a watchtower." -hidden: false -createdAt: "2022-11-18T16:28:27.054Z" -updatedAt: "2023-02-02T07:13:57.111Z" +title: Watchtowers +slug: watchtowers +content: + excerpt: Defend your node against breaches using a watchtower. +privacy: + view: public --- The Lightning Network protocol assumes that a node is always online and synchronised with the network. Should your lightning node go offline for some time, it is possible that a node on the other side of your channel may attempt to force close the channel with an outdated state (also known as revoked commitment). This may allow them to steal funds from the channel that belonged to you. A watchtower is a third-party service that you can hire to defend your node against such breaches, whether malicious or accidental, in the event that your node goes offline. It will watch for breaches on the blockchain and punish the malicious peer by relaying a penalty transaction on your behalf. -There are a number of watchtower services available today. One of them is the [watchtower client plugin](https://github.com/talaia-labs/rust-teos/tree/master/watchtower-plugin) that works with the [Eye of Satoshi tower](https://github.com/talaia-labs/rust-teos) (or any [BOLT13](https://github.com/sr-gi/bolt13/blob/master/13-watchtowers.md) compliant watchtower). \ No newline at end of file +There are a number of watchtower services available today. One of them is the [watchtower client plugin](https://github.com/talaia-labs/rust-teos/tree/master/watchtower-plugin) that works with the [Eye of Satoshi tower](https://github.com/talaia-labs/rust-teos) (or any [BOLT13](https://github.com/sr-gi/bolt13/blob/master/13-watchtowers.md) compliant watchtower).