highperfocused/raspiblitz
1
0
Fork 0
mirror of https://github.com/raspiblitz/raspiblitz.git synced 2025-04-11 21:29:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/rootzoll/raspiblitz

Browse Source
This commit is contained in:
rootzoll 2020-01-06 22:59:54 +01:00
commit 3eca5e48a5
5 changed files with 62 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
FAQ.md
View File

@ -771,7 +771,7 @@ PubkeyAuthentication yes
GatewayPorts yes
AllowTcpForwarding yes
ClientAliveInterval 60
ClientAliveCountMax=2
ClientAliveCountMax 2
```
*Last two parameters were added as used in the ssh tunnel demo at #GPN19 https://media.ccc.de/v/gpn19-76-einen-server-daheim-ohne-ffentliche-ipv4-adresse#t=911*

56
WORKSHOP.md
View File

@ -1,6 +1,6 @@
# RaspiBlitz Workshop Tutorial
One goal of the RaspiBlitz project is to provide a open DIY platform for workshops - to setup your own lightning node and learn to manage it. This tutorial is collecting best practices on how to organise a RaspiBlitz workshop.
One goal of the RaspiBlitz project is to provide an open DIY platform for workshops - to setup your own lightning node and learn to manage it. This tutorial is collecting best practices on how to organise a RaspiBlitz workshop.
<br/>
@ -8,17 +8,22 @@ One goal of the RaspiBlitz project is to provide a open DIY platform for worksho
First thing on planning a RaspiBlitz workshop is to calculate the time needed correctly. For example, the setup from scratch with no further support is still a weekend project - mostly because downloading and syncing the blockchain takes a lot of time.
So the time required for the workshop all depends on the preparation you as a workshop organizer are interested to provide ahead of the workshop. This document outlines three starting configurations... going from most preparation required to least.
Note that the time estimates below are about getting a node to a "clean setup". They do not include the funding & setting up channels process - which is adding an additional 30 min to 1 hour to the calculation.
Also, if your group is lager then 5 participants, calculate some extra time for individual support. You can compensate for that if you let two participants work together on one RaspiBlitz setup; this way you limit individual support and let them help each other.
## Workshop Scenario A) Provide a Ready-2-Go RaspiBlitz
_Estimated Duration: 2 Hours_
Sure, one part of the fun for participents is to assemble the hardware themselves. But if you aim for the shortest workshop possible, then this is the way to go (around 2 hours lenght). If you have the RaspiBlitz already assembled to be operational at the workshop, you can utilize one big time saver feature: "The Pre-Sync". Before the workshop starts you can already plug an assembled RaspiBlitz into power+network and when there is a preloaded bitcoin blockchain on the HDD it will already start catching up. So your participants start with an on-the-spot synced blockchain and will just have to deal with waiting times during the lightning node setup. But keep in mind that you need budget to buy all the hardware and lots of time in preparation for this - order the parts two weeks before and start peparing at least 3 days before the workshop.
Sure, one part of the fun for participants is to assemble the hardware themselves. But if you aim for the shortest workshop possible, then this is the way to go (around 2 hours length). If you have the RaspiBlitz already assembled to be operational at the workshop, you can utilize one big time saver feature: "The Pre-Sync". Before the workshop starts you can plug power+network cables into an assembled RaspiBlitz with a preloaded bitcoin blockchain on the HDD which will already start catching up to current block height. So your participants start with an on-the-spot synced blockchain and will just have to deal with waiting times during the lightning node setup. But keep in mind that you need a budget to buy all the hardware and lots of time in preparation for this - order the parts two weeks before and start preparing at least 3 days before the workshop.
These are the following steps you need to prepare (follow links for details):
@ -35,7 +40,9 @@ _NOTE: You will already take 2 hours to setup the RaspiBlitz software. For group
_Estimated Duration: 3 Hours_
In this workshop scenario you buy all the hardware but let participants assemble the RaspiBlitz themselves - that's half the fun and people get a feel for the gear. But to keep the blockchain sync time short and be able to keep in a 3 hour timeframe you need to prepare the HDDs with blockchain data not much older than one day. Start ordering the parts at least one week before the workshop (budget needed) and plan the day before completely for copying blockchain data to all those HDDs.
In this workshop scenario you buy all the hardware but let participants assemble the RaspiBlitz themselves - that's half the fun and people get a feel for the gear. But to keep the blockchain sync time short and be able to keep in a 3 hour timeframe you need to prepare the HDDs with blockchain data not much older than one day. Start ordering the parts at least one week before the workshop (budget as needed) and plan the day before completely for copying blockchain data to all those HDDs.
These are the following steps you need to prepare (follow links for details):
@ -46,20 +53,26 @@ These are the following steps you need to prepare (follow links for details):
Variation: If you don't have a big bugdet to prefinance the parts or people have already hardware they want to bring you can just buy the HDDs and SD cards and prepare them to run this scenario.
## Workshop Scenario C) Bring your own Hardware
_Estimated Duration: 4–6 Hours_
This scenario is advised only for small groups, or you'll need to bring multiple blockchain copy stations - see details on "Prepare HDDs with Blockchain Data". Otherwise it needs the least prepartion time and prefinance and can be announced to participants about 5 days beforehand, so that they have time to order all the parts online.
- [Instruct Participants to bring Hardware](WORKSHOP.md#instruct-participants-to-bring-hardware)
- [Prepare Blockchain Copy Station](WORKSHOP.md#prepare-blockchain-copy-station)
- [Setup Workshop Environment](WORKSHOP.md#setup-workshop-environment)
As soon as the participants arrive at the workhop, make sure to check their hardware list. We also suggest taking their HDDs and starting the blockchain copy process before official starting time.
<br/>
# Checklist for Running a Workshop
Make sure you have the following hardware and infrastructure ready for the workshop:
@ -71,8 +84,8 @@ Make sure you have the following hardware and infrastructure ready for the works
- Extra WLAN Router (if you are not sure if LAN & WLAN is not on the same network at location)
- One or two USB SD card adapters
- One or two USB-C to USB-A adapters
- Some Tape, Marker & Pens always come in handy (also for participants to wirte down seeds & passwords)
- Potentially some bitcoin funds (if people dont have their own to start small funding channels)
- Some Tape, Markers & Pens always come in handy (also for participants to wirte down seeds & passwords)
- Potentially some bitcoin funds (if people dont have their own to start funding channels)
Participants need to bring at least their laptops.
@ -84,7 +97,8 @@ _The basic structure of the workshop is set by the RaspiBlitz setup process. Sim
## Welcome and Intro
In the beginning, it's great to give a small introduction to the Lightning Network and show the RaspiBlitz GitHub page to let everybody know where to find the basic info. But try to keep it around 10 min. to not waste time.
In the beginning, it's great to give a small introduction to the Lightning Network and show the RaspiBlitz GitHub page to let everybody know where to find the basic info. But try to keep it around 10 min, in order to not waste time.
Also, even before the intro, take care of the blockchain preparation. If people bring clean HDDs, hook them up to your blockchain copy station as soon as possible. If you have to copy on location, plan to spend time for some deeper educational intro while the HDDs get prepared.
@ -94,17 +108,21 @@ If you hand out hardware kits or people bring their own hardware, it's time to p
## Basic Setup
Connect everybody's laptop to the same local network the RaspiBlitzes are connected to. Be prepared to explain how to open a terminal - Windows' users especially need some help here (see README on this).
Then everybody is SSHing into the RaspiBlitz and is following the setup dialog. Hand out paper and pens for people to write down their passwords and wallet seeds.
## Waiting Time
After the lightning wallet setup comes the longest waiting time during the workshop - around 30 min. when you have a presynced ready-2-go or up to 1 hour for the other scenarios. It's the time when the node is syncing up the blockchain and LND is scanning. If you see someone's blockchain progress under 97%, something is wrong - possibly the HDD was not correctly prepared or the blockchain data is way to old to finish during workshop time.
After the lightning wallet setup comes the longest waiting time during the workshop - around 30 min. when you have a presynced ready-2-go or up to 1 hour for the other scenarios. It's the time when the node is syncing up the blockchain and LND is scanning. If you see someone's blockchain progress under 97%, something is wrong - possibly the HDD was not correctly prepared or the blockchain data is way too old to finish during workshop time.
Use this time for a more in-depth educational segment on lightning in general. This time can also be used to demo with one RaspiBlitz that is already on clean-setup (you prepared before the workshop) how the funding, setting up channels and the other features of the RaspiBlitz work. That way people see what are the next steps once their node is ready and even if your workshop time is over by then they can know the next steps to do at home.
Also this time is good for troubleshooting in individal sessions. If someone is not able to finish the sync on location in time, shutdown the Raspiblitz from SSH terminal with CTRL+C and then `shutdown now`. If the device gets connected back up at home it should pickup the sync/scan process (let people know about the wallet unlock).
Also this time is good for troubleshooting in individual sessions. If someone is not able to finish the sync on location in time shutdown the Raspiblitz from SSH terminal with CTRL+C and then `shutdown now`. If the device gets connected back up at home it should pickup the sync/scan process (let people know about the wallet unlock).
## Finalizing Setup
@ -124,14 +142,18 @@ Here are some videos that show what else is possible with the RaspiBlitz:
# Organisation Tasks
_Which of the follwoing organisation tasks are relevant for you depends on which starting scenario you choose (see above). Here is the complete possible list with details:_
*Which of the following organisation tasks are relevant for you depends on which starting scenario you choose (see above). Here is the complete possible list with details:*
## Buy all the Hardware
See the shopping list on the RaspiBlitz Github README. You need to buy all of those, and every participant also needs a short (about 1m) network cable.
From experience start ordering two weeks before the workshop (if you need to assemble) and minimum one week if you're handing out hardware kits - even if you have Amazon Prime. There is always a shipment coming late, and it's a lot of packages.
If you like to support the RaspiBlitz project you can order a ready-2-go RaspiBlitz or a all-you-need-hardwareset for your RaspiBlitz workshop from [raspiblitz.com](https://raspiblitz.com)
## Instruct Participants to Bring Hardware
@ -142,7 +164,9 @@ In all scenarios make sure people bring their laptops.
## Assemble all the Hardware
Basically you follow the assemble instructions on the RaspiBlitz GitHub README. Think of a safe way to transport the assembled devices to the workshop location - HDDs like it soft.
Basically you follow the assembly instructions on the RaspiBlitz GitHUb README. Think of a safe way to transport the assembled devices to the workshop location - HDDs like it soft.
## Prepare HDDs with Blockchain Data
@ -159,7 +183,10 @@ The bitcoin core client (0.17.1 or higher) needs to be stopped while the data is
The easiest way to get a "template" of such HDD is to setup a fresh RaspiBlitz (without channel and fundings) and then run the script `/home/admin/XXcleanHDD.sh` and manually delete all rest data from the HDD and just leave those folders.
Once you have that "template" you can make a image from that and write that image to the other HDDs.
Once you have that "template" you can make an image from that and write that image to the other HDDs.
## Prepare Blockchain Copy Station
@ -172,11 +199,12 @@ This can be used to prepare and keep multiple HDDs in snyc with blockchain data
_Beware that it will not run as a Lightning Node during that time (LND is stopped). And to reset it back into normal mode you need to stop the script with `CTLR+c` and the reboot with `sudo shutdown -r now`._
In "Copy Station Mode" the RaspiBlitz will just run the bitcoind (so it needs network connection), copy fresh blockchain data over to a template folder on the HDD called `/mnt/hdd/templateHDD` and from there sync it to further HDDs that get connected to it.
If you run it in a setup like on this photo with an extra powered USB hub, you can connect up to 10 HDDs at once to be synced with an almost up-to-date blockchain.
At the moment the "Blockchain Copy Station" is just a computer (laptop - not a RaspberryPi) having a image of a "template" HDD (see above) and you can attach (with a USB3.0 Hub) multiple fresh HHDs to it and start writing in the template image to that.
At the moment the "Blockchain Copy Station" is just a computer (laptop - not a RaspberryPi) having an image of a "template" HDD (see above) and you can attach (with a USB3.0 Hub) multiple fresh HHDs to it and start writing in the template image to that.
To update the "template" HDD for the next workshop use it for a fresh clean RaspiBllitz setup just days before, sync the blockchain to 100% and repeat the process above.
@ -190,7 +218,7 @@ _If someone has a better idea for a 'Blockchain Copy Station', please feel free
## Prepare SD Cards with Latest RaspiBlitz Image
Download the latest RasopiBlitz SD card image from the README page. `Balena Etcher` is the best image writing softare forn this usecase because if you have multiple sd card adapters, you can write multiple cards at once,cutting down your preperation time.
Download the latest RaspiBlitz SD card image from the README page. `Balena Etcher` is the best image writing software for this use case because if you have multiple sd card adapters, you can write multiple cards at once,cutting down your preparation time.
## Setup Workshop Environment
@ -202,6 +230,6 @@ Most important is the network setup. Every RaspiBlitz needs a LAN port in the sw
## Pre-Sync RaspiBlitzes at Workshop Location
In the ready-2-go scenario you have the RaspiBlitzes already assembled and a recent blockchain copy on the HDD. So one ot two hours before the workshop you setup your environment and already plug all RaspiBlitzes with power & network. You will see on the LCD at the top a pre-sync info and progress... if it's something '99.99...' it's good to go. Just leave it running until the workshop starts. You dont need to stop it - just let participants SSH in and they can to the setup.
In the ready-2-go scenario you have the RaspiBlitzes already assembled and a recent blockchain copy on the HDD. So one or two hours before the workshop you setup your environment and already plug all RaspiBlitzes with power & network. You will see on the LCD at the top a pre-sync info and progress .. if its something '99.99..' its good to go. Just leave it running until the workshop starts. You dont need to stop it - just let participants SSH in to enter the setup.
It's also best practice to pre-sync all devices before you move them over to the workshop location. You dont need to SSH to shut them down before packing up - just unplug the network cable first, wait until the HDD is stopping to flash and then remove the power.

5
home.admin/00infoBlitz.sh
View File

@ -294,6 +294,10 @@ else
ln_peers="$(echo "${ln_getInfo}" | jq -r '.num_peers')" 2>/dev/null
ln_channelInfo="${ln_channels_online}/${ln_channels_total} Channels ${ln_channelbalance} sat${ln_channelbalance_pending}"
ln_peersInfo="${color_purple}${ln_peers} ${color_gray}peers"
ln_dailyfees="$(sudo -u bitcoin /usr/local/bin/lncli --macaroonpath=${lnd_macaroon_dir}/readonly.macaroon --tlscertpath=${lnd_dir}/tls.cert feereport | jq -r '.day_fee_sum')" 2>/dev/null
ln_weeklyfees="$(sudo -u bitcoin /usr/local/bin/lncli --macaroonpath=${lnd_macaroon_dir}/readonly.macaroon --tlscertpath=${lnd_dir}/tls.cert feereport | jq -r '.week_fee_sum')" 2>/dev/null
ln_monthlyfees="$(sudo -u bitcoin /usr/local/bin/lncli --macaroonpath=${lnd_macaroon_dir}/readonly.macaroon --tlscertpath=${lnd_dir}/tls.cert feereport | jq -r '.month_fee_sum')" 2>/dev/null
ln_feeReport="Fee Report: ${color_green}${ln_dailyfees}-${ln_weeklyfees}-${ln_monthlyfees} ${color_gray}sat (D-W-M)"
fi
fi
@ -315,6 +319,7 @@ ${color_yellow} / ,' ${color_gray}${public_addr_pre}${public_color}${pu
${color_yellow} /,' ${color_gray}
${color_yellow} /' ${color_gray}LND ${color_green}${ln_version} ${ln_baseInfo}
${color_yellow} ${color_gray}${ln_channelInfo} ${ln_peersInfo}
${color_yellow} ${color_gray}${ln_feeReport}
${color_yellow}
${color_yellow}${ln_publicColor}${ln_external}${color_red}

12
home.admin/30initHDD.sh
View File

@ -32,7 +32,7 @@ if [ ${existsHDD} -eq 1 ]; then
device="sda2"
elif [ ${size3} -gt ${size1} ]; then
echo "sdb is BIGGER - run with this one"
device="sdb"
device="sdb"
else
echo "sda1 is BIGGER - run with this one"
fi
@ -57,7 +57,7 @@ if [ ${existsHDD} -eq 1 ]; then
echo "You HDD was detected with the size of ${isSize} bytes"
echo "For ${network} at least ${minSize} bytes is recommended"
echo "If you know the HDD is bigger then detected, please"
echo "change HDD to 1 partition on another computer first,"
echo "change HDD to 1 partition on another computer first,"
echo "If you want to change to a bigger HDD:"
echo "* Unplug power of RaspiBlitz"
echo "* Make a fresh SD card again"
@ -77,17 +77,17 @@ if [ ${existsHDD} -eq 1 ]; then
if [ ${mountOK} -eq 1 ]; then
echo "FAIL - HDD is mounted"
echo "If you really want to reinit the HDD, then unmount the HDD first and try again"
else
else
echo ""
dialog --title "Format HDD" --yes-button "Yes" --no-button "Cancel" --yesno "RaspiBlitz detected a Hard Disk Drive (HDD).
It will get formatted to EXT4 to be usefull.
It will get formatted to EXT4 to be useful.
This will DELETE ALL FORMER DATA on the HDD.
Is it OK to delete HDD for fresh RaspiBlitz?
" 10 48
if [ $? -eq 1 ]; then
dialog --title "Replace HDD" --msgbox "OK. RaspiBlitz will shutdown now.
Please disconnect Power then.
Please disconnect Power then.
Backup HDD data or connect another one.
Then Power up again." 8 39
sudo shutdown now
@ -102,7 +102,7 @@ Then Power up again." 8 39
sudo mkfs.ext4 /dev/${device} -F -L BLOCKCHAIN
echo "format ext4 done - wait 6 secs"
sleep 6
formatExt4OK=$(lsblk -o UUID,NAME,FSTYPE,SIZE,LABEL,MODEL | grep BLOCKCHAIN | grep -c ext4)
formatExt4OK=$(lsblk -o UUID,NAME,FSTYPE,SIZE,LABEL,MODEL | grep BLOCKCHAIN | grep -c ext4)
if [ ${formatExt4OK} -eq 1 ]; then
echo "OK - HDD is now formatted in ext4"
sleep 1

16
shoppinglist_ch.md
View File

@ -4,7 +4,7 @@
The new shopping list comes in three different packages: Minimal, Standard & Maximal:
## Package: Standard (around 210 CHF)
## Package: Standard (around 240 CHF)
*The "Standard Package" is most tested and recommended if you can effort 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.*
@ -12,19 +12,19 @@ The new shopping list comes in three different packages: Minimal, Standard & Max
* ShimFan Cooling: [pi-shop.ch](https://www.pi-shop.ch/fan-shim-for-raspberry-pi) (order later if sold out)
* Power USBC: [pi-shop.ch](https://www.pi-shop.ch/raspberry-pi-15w-power-supply-eu-schwarz)
* RaspberryPi-Case: [pi-shop.ch](https://www.pi-shop.ch/rainbow-pibow-coupe-4-raspberry-pi-4-only)
* 1TB SSD: [pi-shop.ch](https://www.pi-shop.ch/seagate-expansion-portable-2-5-1tb) or [Brack.ch](https://www.brack.ch/toshiba-externe-festplatte-canvio-basics-1-tb-813514)
* SSD-Case: (not needed in case of [pi-shop.ch](https://www.pi-shop.ch/seagate-expansion-portable-2-5-1tb) solution)
* 500GB SSD: [Digitec](https://www.digitec.ch/en/s1/product/crucial-mx500-500gb-25-ssd-7331523)
* SSD-Case: [Digitec](https://www.digitec.ch/en/s1/product/icy-box-ib-ac703-u3-converters-6067574)
* Micro SD-Card 32GB: [pi-shop.ch](https://www.pi-shop.ch/32gb-microsd-karte-class10-noobs-fuer-raspberry-pi-bereits-installiert)
* LCD-Display: [pi-shop.ch](https://www.pi-shop.ch/3-5inch-rpi-lcd-b-ic-test-board)
* LCD-Display: Original Display is not available in CH. You can by the original from [Amazon.de](https://www.amazon.de/gp/product/B06X191RX7) or us this [pi-shop.ch](https://www.pi-shop.ch/3-5inch-rpi-lcd-b-ic-test-board). If display from pi-shop.ch, you have to install the drivers manually.
## Package: Minimal (around 180 CHF)
## Package: Minimal (around 200 CHF)
*The minimal package aims for the cheapest price and allows you to use old hardware. It will always be possible to run all the basic features of a Bitcoin- & Lightning-Fullnode, but the system might be too slow to validate the blockchain history by itself and run some resource intensive extended services. 500GB SSD are in the same price range like 1TB, therefore go with 1TB*
*The minimal package aims for the cheapest price and allows you to use old hardware. It will always be possible to run all the basic features of a Bitcoin- & Lightning-Fullnode, but the system might be too slow to validate the blockchain history by itself and run some resource intensive extended services.*
Basic Parts for all minimal variants:
* 1TB SSD: [pi-shop.ch](https://www.pi-shop.ch/seagate-expansion-portable-2-5-1tb) or [Brack.ch](https://www.brack.ch/toshiba-externe-festplatte-canvio-basics-1-tb-813514)
* 1TB Hard Drive: [Digitec](https://www.digitec.ch/de/s1/product/toshiba-canvio-basics-1tb-externe-festplatte-3227990)
* Micro SD-Card 16GB: [pi-shop.ch](https://www.pi-shop.ch/16-gb-microsd-karte-class10-noobs-fuer-raspberry-pi-bereits-installiert)
* LCD-Display: [pi-shop.ch](https://www.pi-shop.ch/3-5inch-rpi-lcd-b-ic-test-board)
* LCD-Display: Original Display is not available in CH. You can by the original from [Amazon.de](https://www.amazon.de/gp/product/B06X191RX7) or us this [pi-shop.ch](https://www.pi-shop.ch/3-5inch-rpi-lcd-b-ic-test-board). If display from pi-shop.ch, you have to install the drivers manually.
If you have already a used RaspberryPi 3 B+ you can reuse with the following parts:
* RaspBerry Pi 3: [pi-shop.ch](https://www.pi-shop.ch/raspberry-pi-3-model-b)