highperfocused/raspiblitz
1
0
Fork 0
mirror of https://github.com/raspiblitz/raspiblitz.git synced 2025-03-29 19:22:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'Enegnei/patch-1'

Browse Source 
# Conflicts:
#	README.md
This commit is contained in:
Robert Habermann 2020-09-05 23:47:21 +02:00
commit 7fc7d638b3
1 changed files with 153 additions and 154 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

307
README.md
View File

@ -6,7 +6,7 @@
![RaspiBlitz](pictures/raspiblitz.jpg)
**The RaspiBlitz is a do-it-yourself Lightning Node based on LND running together with a Bitcoin-Fullnode on a RaspberryPi 3/4 - with a HDD/SSD and an nice display for easy setup & monitoring.**
**The RaspiBlitz is a do-it-yourself Lightning Node based on LND running together with a Bitcoin-Fullnode on a RaspberryPi 3/4 - with an HDD/SSD and a nice display for easy setup & monitoring.**
RaspiBlitz is mainly targeted for learning how to run your own node decentralized from home - because: Not your Node, Not your Rules. Discover & develop the growing ecosystem of the Lightning Network by becoming a full part of it. Build it as part of a [workshop](WORKSHOP.md) or as a weekend project yourself.
@ -16,7 +16,7 @@ This is a quick look at the SSH main menu (once RaspiBlitz is SetUp):
![MainMenu-A](pictures/mainmenu.png)
As an alternative to the SSH menu the "Ride the Lightning" (RTL) WebUI is available:
As an alternative to the SSH menu, the "Ride the Lightning" (RTL) WebUI is available:
![RTL-preview](pictures/RTL-dashboard.png)
@ -60,7 +60,7 @@ If you start at home ordering the parts from Amazon (see shopping list below) th
## Hardware Needed
All parts together are at around 180-250 USD - based on shops and location.
All parts together cost around 180-250 USD - based on shops and location.
### Buy a ready-2-go RaspiBlitz (Germany, EU and International)
@ -72,11 +72,11 @@ Find a list of other shops selling a Ready-2-Go RaspiBlitz in your area on [rasp
The cheapest way is to buy and assemble the single parts yourself. There are two packages.
*Please try to use the exact hardware models that are recommended in the shopping lists, because we have multiple reports were for example other SSD or SSD cases/controllers lead to problems. The idea of the shopping lists is to provide you the best tested hardware components that work together - improvement recommendations are always welcome.*
*Please try to use the exact hardware models that are recommended in the shopping lists. We have had multiple reports where, for example, other SSD or SSD cases/controllers lead to problems. The idea of the shopping lists is to provide you the best tested hardware components that work together - improvement recommendations are always welcome.*
#### Package: Standard (around 250 USD)
*The "Standard Package" is most tested and recommended if you can afford it. It aims to give you the best economic value to run all the RaspiBlitz features at a good performance and even allows you to self-validate your blockchain in under 3 days.*
*The "Standard Package" is the most tested and recommended option if you can afford it. It aims to give you the best economic value to run all the RaspiBlitz features with good performance and even allows you to self-validate your blockchain in under 3 days.*
* RaspberryPi 4 4GB (or 8GB) [amazon referral link](https://geni.us/raspiblitz-4gb-new)
* Power Supply - USB-C, 5V, >=3A [amazon referral link](https://geni.us/raspiblitz-ps)
@ -86,7 +86,7 @@ The cheapest way is to buy and assemble the single parts yourself. There are two
* LCD - 3.5" RPi Display, GPIO connection, XPT2046 Touch Controller: [amazon referral link](https://geni.us/raspiblitz-touchscreen)
* Heatsink Case for RPi4 : [amazon referral link](https://geni.us/heatsink-raspi4)
*You can even pay your RaspiBlitz Amazon Shopping with Bitcoin & Lightning through [Bitrefill](https://blog.bitrefill.com/its-here-buy-amazon-vouchers-with-bitcoin-on-bitrefill-bb2a4449724a).*
*You can even pay for your RaspiBlitz Amazon Shopping with Bitcoin & Lightning through [Bitrefill](https://blog.bitrefill.com/its-here-buy-amazon-vouchers-with-bitcoin-on-bitrefill-bb2a4449724a).*
#### Package: Minimal (around 180 USD)
@ -136,7 +136,7 @@ SHA-256: bf8f70cf3a6d87d1b786936306ae092b6350be22f0c19c3a06171450178594ca or [SI
* [What's new in Version 1.6 of RaspiBlitz?](CHANGES.md#whats-new-in-version-16-of-raspiblitz)
* [How to update my RaspiBlitz?](README.md#updating-raspiblitz-to-new-version)
* [How to verify the sd card image after download?](FAQ.md#how-to-verify-the-sd-card-image-after-download)
* [How to verify the SD card image after download?](FAQ.md#how-to-verify-the-sd-card-image-after-download)
## Write the SD-Card image to your SD Card
@ -172,7 +172,7 @@ Now open up a terminal ([OSX](https://www.youtube.com/watch?v=5XgBd6rjuDQ)/[Win1
If you run into a problem or you have still a question, follow the steps below to get support. Also check the [setup documentation](#setup-process-detailed-documentation) for details.
1. Lookup the [FAQ](FAQ.md) if you can find an answer to this question/problem.
1. Look up the [FAQ](FAQ.md) if you can't find an answer to this question/problem.
2. If you have a hardware problem, please check that your hardware parts are exactly the parts recommended in the shopping list above. Different screens or even SSD-casings can cause problems.
@ -182,7 +182,7 @@ If you run into a problem or you have still a question, follow the steps below t
5. Go to the GitHub issues of the RaspiBlitz: https://github.com/rootzoll/raspiblitz/issues Do a search there. Also check closed issues by removing 'is:open' from the filter/search-box.
6. If you haven't found an answer yet, open a new issue on the RaspiBlitz GitHub. You may have to register an account with GitHub for this. If it's a bug with the RaspiBlitz, please add (copy+paste) a Debug Report to your issue (see [FAQ](FAQ.md) how to generate) and/or add some screenshots/photos so the community gets more insight into your problem.
6. If you haven't found an answer yet, open a new issue on the RaspiBlitz GitHub. You may have to register an account with GitHub for this. If it's a bug with the RaspiBlitz, please add (copy+paste) a Debug Report to your issue (see [FAQ](FAQ.md) for how to generate them) and/or add some screenshots/photos so the community gets more insight into your problem.
## Setup Process (Detailed Documentation)
@ -192,13 +192,13 @@ If you are looking for a tutorial on how to organize a workshop to build the Ras
### Init
Automatically after login per SSH as admin to the RaspiBlitz, it will run a hardware test.
Automatically after login via SSH as admin to the RaspiBlitz, it will run a hardware test.
![HardwareTest](pictures/hardwaretest.png)
If you see a warning there, please read carefully, because a lot of things that go wrong later (errors and even loss of funds) relate to problems with the hardware. If you get an OK here ... you are good to go :)
In the beginning you can choose how to setup your RaspiBlitz, by running on Bitcoin or Litecoin with Lightning. This is also the point where you can import a Migration file from an older RaspiBlitz - read about Migration [further down](README.md#import-a-migration-file). The default is here to choose Bitcoin.
In the beginning you can choose how to setup your RaspiBlitz, by running on Bitcoin or Litecoin with Lightning. This is also the point where you can import a Migration file from an older RaspiBlitz - read about Migration [further down](README.md#import-a-migration-file). The default choice here is Bitcoin.
![SSH0](pictures/ssh0-welcome2.png)
@ -208,7 +208,7 @@ First thing to setup is giving your RaspiBlitz a name:
This name is given to the RaspiBlitz as a public alias of the lightning node for everybody to see.
Then the user gets requested to think of and write down 4 passwords:
Then the user is requested to think of and write down 4 passwords:
![SSH2](pictures/ssh2-passwords.png)
@ -232,13 +232,13 @@ Then the user is asked to enter the Password B - this is internally used for the
### Running behind Tor
On setup you can now decide if you want to run your RaspiBlitz behind Tor or make your IP public to the lightning network.
On setup you can now decide if you want to run your RaspiBlitz behind Tor or make your IP public to the Lightning Network.
![TOR](pictures/chooseTOR.png)
Your IP can reveal your location (at least to a certain radius) to everyone and your internet provider has a record of your personal identity tied to your IP. When you choose to run behind the Tor network this personal data is much better protected. But running behind Tor reduces speed and might make it more difficult to connect to you for other nodes or pairing other devices and apps to it.
You can switch Tor off later on. Also you can switch Tor on also after the setup, but keep in mind that once running your node with your public IP leaves records on the internet connecting your lightning node id to your public IP.
You can switch Tor off later on. You can also switch Tor on after the setup, but keep in mind that once your node is running, your lightning node id can be connected to your public IP.
After this the setup process will need some time and the user will see a lot of console outputs - just wait until it's finished:
@ -248,13 +248,13 @@ After this the setup process will need some time and the user will see a lot of
*If you have a HDD/SSD with a prepared blockchain (e.g. a ready2go-set or you are at a workshop) you have the option to trust that data and skip to the [next chapter](#setup-lightning). If you started with an empty HDD - you will see the following screens:*
If you connected a fresh Hard Drive or SSD to the RaspiBlitz it might now ask you if it's OK to format it.
If you connected a fresh Hard Drive or SSD to the RaspiBlitz, it might now ask you if it's OK to format it.
<img src="pictures/ssh4-formatHDD.png" alt="format-HDD" width="366">
*Your HDD/SSD will get formatted with the linux standard file system EXT4. If you want to try out the experimental new [BTRFS](FAQ.md#why-use-btrfs-on-raspiblitz) that RaspiBlitz supports since v1.4 - you need to start the setup with an additional 32GB USB thumb drive connected to the second USB3 port of the RaspberryPi. Then you will unlock this new secret feature.*
After formatting you need to get a copy of the blockchain, the RaspiBlitz offers the following options:
After formatting you need to get a copy of the blockchain; the RaspiBlitz offers the following options:
<img src="pictures/ssh5-blockchain2.png" alt="blockchain-options" width="551">
@ -262,7 +262,7 @@ The options - and when to choose which - will be explained here shortly:
#### 1. SYNC - Selfvalidate all Blocks
With the new RaspberryPi 4 (with SSD & min 2GB RAM) this is the best way to go. It will take around 2-3 days to sync & validate directly with the bitcoin network and then you have done it completely the original `don't trust, verify` way.
With the new RaspberryPi 4 (with SSD & min 2GB RAM) this is the best way to go. It will take around 2-3 days to sync & validate directly with the bitcoin network. With this option, you have done it the original `don't trust, verify` way.
*For the old RaspberryPi 3 this is not recommended. A RaspberryPi 3 has a very low power CPU and syncing+validating the blockchain directly with the peer2peer network can take multiple weeks - that's why for a RP3 you should choose the COPY option .*
@ -282,7 +282,7 @@ Lightning is installed and waiting for your setup if you see this screen.
![SSH7](pictures/ssh7-lndinit.png)
You now decide if you want to setup a fresh new wallet or if you want to recover an old wallet from a RaspiBlitz you had before.
You can now decide if you want to setup a fresh new wallet or if you want to recover an old wallet from a RaspiBlitz you had before.
#### Setup a NEW Wallet
@ -290,13 +290,13 @@ This is the default if you setup a RaspiBlitz the first time.
![SSH8](pictures/ssh8-wallet.png)
RaspiBlitz will ask you to set your wallet unlock password - use your chosen PASSWORD C here and confirm it by inputting it a second time.
RaspiBlitz will ask you to set your wallet unlock password - use your chosen PASSWORD C here. Confirm by inputting it a second time.
LND will now generate a fresh cipher seed (word list) for you.
![SSH8](pictures/ssh8-walletb.png)
WRITE YOUR PERSONAL WORDS DOWN before you continue - without it you limit your chances to recover funds in case of failing hardware etc. If you just want to try/experiment with the RaspiBlitz at least take a photo with your smartphone just in case. If you might plan to keep your RaspiBlitz running store this word list offline or in a password safe. You can use the [RaspiBlitz Password Sheet (PDF)](https://github.com/rootzoll/raspiblitz/raw/v1.4/home.admin/assets/RaspiBlitzRecoverySheet.pdf) for this.
WRITE YOUR PERSONAL WORDS DOWN before you continue - without it you limit your chances to recover funds in case of failing hardware etc. If you just want to try/experiment with the RaspiBlitz, at least take a photo with your smartphone just in case. If you plan to keep your RaspiBlitz running, store this word list offline or in a password safe. You can use the [RaspiBlitz Password Sheet (PDF)](https://github.com/rootzoll/raspiblitz/raw/v1.4/home.admin/assets/RaspiBlitzRecoverySheet.pdf) for this.
#### Recover an OLD Wallet
@ -314,35 +314,35 @@ Choose this option if you have made a complete backup of the LND data and have a
##### SEED+SCB Words Seed & channel.backup file (OK)
Next best option is, if you have the channel.backup file and the word seed. This is the best chance to recover your on-chain funds and funds you had in open channels. But all channels you had open before will be closed in this procedure.
Next best option is, if you have the channel.backup file and the word list seed. This is the best chance to recover the on-chain funds you had in open channels. But all channels you had open before will be closed during this procedure.
##### ONLY SEED Only Seed Word List (Fallback)
If you just have the word list (RaspiBlitz 1.1 and older) you can at least try to recover your on-chain funds. Recover of channel funds is not very likely in this scenario.
If you just have the word list (RaspiBlitz 1.1 and older) you can at least try to recover your on-chain funds. Recovery of channel funds is not very likely in this scenario.
### Final LND Setup
It will now make sure your wallet is initialized correctly and may ask you to unlock it with your just set PASSWORD C.
It will now make sure your wallet is initialized correctly and may ask you to unlock it with PASSWORD C.
![SSH9c](pictures/ssh9c-unlock.png)
*The LND wallet needs to get unlocked on every new start/reboot of the RaspiBlitz.*
The RaspiBlitz will now do final setup configuration like installing tools, moving the SWAP file to the HDD or activating the firewall. You will see some text moving across the screen until this screen:
The RaspiBlitz will now do final setup configuration, such as installing tools, moving the SWAP file to the HDD, or activating the firewall. You will see some text moving across the screen until this screen:
![SSH9b](pictures/ssh9b-reboot.png)
The basic setup is done - hooray ... but it can now take still some time before everything is ready and you can play around with your new RaspiBlitz. Press OK to make a reboot. Your terminal session will get disconnected and the raspberry pi restarts.
The basic setup is done - hooray ... but it may still take some time before everything is ready and you can play around with your new RaspiBlitz. Press 'OK' to reboot. Your terminal session will get disconnected and the raspberry pi restarts.
### First Start: Syncing & Scanning
After the reboot is done it takes a while for all services to start up - wait until you see on the LCD/display that LND wallet needs to get unlocked. Then SSH in again with the same command like in the beginning (check LCD/display) but this time (and every following login) use your PASSWORD A.
After the reboot is done, it will take a while for all services to start up - wait until you see on the LCD/display that LND wallet needs to get unlocked. Then SSH in again with the same command like in the beginning (check LCD/display) but this time (and every following login) use your PASSWORD A.
After terminal login LND will ask you (like on every start/reboot) to unlock the wallet again - use PASSWORD C:
After terminal login, LND will ask you (like on every start/reboot) to unlock the wallet again - use PASSWORD C:
![SSH9c](pictures/ssh9c-unlock.png)
Now on first start you will have a longer waiting time (between 10 minutes and 2-3 days, depending on your initial setup) ... but that's OK, just leave the RaspiBlitz running until it's done.
On first start, you will have a longer waiting time (between 10 minutes and 2-3 days, depending on your initial setup) ... but that's OK, just leave the RaspiBlitz running until it's done.
![SSH9d1](pictures/ssh9d-sync.png)
@ -352,7 +352,7 @@ To understand what is taking so long .. it's two things:
1. Blockchain Sync
The blockchain on your HDD is not absolutely up-to-date. Depending how you got it transferred to your RaspiBlitz it will be some hours, days or even weeks behind. Now the RaspiBlitz needs to catch-up the rest by directly syncing with the peer-2-peer network until it reaches almost 100%. But even if you see in the beginning a 99.8% this can take time - gaining 1% can be up to 4 hours (depending on network speed). So be patient here.
The blockchain on your HDD is not absolutely up-to-date. Depending on how you got it transferred to your RaspiBlitz it will be some hours, days, or even weeks behind. Now the RaspiBlitz needs to catch-up on the rest by directly syncing with the peer-2-peer network until it reaches almost 100%. Even if you see progress at 99.8%, there can still be waiting time - gaining 1% can take up to 4 hours (depending on network speed), so be patient here.
2. Lightning Scanning
@ -360,7 +360,7 @@ Automatically if the Blockchain Sync is progressing LND will start to scan the b
* [Why is my "final sync" taking so long?](FAQ.md#why-is-my-final-sync-taking-so-long)
Once all is done you should see this status screen on the RaspiBlitz LCD/display like this:
Once all is done, you should see a status screen on the RaspiBlitz LCD/display like this:
![SSH9dz](pictures/ssh9z-ready.png)
@ -370,17 +370,17 @@ If you now login by SSH in your RaspiBlitz (or you are still logged in) you will
![SSH9e1](pictures/mainmenu.png)
And if you scroll down .. you see even more options. All options of the main menu will be explained below in the feature documentation.
And if you scroll down .. you see even more options. All options on the main menu will be explained below in the feature documentation.
*OK .. so from here on your RaspiBlitz is ready to play with.*
*OK .. so from here on out, your RaspiBlitz is ready to play with.*
If you need an idea what the most basic next steps to experience Lightning would be:
If you need an idea of what the most basic next steps to experience Lightning would be:
* Fund on-chain Wallet
* Open a channel
* Make a payment
If you like to do this all from a web browser with a dashboard UI instead from an SSH terminal, go to `SERVICES`, activate the `RTL Webinterface` and after the reboot you will see a new `RTL` option in the SSH main menu - it will give you all the information so that you can now open the RTL Webinterface in your browser.
If you would prefer to do this from a web browser with a dashboard UI, instead of an SSH terminal, go to `SERVICES`, activate the `RTL Webinterface`, and after the reboot you will see a new `RTL` option in the SSH main menu - it will give you all the information so that you can now open the RTL Webinterface in your browser.
Have fun riding the lightning :D
@ -396,7 +396,7 @@ So let's take a look at the SSH main in detail:
#### INFO: Raspiblitz Status Screen
This is the screen that gets displayed on the LCD/display. It's useful to call in a remote situation from SSH if you don't have your RaspiBlitz next to you. But also if you want to copy+paste your nodeID or make a screenshot.
This is the screen that gets displayed on the LCD/display. It's useful to call in a remote situation from SSH if you don't have your RaspiBlitz next to you, or if you want to copy+paste your nodeID or make a screenshot.
![SSH9dz](pictures/ssh9z-ready.png)
@ -408,27 +408,27 @@ This is the screen that gets displayed on the LCD/display. It's useful to call i
#### FUNDING: Fund your on-chain Wallet
Before you can open channels with other nodes you need to put some coins onto your LND on-chain wallet. Use this option to generate an address to send funds to.
Before you can open channels with other nodes you need to put some coins in your LND on-chain wallet. Use this option to generate an address to send funds to.
*Reminder: RaspiBlitz & LND is still experimental software. With funding your LND node you accept the risk of losing funds. So just play with small amounts - something in the area of 20 EUR/USD should be enough to make your first experiences. Also, it's a good privacy practice to [coinjoin your coins](https://bitcoin-only.com/#privacy) before sending them to any Lightning Network wallet.*
You can make multiple fundings - so you can start with small amounts first to test. LND will generate always a different address, but all funds you send will get into the same LND on-chain wallet.
You can fund it multiple times - starting with small amounts first to test. LND will always generate a different address, but all funds you send will get into the same LND on-chain wallet.
#### CONNECT: Connect to a Peer
Before you can open a channel with another node on the network you need to connect this node as a peer to your node.
Before you can open a channel with another node on the network, you need to connect this node as a peer to your node.
Opening a channel with a peer is just optional. Having another node as peer helps your node to receive information about the network through the gossip protocol. It will help your node to find better routes through the network.
#### CHANNEL: Open a Channel with Peer
To open a payment channel with another node you can use this option.
To open a payment channel with another node, you can use this option.
Find interesting nodes to open channels with on online directories like [1ML.com](https://1ml.com/) or join the RaspiBlitz NodeManager telegram group to meet people to open channels with: https://t.me/raspiblitz
Find interesting nodes to open channels with through online directories like [1ML.com](https://1ml.com/) or join the RaspiBlitz NodeManager telegram group to meet people to open channels with: https://t.me/raspiblitz
Bear in mind that this option will open a public channel that can be seen by everyone in the network. This is good if you want to route payments. If your intention is to use it privately only, you will need to go to the command line and open the channel with the -private option.
Bear in mind that this option will open a public channel that can be seen by everyone in the network. This is good if you want to route payments. If your intention is to use it privately only, you must go to the command line and open the channel with the -private option.
*This is just a very basic shell script. For more usability try the RTL Webinterface (under Services) or connect a (mobile) wallet with your RaspiBlitz.*
*This is just a very basic shell script. For more usability, try the RTL Webinterface (under Services) or connect a (mobile) wallet with your RaspiBlitz.*
#### SEND: Pay an Invoice/PaymentRequest
@ -436,7 +436,7 @@ Pay an invoice through lightning.
*This is just a very basic shell script. For more usability try the RTL Webinterface (under Services) or connect a (mobile) wallet with your RaspiBlitz.*
If you are looking for something to test pay with Lightning ... why not [donate some satoshis to the RaspiBlitz development[(https://tallyco.in/s/r5lx23/)? Thanks :)
If you are looking for something to test payments with Lightning ... why not [donate some satoshis to RaspiBlitz development](https://tallyco.in/s/r5lx23/)? Thanks :)
#### RECEIVE: Create Invoice/PaymentRequest
@ -448,9 +448,9 @@ Create an invoice to send to someone for a service to be paid through lightning.
*This option is just available if you have channels open.*
With this feature you can close down all open channels and get funds locked up in those channels back to your on-chain wallet.
With this feature you can close down all open channels and get the funds locked up in those channels back to your on-chain wallet.
It might even offer you to force close some channels where the channel-partner is no longer reachable. Keep in mind that those force closings can take a much longer time until your funds are available again on your on-chain wallet.
You may choose to force-close some channels where the channel partner is no longer reachable. Keep in mind that when you force-close a channel, it can take a much longer time until your funds are available again through your on-chain wallet.
#### CASHOUT: Remove Funds from on-chain Wallet
@ -472,30 +472,30 @@ Beware - earning fees as a routing node does not come automatic. It's a bit of h
#### SETTINGS: Basic Settings of RaspiBlitz
Here you find basic settings for your RaspiBlitz:
Here you will find basic settings for your RaspiBlitz:
![MainMenu-Settings](pictures/settings.png)
Activate/Deactivate settings with the space bar and then select OK to activate changes. Here you find more details about those options (top to down):
Activate/Deactivate settings with the space bar and then select 'OK' to activate changes. You can find more details about those options (top to down):
##### Run behind Tor
You can run your Bitcoin- & Lightning-Node and also additional Apps as a Tor hidden service - replacing your IP with an .onion-address
You can run your Bitcoin- & Lightning-Node, as well as additional Apps, as a Tor hidden service - replacing your IP with an .onion-address
![tor1](pictures/tor1.png)
This has some benefits:
Running your node as a hidden service has some benefits:
* You don't publish your IP running a node so it's much harder to resolve your real name and location.
* You tunnel through the NAT of your router and make Bitcoin and Lightning reachable to all other Tor nodes.
* By using a Tor address it's possible to move the node to a different IPv4 address and keep the existing (i.e. previously opened and funded) channels functional.
But this also comes with the following side effects:
But this can also come with the following side effects:
* Some Mobile wallets don't support connecting to RaspiBlitz over Tor yet
* Lightning nodes that don't run Tor cannot reach you (like behind NAT)
* Some Mobile wallets don't support connecting to RaspiBlitz over Tor yet.
* Lightning nodes that don't run Tor cannot reach you (like behind NAT).
To try it out just switch on the service - you can deactivate later on if it's not working for you.
To try it out, just switch on the service - you can deactivate it later on if it's not working for you.
##### Touchscreen (experimental)
@ -512,7 +512,7 @@ It will give you 4 buttons on the right side.
##### LCD Rotate
If you switch this on you can rotate the LCD of your RaspiBlitz 180 degrees. This can make sense if you want to use it in a special case or wall mount.
If you switch this on, you can rotate the LCD of your RaspiBlitz 180 degrees. This might make sense if you have a special case or wall mount.
##### Channel Autopilot
@ -524,17 +524,17 @@ Keysend is a feature of LND that allows your node to accept payments without cre
##### Testnet
You can switch from mainnet to testnet of your blockchain if you want to try things out and play with free test coins.
You can switch from the mainnet to testnet blockchain if you want to try things out and play with free test coins.
Please beware that this might take some time to sync the test blockchain and you need to setup a new lnd testnet wallet during the process.
##### LND Auto-Unlock
The RaspiBlitz will automatically unlock the LND wallet on every start.
The RaspiBlitz will automatically unlock the LND wallet upon every start.
This feature is based on https://github.com/Stadicus/guides/blob/master/raspibolt/raspibolt_6A_auto-unlock.md
It can be activated under "Services" -> "Auto-unlock LND". It's recommended to be turned on, when DynamicDNS is used. Because on a public IP change of your router, LND gets restarted automatically and without Auto-Unlock it will stay inactive/unreachable until you manually unlock it.
It can be activated under "Services" -> "Auto-unlock LND". We recommend that it be turned on, when DynamicDNS is used. If there is a public IP change on your router, LND restarts automatically, and without Auto-Unlock it will stay inactive/unreachable until you manually unlock it.
* [When using Auto-Unlock, how much security do I lose?](FAQ.md#when-using-auto-unlock-how-much-security-do-i-lose)
@ -552,11 +552,11 @@ With ZeroTier you can add your RaspiBlitz to a software defined network - see fo
#### SERVICES: Activate/Deactivate Services
The RaspiBlitz offers further Services, Apps and configuration (scroll down in the to see all in the RaspiBlitz):
The RaspiBlitz offers further Services, Apps and configuration (scroll down to see all options in the RaspiBlitz):
![MainMenu-Services](pictures/services.png)
Activate/Deactivate service selection with the space bar and then select OK to trigger Install/Uninstall. Here you find more details about those options (top to down):
Activate/Deactivate service selection with the space bar and then select 'OK' to trigger Install/Uninstall. You can find more details about those options below (top to bottom):
##### Lightning Loop
@ -564,11 +564,11 @@ A Submarine Swaps Service by lighting labs. You call it from the RaspiBlitz term
[Details on Service](https://github.com/lightninglabs/loop)
After install you will see a new `LOOP` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `LOOP` option in the SSH main menu - it will give you all the information you need to start using it.
##### RTL Webinterface
The RTL Webinterface is a LND Control Dashboard you can run in your browser with a nice GUI - it offers much more control over your Lightning node than the RaspiBlitz SSH menus. It's recommended to give it a try.
The RTL Webinterface is an LND Control Dashboard you can run in your browser with a nice GUI - it offers much more control over your Lightning node than the RaspiBlitz SSH menus. It's recommended to give it a try.
![RTL](pictures/RTL-dashboard.png)
@ -578,7 +578,7 @@ Read an Intro-Tutorial to RTL: https://medium.com/@suheb.khan/how-to-ride-the-li
Feedback is welcome by the RTL programmer: https://github.com/ShahanaFarooqui/RTL
After install you will see a new `RTL` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `RTL` option in the SSH main menu - it will give you all the information you need to start using it.
##### BTC-RPC-Explorer
@ -588,42 +588,42 @@ BTC-RPC-Explorer is a blockchain explorer website you can run on your own RaspiB
[Details on Service](https://github.com/janoside/btc-rpc-explorer)
After install you will see a new `EXPLORE` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `EXPLORE` option in the SSH main menu - it will give you all the information you need to start using it.
##### Cryptoadvance Specter
Bitcoin Core that you have running on the RaspiBlitz has a very powerful command line interface and a wonderful daemon. Using PSBT and HWI it can also work with hardware wallets, but at the moment it is too linux-way. The same applies to multisignature setups.
Bitcoin Core has a very powerful command line interface and a wonderful daemon. Using pre-signed bitcoin transactions (PSBT) and [Hardware Wallet Interface](https://github.com/bitcoin-core/HWI) (HWI), it can also work with hardware wallets. At the moment it is very Linux-focused. The same applies to multi-signature setups.
The goal of SpecterDesktop is to make a convenient and user-friendly GUI around Bitcoin Core with a focus on multisignature setup with airgapped hardware wallets like Trezor, Ledger, COLDCARD or the Specter-DIY.
The goal of SpecterDesktop is to make a convenient and user-friendly GUI around Bitcoin Core, focusing on multi-signature setups with airgapped hardware wallets like Trezor, Ledger, COLDCARD or the Specter-DIY.
![SPECTER](pictures/specter.jpg)
After install you will see a new `SPECTER` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `SPECTER` option in the SSH main menu - it will give you all the information you need to start using it.
##### Electrum Rust Server
Enables a user to run his own Electrum server on the RaspiBlitz. The server indexes the entire Bitcoin blockchain saved locally on your HDD/SSD, and the resulting index enables fast queries for any given user wallet, allowing the user to keep real-time track of his balances and his transaction history using the [Electrum wallet](https://electrum.org).
Since Electrum Rust Server runs on the user's own machine, there is no need for the wallet to communicate with external Electrum servers, thus preserving the privacy of the user's addresses and balances.
Since Electrum Rust Server runs on the user's own machine, there is no need for the wallet to communicate with external Electrum servers, thus preserving the privacy of addresses and balances.
For example if you use your Trezor Hardware Wallet with the trezor.io wallet it will tell a third party your public keys - connecting it with your IP. Now you can use your Trezor with the Electrum Wallet just talking to your own Electrum Server preserving your privacy.
By contrast, if you use your Trezor Hardware Wallet with the trezor.io wallet, it will tell their third party server your public keys - connecting it with your IP. Now you can use your Trezor with the Electrum Wallet, just talking to your own Electrum Server, preserving your privacy.
[YouTube: TOR and Electrum Server on Raspiblitz](https://www.youtube.com/watch?v=AiosKK_TA7w)
[More Details on Service](https://github.com/romanz/electrs)
After install you will see a new `ELECTRS` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `ELECTRS` option in the SSH main menu - it will give you all the information you need to start using it.
##### BTCPayServer
BTCPay Server is a self-hosted, open-source cryptocurrency payment processor. It's secure, private, censorship-resistant and free.
[BTCPay Server](https://github.com/btcpayserver) is a self-hosted, open-source cryptocurrency payment processor. It's secure, private, censorship-resistant and free.
![BTCPAY](pictures/btcpay.png)
*At the moment the RaspiBlitz can just make the BTCPayServer publicly available to the outside over the Tor network (Hidden Service).*
*At the moment, the RaspiBlitz will only make the BTCPayServer publicly available to the outside over the Tor network (Hidden Service).*
[Details on Service](https://btcpayserver.org/)
After install you will see a new `BTCPAY` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `BTCPAY` option in the SSH main menu - it will give you all the information you need to start using it.
##### LNDmanage
@ -631,14 +631,14 @@ lndmanage is a command line tool for advanced channel management of a node.
*You need at least one open channel to use this tool.*
To run it change to the RaspiBlitz terminal and type 'manage'. This starts the LNDManage interactive mode and you can use the following commands:
To run it, change to the RaspiBlitz terminal and type 'manage'. This starts the LNDManage interactive mode and you can use the following commands:
* __Activity reports ```report```__
* __Display the node summary ```status```__
* __Advanced channel listings ```listchannels```__
* ```listchannels rebalance```: list channels for rebalancing
* ```listchannels forwardings```: list forwarding statistics for each channel
* ```listchannels hygiene```: information for closing of active channels
* ```listchannels hygiene```: information for closing active channels
* ```listchannels inactive```: information on inactive channels
* __Rebalancing command ```rebalance```__
* different rebalancing strategies can be chosen
@ -648,15 +648,15 @@ To run it change to the RaspiBlitz terminal and type 'manage'. This starts the L
[Details on Service](https://github.com/bitromortac/lndmanage/blob/master/README.md)
After install you will see a new `LNDMANAGE` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `LNDMANAGE` option in the SSH main menu - it will give you all the information you need to start using it.
##### Faraday
Faraday is a Channel Analysis & Recommendations CLI that can help you on your channel management.
Faraday is a Channel Analysis & Recommendations CLI that can help you with channel management.
[Details on Service](https://github.com/lightninglabs/faraday/blob/master/README.md)
After install you will see a new `FARADAY` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `FARADAY` option in the SSH main menu - it will give you all the information you need to start using it.
##### Balance of Satoshi
@ -664,24 +664,24 @@ Balance of Satoshi gives you enhanced commands for working with LND balances.
[Details on Service](https://github.com/alexbosworth/balanceofsatoshis/blob/master/README.md)
After install you will see a new `BOS` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `BOS` option in the SSH main menu - it will give you all the information you need to start using it.
##### ThunderHub
Is a Lightning Node Manager WebUI - similar to RTL.
A Lightning Node Manager WebUI - similar to RTL.
[Details on Service](https://www.thunderhub.io)
After install you will see a new `THUB` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `THUB` option in the SSH main menu - it will give you all the information you need to start using it.
##### LNbits
LNbits is a very simple server that sits on top of your Lightning Wallet
LNbits is a very simple server that sits on top of your Lightning Wallet.
![LNBITS](pictures/lnbits.png)
It can be used as:
- Accounts system to mitigate the risk of exposing applications to your full balance, via unique API keys for each wallet
- Account system to mitigate the risk of exposing applications to your full balance, via unique API keys for each wallet
- Fallback wallet for the LNURL scheme
- Instant wallet for LN demonstrations
@ -689,7 +689,7 @@ You can also develop extensions on it.
[Details on Service](https://github.com/arcbtc/lnbits/blob/master/README.md)
After install you will see a new `LNBITS` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `LNBITS` option in the SSH main menu - it will give you all the information you need to start using it.
##### JoinMarket
@ -699,7 +699,7 @@ A CoinJoin transaction requires other people to take part. The right resources (
For more details see [here](https://github.com/JoinMarket-Org/joinmarket-clientserver).
After install you will see a new `JMARKET` option in the SSH main menu - it will give you all the information so that you can start using it.
After install, you will see a new `JMARKET` option in the SSH main menu - it will give you all the information you need to start using it.
#### SUBSCRIBE: Subscription Services
@ -707,9 +707,9 @@ The RaspiBlitz offers now also Subscriptions .. those are free or paid third-par
![MainMenu-Services](pictures/subscriptions.png)
Under `LIST my Subscriptions` you will always find the list of all your running subscriptions to get more details or to `CANCEL` them.
Under `LIST my Subscriptions` you will always find the list of all your active subscriptions, to get more details or to `CANCEL` them.
At the moment the following subscription services are available:
At the moment, the following subscription services are available:
##### IP2TOR (paid)
@ -717,7 +717,7 @@ IP2TOR is a tunnel service where you can run your RaspiBlitz anonymously behind
At first you select what service of your RaspiBlitz you like to tunnel thru a IP2TOR bridge.
Then you choose the store that provides the IP2TOR bridges that you are interested in. This address can be changed or you just go with the default store that is presented to you.
You will get a list of available IP2TOR bridge offerings. Select `OK` on an IP2TOR bridge offering and you will see more details on it, such as how many satoshis the subscription will cost you - your node should be funded and have channels open at this point.
Then you get a list of available IP2TOR bridge offerings. By selecting `OK` on a IP2TOR bridge offering you can get more details on it and you will also see how many satoshis the subscription will cost you - your node should be funded and you should have channels open at this point.
@ -727,44 +727,43 @@ To try out the IP2TOR tunnel choose in `MAINMENU` the extra menu point of the Se
##### HTTPS with LetsEncrypt (free)
If you want a Webservice like BTCPay Server or LNbits available to the outside internet (like with IP2TOR) people expect you to offer HTTPS address so that the communication between the client and your RaspiBlitz is encrypted. You could use the self-signed HTTPS certificate that RaspiBlitzis offering you, but this will give users Security Warnings in their browser and is not very user friendly. Thats were you can use a LetsEncrypt Subscription to get a free valid HTTPS certificate that is accepted without warning from almost all common browsers.
If you want a Webservice like BTCPay Server or LNbits available to the outside internet (like with IP2TOR) people expect you to offer HTTPS address so that the communication between the client and your RaspiBlitz is encrypted. You could use the self-signed HTTPS certificate that RaspiBlitzis offering you, but this will give users Security Warnings in their browser and is not very user friendly. That's where you can use a LetsEncrypt Subscription to get a free valid HTTPS certificate that is excepted without warning from almost all common browsers.
Because you also need a domain name for that you will need to open a free account on [DuckDNS.org](https://www.duckdns.org) ... further options might be added in the future.
If you create a new LetsEncrypt subscription you will be asked for your subdomain on DuckDNS and the Auth-Token of your DuckDNS account. Then RaspiBlitz tries to setup everything for you. If everything worked you will find now the subscription under `MAINMENU` > `SUBSCRIBE` > `LIST My Subscriptions` where you can cancel it again.
When you create a new LetsEncrypt subscription, you will be asked for your subdomain on DuckDNS and the Auth-Token of your DuckDNS account. Then RaspiBlitz tries to setup everything for you. If everything worked, you will find the subscription under `MAINMENU` > `SUBSCRIBE` > `LIST My Subscriptions`, where you can cancel it at any time if you wish.
To try out the IP2TOR tunnel choose in `MAINMENU` the extra menu point of the Service you choose the bridge for and it should give you now an updated URL to call your service.
To try out the IP2TOR tunnel, go into `MAINMENU` and the extra menu point of the Service you want to use the bridge for. It should give you an updated URL to call your service.
#### MOBILE: Connect Mobile Wallet
This feature should support you in connecting your RaspiBlitz to a mobile wallet on your smartphone.
This feature should support connecting your RaspiBlitz to a mobile wallet on your smartphone.
<img src="pictures/mobile.png" alt="mobile-wallets">
At the moment the following mobile wallets are supported:
At the moment, the following mobile wallets are supported:
* [ZAP (iOS/Android)](https://github.com/LN-Zap/zap-iOS)
* [Zeus (iOS/Android)](https://github.com/ZeusLN/zeus)
* [Fully Noded (iOS over Tor)](https://apps.apple.com/us/app/fully-noded/id1436425586)
* [SendMany (Android)](https://github.com/fusion44/sendmany/blob/master/README.md)
Basically those mobile wallets work as a remote control app for your RaspiBlitz. First you need to install the apps on your phone - a QR code with the links to the app stores are displayed. And then you need to `pair` them with your RaspiBlitz - also with a QR code displayed on the LCD. If you run your RaspiBlitz without a LCD there is the fallback option to display that QR code on the terminal as ASCII code (might involve lowering your terminal font size).
Mobile wallets work as a remote control app for your RaspiBlitz. First you need to install the apps on your phone - a QR code with the links to the app stores are displayed. Then you need to `pair` them with your RaspiBlitz - also via a QR code displayed on the LCD. If you run your RaspiBlitz without an LCD, there is the fallback option to display that QR code on the terminal as ASCII code (which might involve lowering your terminal's font size).
#### LNDCREDS: Macaroons and TLS.cert
If you want to access your LND APIs (to connect apps and additional services) you need credential files that grant to access (Macaroons & the TLS cert).
If you want to access your LND APIs (to connect apps and additional services) you need credential files that grant access (Macaroons & the TLS cert).
*Macaroons: Access Tokens that allow certain command executions on the LND node.*
*TLS: Certificate to secure/encrypt the communication with the LND node.*
*TLS: Certificate to secure/encrypt communication with the LND node.*
In this menu you can reset and re-sync those or export them as a file or string so that you can import them to the apps and additional services. The following export options are available:
In this menu, you can reset, re-sync, or export them as a file or string so that you can import them to apps and additional services.
Offers the following options to get the Macaroon and TLS files to be used in other apps and wallets.
Here are the following export options to get the Macaroon and TLS files to be used in other apps and wallets:
##### Hex-String
The Macaroons and TLS.cert files can be copy+pasted as Hex-Strings from RaspiBlitz to any other app that supports that. If you choose this option RaspiBlitz will all files print for you as Hex-String to do so.
The Macaroons and TLS.cert files can be copy+pasted as Hex-Strings from RaspiBlitz to any other app that supports that format. If you choose this option, RaspiBlitz will print all the files for you as Hex-String to do so.
This method is recommended to export to:
* [Joule Browser Wallet](https://lightningjoule.com)
@ -792,15 +791,15 @@ Change your passwords for security.
#### REPAIR: Options to test, repair and reset your RaspiBlitz
The `REPAIR` menu gives you options to check and reset your RaspiBlitz
The `REPAIR` menu gives you options to check and reset your RaspiBlitz.
![RepairMenu](pictures/repairmenu.png)
The options are explained in detail:
The options are explained in detail below:
##### HARDWARE: Run Hardware Test
This will start the hardware test and identify if your RaspiBlitz is in good shape and can provide a stable service.
This will start the hardware test to identify if your RaspiBlitz is in good shape and can provide a stable service.
Use this option if you see under-voltage reports on your LCD display or you think your RaspiBlitz gets very hot.
@ -808,11 +807,11 @@ Use this option if you see under-voltage reports on your LCD display or you thin
This will print out a lot of information that can be used to find software problems.
Use this if you want to report a software problem with your RaspiBlitz so that others can have a look at the details and help you better.
Use this if you want to report a software problem with your RaspiBlitz, so that others can have a look and help you better.
##### BACKUP-LND: Backup your LND data (Rescue-File)
This stops your RaspiBlitz and creates a LND-Rescue ZIP file you can download per SCP to your laptop. This can be used to move your LND id, wallet & channels to another RaspiBlitz.
This stops your RaspiBlitz and creates an LND-Rescue ZIP file that you can download via SCP to your laptop. This can be used to move your LND id, wallet & channels to another RaspiBlitz.
*NOTICE: If you start your RaspiBlitz after this backup again the backup is outdated and using it can risk losing your channel funds.*
@ -824,32 +823,32 @@ This stops your RaspiBlitz and creates a Migration ZIP file you can download/exp
##### COPY-SOURCE: Offer your Blockchain to another RaspiBlitz for Setup
Basically you can connect another RaspiBlitz and copy over your blockchain to it for quicker setup. Your RaspiBlitz will be `offline` during that process that can take between 4 to 6 hours.
To expedite the setup process, you can connect another RaspiBlitz and copy over your blockchain data to it. Your RaspiBlitz will be `offline` during that process and it can take between 4 to 6 hours.
Make sure both RaspiBlitzes are connected to the same local network. During setup the new RaspiBlitz should choose the `COPY` option to get the blockchain and then choose as source computer `RASPIBLITZ`. Now you activate the `COPY-SOURCE` option and enter the given IP of the new RaspiBlitz and that ones Password A (not yours) .. then the process should start.
Make sure both RaspiBlitzes are connected to the same local network. During setup with the new RaspiBlitz, choose the `COPY` option to get the blockchain data and then select the source computer `RASPIBLITZ`. Now you can activate the `COPY-SOURCE` option, enter the given IP of the new RaspiBlitz and its Password A (not yours) .. then the process should start.
##### RESET-CHAIN: Delete Blockchain and Re-Download
Use this if your blockchain data got corrupted. It will keep your LND data. You can even keep your channels open. Just keep in mind that your node will be offline to the network until you re-downloaded the blockchain.
Use this option if your blockchain data got corrupted. It will keep your LND data. You can even keep your channels open. Just keep in mind that your Lightning node will appear offline to the network until you have re-downloaded the blockchain.
##### RESET-LND: Delete LND data & start new node/wallet
*THIS WILL DELETE ALL YOUR LND DATA WITH FUND AND CHANNELS.
Use this if you have closed all channels and removed all funds.*
*THIS WILL DELETE ALL YOUR LND DATA AND CHANNEL FUNDS.
Use this only if you have closed all channels and removed all funds.*
Use this if you want to start with a fresh LND nodeid & wallet.
Use this option if you want to start with a fresh LND node id & wallet.
##### RESET-HDD: Delete HDD data but keep blockchain
*THIS WILL DELETE ALL YOUR LND DATA WITH FUND AND CHANNELS.
Use this if you have closed all channels and removed all funds.*
*THIS WILL DELETE ALL YOUR LND DATA AND CHANNEL FUNDS.
Use this only if you have closed all channels and removed all funds.*
Use this if you want to setup a fresh RaspiBlitz but don't want to re-download the blockchain on setup.
Use this if you want to setup a fresh RaspiBlitz but don't want to re-download the blockchain.
##### RESET-ALL: Delete HDD completely & start fresh
*THIS WILL DELETE ALL YOUR LND DATA WITH FUND AND CHANNELS.
Use this if you have closed all channels and removed all funds.*
*THIS WILL DELETE ALL YOUR LND DATA AND CHANNEL FUNDS.
Use this only if you have closed all channels and removed all funds.*
Use this if you want to setup a fresh RaspiBlitz with an empty HDD.
@ -869,7 +868,7 @@ The `UPDATE` menu gives you options to update your RaspiBlitz
The options are explained in detail:
*Please note that the RaspiBlitz does not support an Auto-Update to ensure that there is no remote control of your node possible from a central server.*
*Please note that the RaspiBlitz does not support Auto-Update, to ensure that there is no remote control of your node from a central server.*
#### RELEASE: Update RaspiBlitz to a new Version
@ -887,7 +886,7 @@ With Patching you have now an easy way to sync your RaspiBlitz code/scripts with
#### REBOOT: Reboot RaspiBlitz
A safe way to restart the RaspiBlitz ... have you tried to turn it off and on again?
A safe way to restart the RaspiBlitz ... have you tried turning it off and on again?
#### OFF: PowerOff RaspiBlitz
@ -895,17 +894,17 @@ A safe way to shutdown the RaspiBlitz.
#### X: Console Terminal
Closes the SSH main menu and exits to the terminal - where the user can make use of the CLI clients `bitcoin-cli` & `lncli` directly to make use of the Bitcoin - and Lightning node.
Closes the SSH main menu and exits to the terminal - where the user can make use of the CLI clients `bitcoin-cli` & `lncli` directly.
With the command `raspiblitz` it's possible to return to the main menu.
With the command `raspiblitz`, it's possible to return to the main menu.
## Import a Migration File
As mentioned above you can export a Migration File from your RaspiBlitz with MAINMENU > REPAIR > MIGRATION and store it on your laptop.
A Migration file contains all the important data of your RaspiBlitz like your LND data, Bitcoin Wallet, raspiblitz.config, Tor/SSH keys .. and also the data of installed apps. You can use this to migrate your RaspiBlitz to a new hardware.
A Migration file contains all the important data from your RaspiBlitz, like your LND data, Bitcoin Wallet, raspiblitz.config, Tor/SSH keys .. and also installed apps. You can use this to migrate your RaspiBlitz to new hardware.
If you want to it to import it again to a new RaspiBlitz (for example with an updated HDD/SSD) you can choose the MIGRATION option on the first setup dialog after the Hardwaretest (where you normally choose between Bitcoin & Litecoin).
If you want to import it again to a new RaspiBlitz (for example with an updated HDD/SSD), you can choose the `MIGRATION` option on the first setup dialog after the Hardware test (where you normally choose between Bitcoin & Litecoin).
![SSH0](pictures/ssh0-welcome2.png)
@ -917,19 +916,19 @@ Normally you choose here the EXT4 format. But you also have the option to choose
Then you will be asked to upload the Migration Zip file to the RaspiBlitz. Follow the instructions shown to you.
Finally you need to decide how to get a copy of the blockchain data again for your RaspiBlitz.
Then you need to get a copy of the blockchain data again for your RaspiBlitz.
![MIGRATION2](pictures/migration2.png)
Here you have the two options [SYNC](README.md#1-sync---selfvalidate-all-blocks) and [COPY](README.md#2-copy---copy-from-laptop-or-another-raspiblitz-over-local-network) as mentioned in the normal setup.
You have the two options: [SYNC](README.md#1-sync---selfvalidate-all-blocks) and [COPY](README.md#2-copy---copy-from-laptop-or-another-raspiblitz-over-local-network), as mentioned in the normal setup.
Then RaspiBlitz will reboot and start the normal recovery process to install all the services that are defined by the raspiblitz.config from your Migration File.
RaspiBlitz will reboot and start the normal recovery process to install all the services defined by the raspiblitz.config from your Migration File.
Then the blockchain needs to sync up and you should be back to normal.
## Interface / APIs
To develop your own scripts/apps and to connect other services/apps to your RaspiBlitz you have multiple interfaces/APIs available:
To develop your own scripts/apps and connect other services/apps to your RaspiBlitz, you have multiple interfaces/APIs available:
### Bitcoin
@ -944,19 +943,19 @@ To develop your own scripts/apps and to connect other services/apps to your Rasp
* `gRPC` running on port 10009 (public) [DOC](https://api.lightning.community/)
* `REST` running on port 8080 (public) [DOC](https://api.lightning.community/rest/index.html)
If you activate Tor then your LND gRPC & REST APIs are also reachable publicly as a Hidden Service.
If you activate Tor, then your LND gRPC & REST APIs will also be reachable publicly as a Hidden Service.
### Backup for On-Chain- & Channel-Funds
Since LND v0.6 (and RaspiBlitz v1.2) a feature called Static-Channel-Backups is available. Within RaspiBlitz this is used when a `channel.backup` file is mentioned.
Since LND v0.6 (and RaspiBlitz v1.2), a feature called Static-Channel-Backups is available. Within RaspiBlitz this is used when a `channel.backup` file is mentioned.
It's the best backup to protect the funds you put on your RaspiBlitz and into channel available yet - so it's recommended to make use of it.
At this point in time, it is the best way to backup and protect your channel funds on RaspiBlitz - so it's recommended to make use of it.
To recover your funds you need two things:
- the 24 words seed
To recover your funds this way, you will need two things:
- the 24-word seed
- the latest `channel.backup` file
The word seed you got during wallet setup, to write it down and to keep it at a safe (offline) location. The `channel.backup` is stored on the HDD and updated by LND every time a new channel is opened or closed. The latest version of this file is needed to recover all your funds (if possible). In case your HDD gets damaged, RaspiBlitz always keeps a copy of the latest version of the `channel.backup` file on the SD card within the sub-directories of: `/home/admin/.lnd/data/chain/`.
You should have written down the word seed during wallet setup; keep it at a safe (offline) location. The `channel.backup` is stored on the HDD and updated by LND every time a new channel is opened or closed. The latest version of this file is needed to recover all your funds. In case your HDD gets damaged, RaspiBlitz always keeps a copy of the latest version of the `channel.backup` file on the SD card within the sub-directories of: `/home/admin/.lnd/data/chain/`.
If you want to get one step further in securing your funds against total fall-out of the RaspiBlitz (gets completely damaged, stolen or lost) then you can additionally set up an off-location or cloud backup of the `channel.backup` file. The file itself is encrypted by your word seed - so it's OK to store the file to untrusted third parties for backup (if you want). The feature is still new ... here is how you can set it up at the moment. The following two off-location options are available (and/or):
@ -966,27 +965,27 @@ Activate the StaticChannelBackup to DropBox in the `SERVICES` menu of your Raspi
Go to your web browser, do the following:
1. Go to https://www.dropbox.com/developers/apps/create and sign in
1. Go to https://www.dropbox.com/developers/apps/create and sign in.
1. Choose **Dropbox Api**
1. Choose **Dropbox Api**.
![Dropbox API 1](https://raw.githubusercontent.com/vindard/lnd-backup/master/images/dropbox-1.png)
1. Choose **App Folder**
1. Choose **App Folder**.
![Dropbox API 2](https://raw.githubusercontent.com/vindard/lnd-backup/master/images/dropbox-2.png)
1. Name your app and click **Create App** to proceed
1. Name your app and click **Create App** to proceed.
![Dropbox API 3](https://raw.githubusercontent.com/vindard/lnd-backup/master/images/dropbox-3.png)
1. On the settings page for your new app, scroll down to **OAuth 2** and click **Generate**
1. On the settings page for your new app, scroll down to **OAuth 2** and click **Generate**.
![Dropbox API 4](https://raw.githubusercontent.com/vindard/lnd-backup/master/images/dropbox-4.png)
1. You will now see a string of letters and numbers appear. This is your **Dropbox-Authtoken**.
To test it - open or close a channel and check if you find a copy of `channel.backup` in your dropbox. You can check the background-script logs to see details on errors: `sudo journalctl -f -u background`
To test it, try opening or closing a channel, and then check if you can find a copy of `channel.backup` in your Dropbox. You can check the background-script logs to see details on errors: `sudo journalctl -f -u background`
#### B) SCP Backup Target
@ -994,19 +993,19 @@ To test it - open or close a channel and check if you find a copy of `channel.ba
In the `/mnt/hdd/raspiblitz.conf` the parameter `scpBackupTarget='[USER]@[SERVER]:[DIRPATH-WITHOUT-ENDING-/]'` can be set to activate this feature. On that remote server the public key of the RaspiBlitz root user needs to be part of the authorized keys - so that no password is needed for the background script to make the backup.
The script `/home/admin/config.scripts/internet.sshpubkey.sh` helps on init, show and transfer ssh-pubkey to a remote server.
The script `/home/admin/config.scripts/internet.sshpubkey.sh` helps on initalization (init); it will show and transfer ssh-pubkey to a remote server.
To test it - open or close a channel and check if you find a copy of `channel.backup` on your remote server. You can check the background-script logs to see details on errors: `sudo journalctl -f -u background`
To test it, try opening or closing a channel, and then check if you can find a copy of `channel.backup` on your remote server. You can check the background-script logs to see details on errors: `sudo journalctl -f -u background`
#### C) Local Backup Target (USB Thumbdrive)
*You can also backup the SCB to another local drive, e.g. an USB stick:*
*You can also backup the SCB to another local drive, e.g. a USB stick:*
You can use a small USB thumb drive (everything over 120MB is fine). Please don't use a second HDD/SSD for this because that might drain too much power and could hurt the security of your data more then it helps.
To activate this feature go to MAINMENU > SETTINGS > 'StaticChannelBackup on USB Drive' and follow the instructions.
To activate this feature, go to `MAINMENU` > `SETTINGS` > `StaticChannelBackup on USB Drive` and follow the instructions.
To test it - open or close a channel and check if you find a copy of `channel.backup` in the specified location. You can check the background-script logs to see details on errors: `sudo journalctl -f -u background`
To test it, try opening or closing a channel, and then check if you can find a copy of `channel.backup` in the specified location. You can check the background-script logs to see details on errors: `sudo journalctl -f -u background`
## Updating RaspiBlitz to new Version
@ -1018,9 +1017,9 @@ If you have a RaspiBlitz v1.0 or v1.1 or higher do the following:
* Remove power
* Remove SD card
Now download the new RaspiBlitz SD card image and write it to your SD card .. yes you simply overwrite the old one, it's OK, the RaspiBlitz stores all your personal data on the HDD. See details about latest SD card image [here](#installing-the-software).
Now download the new RaspiBlitz SD card image and write it to your SD card. Yes, you simply overwrite the old one, it's OK! The RaspiBlitz stores all your personal data on the HDD. See details about latest SD card image [here](#installing-the-software).
*If you have done manual changes to the system (installed packages, added scripts, etc) you might need to do some preparations before overwriting your sd card - see [FAQ](FAQ.md#why-do-i-need-to-re-burn-my-sd-card-for-an-update).*
*If you have done manual changes to the system (installed packages, added scripts, etc), you might need to do some preparations before overwriting your SD card - see [FAQ](FAQ.md#why-do-i-need-to-re-burn-my-sd-card-for-an-update).*
If done successfully, simply put the SD card into the RaspiBlitz and power on again. Then follow the instructions on the display ... and don't worry, you don't need to re-download the blockchain again.
@ -1028,18 +1027,18 @@ If done successfully, simply put the SD card into the RaspiBlitz and power on ag
## Build the SD Card Image
A ready to use SD card image of the RaspiBlitz for your RaspberryPi is provided as download by us to get everybody started quickly (see above). But if you want to build that image yourself - here is a quick guide:
A ready-to-use SD card image of RaspiBlitz is provided by us for download, to get everybody started quickly (see above). But if you want to build that image yourself - here is a quick guide:
* Get a fresh Rasbian RASPBIAN BUSTER WITH DESKTOP card image: [DOWNLOAD](https://www.raspberrypi.org/downloads/raspbian/)
* Write image to a SD card: [TUTORIAL](https://www.raspberrypi.org/documentation/installation/installing-images/README.md)
* Add a file called `ssh` to the root of the SD card when mounted to enable SSH login
* Start card in Raspi and login per SSH with `ssh pi@[IP-OF-YOUR-RASPI]` password is `raspberry`
* Get a fresh Raspbian RASPBIAN BUSTER WITH DESKTOP card image: [DOWNLOAD](https://www.raspberrypi.org/downloads/raspbian/).
* Write the image to an SD card: [TUTORIAL](https://www.raspberrypi.org/documentation/installation/installing-images/README.md).
* Add a file called `ssh` to the root of the SD card when mounted to enable SSH login.
* Start the card in Raspi and login via SSH with `ssh pi@[IP-OF-YOUR-RASPI]`. Password is `raspberry`.
Now you are ready to start the SD card build script (check the code if every installs and config is OK for you) - copy the following command into your terminal and execute:
Now you are ready to start the SD card build script (check the code to see if the installation and config are OK for you). Copy the following command into your terminal and execute:
`wget https://raw.githubusercontent.com/rootzoll/raspiblitz/master/build_sdcard.sh && sudo bash build_sdcard.sh`
As you can see from the URL you find the build script in this Git repo under `build_sdcard.sh` - there you can check what gets installed and configured in detail. Feel free to post improvements as pull requests.
As you can see from the URL, you can find the build script in this Git repo under `build_sdcard.sh`. You can check what gets installed and configured in detail. Feel free to post improvements as pull requests.
The whole build process takes a while. At the end the LCD drivers get installed and a reboot is needed. A user `admin` is created during the process. Remember the default password is now `raspiblitz`. You can login per SSH again - this time use admin: `ssh admin@[IP-OF-YOUR-RASPI]`. An installer of the SD card image should automatically launch. If you do not want to continue with the installation at this moment and use this sd card as a template for setting up multiple RaspiBlitzes, click `Cancel` and run `/home/admin/XXprepareRelease.sh`. Once you see the LCD going white and the activity LED of the pi starts going dark, you can unplug power and remove the SD card. You have now built your own RaspiBlitz SD card image.
@ -1056,19 +1055,19 @@ Here is a short selection of the very frequently asked questions:
* [How to backup my Lightning Node?](FAQ.md#how-to-backup-my-lightning-node)
* [How can I recover my coins from a failing RaspiBlitz?](FAQ.md#how-can-i-recover-my-coins-from-a-failing-raspiblitz)
* [Are those "Under-Voltage detected" warnings a problem?](FAQ.md#are-those-under-voltage-detected-warnings-a-problem)
* [Can I run RaspiBlitz on other computer boards than RaspberryPi?](FAQ.md#can-i-run-raspiblitz-on-other-computers-than-raspberrypi)
* [Can I run RaspiBlitz on computer boards other than RaspberryPi?](FAQ.md#can-i-run-raspiblitz-on-other-computers-than-raspberrypi)
You have still more questions? Check the [RaspiBlitz-FAQ-Archive](FAQ.md).
Do you still have more questions? Check the [RaspiBlitz-FAQ-Archive](FAQ.md).
## Community Development
Everybody is welcome to join, improve and extend the RaspiBlitz - it's a work in progress. [Check the issues](https://github.com/rootzoll/raspiblitz/issues) if you wanna help out or add new ideas. You find the scripts used for RaspiBlitz interactions on the device at `/home/admin` or in this git repo in the subfolder `home.admin`.
Everybody is welcome to join, improve, and extend the RaspiBlitz - it's a work in progress. [Check the issues](https://github.com/rootzoll/raspiblitz/issues) if you wanna help out or add new ideas. You find the scripts used for RaspiBlitz interactions on the device at `/home/admin` or in this Git repo's subfolder `home.admin`.
To start your Deep Dive into the RaspiBlitz project, the following YouTube video (July 2020) is recommended: [https://www.youtube.com/watch?v=QXUGg45CWLo](https://www.youtube.com/watch?v=QXUGg45CWLo)
[![Watch the RaspiBlitz DeepDive](pictures/raspiblitz-deepdive.png)](https://www.youtube.com/watch?v=QXUGg45CWLo)
Also get inspired for a deep-dive with the original "[RaspiBolt](https://stadicus.github.io/RaspiBolt/)" tutorial on how to build a lightning node on the RaspberryPi which was the base work the RaspiBlitz was developed on - so much thx to Stadicus :)
Also get inspired for a deep-dive with the original "[RaspiBolt](https://stadicus.github.io/RaspiBolt/)" tutorial on how to build a lightning node on the RaspberryPi, the base work on which the RaspiBlitz was developed - so much thx to Stadicus :)
Join me on twitter [@rootzoll](https://twitter.com/rootzoll), visit us at an upcoming [#lightninghackday](https://twitter.com/hashtag/LightningHackday?src=hash) or check by one of our bitcoin meetups in Berlin ... every 1st Thursday evening a month at the room77 bar - feel free to buy me a beer with lightning there :)