From 34b783a1f67426ab586c557d247b4bc28937ef74 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Sun, 29 Sep 2024 12:46:09 +0300 Subject: [PATCH] Docs imprevements (#56) * fix README.md * fix addSubdomains.md * fix README.md * fix README.md * fix lnd-onchain-wallet-only.md * fix seedxor.md * fix README.md --- BTCPayServer/README.md | 2 +- BTCPayServer/addSubdomains.md | 4 ++-- ZAPtoRaspiBolt/README.md | 2 +- backups/README.md | 4 ++-- backups/lnd-onchain-wallet-only.md | 4 ++-- backups/seedxor.md | 4 ++-- electrs/README.md | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/BTCPayServer/README.md b/BTCPayServer/README.md index 906aa27..7738b97 100644 --- a/BTCPayServer/README.md +++ b/BTCPayServer/README.md @@ -2,7 +2,7 @@ Run BTCPayServer on your RaspiBlitz using the already synced bitcoin blockchain and local LND node. Benefit from the backup and security features of the RaspiBlitz and LND. -No added synchronization needed. +No added synchronization is needed. Requirements: * a domain name or dynamic DNS diff --git a/BTCPayServer/addSubdomains.md b/BTCPayServer/addSubdomains.md index 3fdd197..69f5051 100644 --- a/BTCPayServer/addSubdomains.md +++ b/BTCPayServer/addSubdomains.md @@ -11,7 +11,7 @@ read EMAIL echo "Input 3 subdomains separated with commas (eg: pay.example.com,tips.example.com,status.example.com)" read SUBDOMAINS -echo "Input the URL to be redirected to for the second domain" +echo "Input the URL to be redirected to the second domain" read REDIRECT1 echo "Input the URL to be redirected to for the third domain" read REDIRECT2 @@ -81,4 +81,4 @@ server { proxy_pass http://localhost:23000; } } " | sudo tee -a /etc/nginx/sites-available/btcpayserver -``` \ No newline at end of file +``` diff --git a/ZAPtoRaspiBolt/README.md b/ZAPtoRaspiBolt/README.md index a00f350..7031e70 100644 --- a/ZAPtoRaspiBolt/README.md +++ b/ZAPtoRaspiBolt/README.md @@ -5,7 +5,7 @@ The desktop app ZAP (https://github.com/LN-Zap/zap-desktop) ) is a cross platform Lightning Network wallet focused on user experience and ease of use. -Download ZAP for your operating sytem: +Download ZAP for your operating system: https://github.com/LN-Zap/zap-desktop/releases Install instructions: https://github.com/LN-Zap/zap-desktop#install diff --git a/backups/README.md b/backups/README.md index fb1bd8e..c49d9c2 100644 --- a/backups/README.md +++ b/backups/README.md @@ -13,10 +13,10 @@ Can be thought of as a physical 2-of-3 multisig solution. ## [Samourai Wallet](samouraiwallet.md) --- ### Electrum Wallet seed as a passphrase -A well proven way to generate random 12 word list is to create a new wallet seed in [Electrum Wallet](https://electrum.org/#download). +A well proven way to generate a random 12 word list is to create a new wallet seed in [Electrum Wallet](https://electrum.org/#download). To use Electrum boot [Tails](https://tails.boum.org/) (ideally offline) or [download and verify the wallet](https://electrum.org/#download) on an existing system. -Follow steps 1-5 in this [guide](https://bitcoinelectrum.com/creating-an-electrum-wallet/) to get the seed. The wallet file is not needed, only write down the words and store accordingly. The 12 words are to be used as a passphrase, encryption passphrase, cypher phrase or wallet unlock password. Do not reuse passphrases for more than one purpose and label the backups clearly. +Follow steps 1-5 in this [guide](https://bitcoinelectrum.com/creating-an-electrum-wallet/) to get the seed. The wallet file is not needed, only write down the words and store them accordingly. The 12 words are to be used as a passphrase, encryption passphrase, cypher phrase or wallet unlock password. Do not reuse passphrases for more than one purpose and label the backups clearly. The [Electrum word list](https://github.com/spesmilo/electrum/blob/master/electrum/wordlist/english.txt) is based on the same 2048 words as the the [BIP39 word list](https://github.com/bitcoin/bips/blob/master/bip-0039/english.txt) which the ColdCard firmware contains so the keyboard entry is facilitated by the menu. diff --git a/backups/lnd-onchain-wallet-only.md b/backups/lnd-onchain-wallet-only.md index 0baa45a..83e013f 100644 --- a/backups/lnd-onchain-wallet-only.md +++ b/backups/lnd-onchain-wallet-only.md @@ -17,7 +17,7 @@ More on LND wallet recovery: Test at https://guggero.github.io/cryptography-toolkit/#!/aezeed -Include the Node ID on all backup locations. It is derived from the bip32 root key (encoded by the Seed + Cypher Phrase) so can be used to identify the backup and test the successful recovery. +Include the Node ID on all backup locations. It is derived from the bip32 root key (encoded by the Seed + Cypher Phrase) so it can be used to identify the backup and test the successful recovery. Obtain the Node ID with ``` $ lncli getinfo | grep identity_pubkey @@ -45,4 +45,4 @@ $ lncli getinfo | grep identity_pubkey ### Location 3 * Node ID * Seed words #1 - #12 -* Seed words #13 - #24 \ No newline at end of file +* Seed words #13 - #24 diff --git a/backups/seedxor.md b/backups/seedxor.md index 4560ff7..773c1b1 100644 --- a/backups/seedxor.md +++ b/backups/seedxor.md @@ -1,7 +1,7 @@ ## SeedXOR multi-location backup scheme Full documentation: [seedxor.com/](https://seedxor.com/) -Existig seeds can be broken up with seedXOR or can be used as components of a new a scheme. +Existig seeds can be broken up with seedXOR or can be used as components of a new scheme. If there was a BIP39 passphase used keep a copy of the passphrase on every location. Currently the scheme can be used on a [ColdCard](https://github.com/Coldcard/firmware/blob/master/docs/seed-xor.md) and is planned to be implemented in [SeedSigner](https://github.com/SeedSigner/seedsigner/issues/43). @@ -26,4 +26,4 @@ The seed can also be calculated manually so the ColdCard is not strictly necessa #### Location 3 * Seed1 -* Seed3 \ No newline at end of file +* Seed3 diff --git a/electrs/README.md b/electrs/README.md index 07e8dcd..d9e716b 100644 --- a/electrs/README.md +++ b/electrs/README.md @@ -4,7 +4,7 @@ ![electrum](./images/electrum.png) -Requires 50 Gb diskpace after compactiing and ~100 GB during indexing (Nov 2019). +Requires 50 Gb diskpace after compacting and ~100 GB during indexing (Nov 2019). Tested on: * Raspberry Pi 4