mirror of
https://github.com/raspiblitz/raspiblitz.git
synced 2025-11-18 01:46:42 +01:00
documenatation update
This commit is contained in:
rootzoll
81
README.md
81
README.md
@@ -70,7 +70,6 @@ Insert the SD card and connect the power plug.
|
||||
|
||||
* Make sure to connect the raspberry with a LAN cable to the internet at this point.
|
||||
* Make sure that your laptop and the raspberry are on the same local network.
|
||||
* On Mac OS X you can also consider to connect the raspberry directly with your laptop and share your WLAN internet connection over ethernet (thats a nice mobile setup): https://mycyberuniverse.com/mac-os/connect-to-raspberry-pi-from-a-mac-using-ethernet.html
|
||||
|
||||
When everything boots up correctly, you should see the local IP address of your RaspiBlitz on the LCD panel.
|
||||
|
||||
@@ -82,11 +81,23 @@ So open up a [terminal](https://www.youtube.com/watch?v=5XgBd6rjuDQ) and connect
|
||||
|
||||
**Now follow the dialoge in your terminal. This can take some time (prepare some coffee) - but in the end you should have a running Lightning node on your RaspberryPi that you can start to learn and hack on.**
|
||||
|
||||
## Support
|
||||
|
||||
Fore more details on the setup process see the documentation below. If you run into a problem or you have still a question, follow these steps to get support:
|
||||
|
||||
1. Check the [FAQ](FAQ.md) if you can find an answere to this question/problem.
|
||||
|
||||
2. Please determine if your problem/question is about RaspiBlitz or for example with LND. For example if you cant route a payment or get an error when opening a channel that is an LND question/problem an is best answered by the LND dev community: https://dev.lightning.community
|
||||
|
||||
3. 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.
|
||||
|
||||
4. If you havent found an answere yet, open a new issue on the RaspiBlitz GitHub. You may have to register an account with GitHub for this. If its a big 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/photios so the community gets more insight into your problem.
|
||||
|
||||
## Documentation
|
||||
|
||||
### Setup Process
|
||||
|
||||
*The goal is, that all information needed is provided from the interaction with the RaspiBlitz itself during the setup. Documentation in this chapter is for background, comments for educators and help in special edge cases.*
|
||||
*The goal is, that all information needed is provided from the interaction with the RaspiBlitz itself during the setup. Documentation in this chapter is for background, comments for educators and point special edge cases.*
|
||||
|
||||
#### Init
|
||||
|
||||
@@ -240,14 +251,6 @@ There is now the option to connect and control your LND node with the mobile app
|
||||
|
||||
|
||||
|
||||
#### RaspiBlitz as Backend for BTCPayServer (experimental)
|
||||
|
||||
BTCPay Server is a solution to be your own payment processor to accept Lightning Payments for your online store: https://github.com/btcpayserver/btcpayserver
|
||||
|
||||
You can find setup instructions here: https://goo.gl/KnTzLu
|
||||
|
||||
Thanks to @RobEdb (ask on twitter for more details) running his demo store with RaspiBlitz: https://store.edberg.eu - buy a picture of [him and Andreas](https://store.edberg.eu/produkt/jag-andreas/) :)
|
||||
|
||||
#### Public Domain with DynamicDNS
|
||||
|
||||
This is a way to make your RaspiBlitz publicly reachable from the internet so that other nodes can open channels with you and you can connect with the
|
||||
@@ -264,21 +267,25 @@ It can be activated under "Services" -> "Auto-unlock LND". Its recommended to be
|
||||
|
||||
But keep in mind that when activated, your Password C will be stored on the RaspiBlitz SD card. That lowers your security in (physical) attack scenarios. On an update you would need to re-enter your password C.
|
||||
|
||||
## Get a Debug Report
|
||||
## Updating to new Version
|
||||
|
||||
If your RaspiBlitz is not working right and you like to get help from the community, its good to provide more debug information, so other can better diagnose your problem - please follow the following steps to generate a debug report:
|
||||
If you have a RaspiBlitz older then verison 0.98 please [see here](FAQ.md).
|
||||
|
||||
- ssh into your raspiblitz as admin user with your password A
|
||||
- If you see the menu - use CTRL+C to get to the terminal
|
||||
- If your RaspiBlitz is lower then version 0.96 then run: `./XXupdateScripts.sh` first
|
||||
- To generate debug report run: `./XXdebugLogs.sh`
|
||||
- Then copy all output beginning with `*** RASPIBLITZ LOGS ***` and share this
|
||||
If you have a RaspiBlitz version 0.98 or newer do the following:
|
||||
|
||||
PLEASE NOTICE: Its possible that this logs can contain private information (like IPs, node IDs, ...) - just share publicly what you feel OK with.
|
||||
* Main menu > OFF
|
||||
* 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, all your personal data is on the HDD (if you haven't done any manual changes to the system). See details about latest SD card image here: https://github.com/rootzoll/raspiblitz#scenario-2-start-at-home
|
||||
|
||||
If done successfully, simply put the SD card into the RaspiBlitz and power on again. Then follow the instructions on the display ... and dont worry, you dont need to re-download the blockchain again.
|
||||
|
||||
FAQ --> [Why do I need to re-burn my SD card for an update?](FAQ.md)
|
||||
|
||||
## 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. But if you want to build that image yourself - here is a quick guide:
|
||||
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:
|
||||
|
||||
* Get a fresh Rasbian RASPBIAN STRETCH 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)
|
||||
@@ -291,42 +298,10 @@ Now you are ready to start the SD card build script - copy the following command
|
||||
|
||||
As you can see from the URL you find the build script in this Git repo under `build.sdcard/raspbianStretchDesktop.sh`- there 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, click `Cancel` and simply shutdown with `sudo shutdown now`. 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.
|
||||
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 RaspiBlitze, 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.
|
||||
|
||||
*Note: If you plan to use your self build sd card as a MASTER copy to backup image and distribute it. Use a smaller 8GB card for that. This way its ensured that it will fit on every 16 GB card recommended for RaspiBlitz later on.*
|
||||
|
||||
And if you are a developer - to build a sd card from the dev-branch use this command to execute:
|
||||
|
||||
`wget https://raw.githubusercontent.com/rootzoll/raspiblitz/dev/build.sdcard/raspbianStretchDesktop.sh && sudo bash raspbianStretchDesktop.sh 'dev'`
|
||||
|
||||
## Working with a forked GitHub Repo
|
||||
|
||||
If you fork the RaspiBlitz repo (much welcome) and you want to run that code on your RaspiBlitz, there are two ways to do that:
|
||||
|
||||
* The quick way: For small changes in scripts, go to `/home/admin` on your running RaspiBlitz, delete the old git with `sudo rm -r raspiblitz` then replace it with your code `git clone [YOURREPO]` and `./XXupdateScripts.sh`
|
||||
|
||||
* The long way: If you like to install/remove/change services and system configurations you need to build a SD card from your own code. Prepare like in `Build the SD Card Image` but in the end run the command:
|
||||
|
||||
`wget https://raw.githubusercontent.com/[GITHUB-USERNAME]/raspiblitz/[BRANCH]/build.sdcard/raspbianStretchDesktop.sh && sudo bash raspbianStretchDesktop.sh [BRANCH] [GITHUB-USERNAME]`
|
||||
|
||||
## Update to a new SD Card Release
|
||||
|
||||
At the beginning of this README you can find the newest SD card we provide. Or you can build the newest SD card image yourself like in the chapter above. The SD card image is used to setup a fresh install of the RaspiBlitz. So what to do if you already have an older version running and you want to upgrade?
|
||||
|
||||
Until we reach version 1.0 the update process will be a bit rough .. so what you do is:
|
||||
* close all open lightning channels you have (`lncli closeallchannels --force`)
|
||||
* wait until all closing transactions are done
|
||||
* move all on-chain funds to a wallet outside raspiblitz (`lncli --conf_target 3 sendcoins [ADDRESS]`)
|
||||
* run the script `./XXcleanHDD.sh` in admin home directory (Blockchain will stay on HDD)
|
||||
* shutdown RaspiBlitz (`sudo shutdown now`)
|
||||
* flash SD card with new image
|
||||
* Redo a fresh setup of RaspiBlitz
|
||||
* Move your funds back in
|
||||
* Re-Open your channels
|
||||
|
||||
We know that this is not optimal yet. But until version 1.0 we will change too much stuff to garantue any other save update mechanism. Also by redoing all the setup you help out on testing the lastest setup process.
|
||||
|
||||
From the upcomming version 1.0 onwards the goal is to make it easier to keep up with the lastest RaspiBlitz updates.
|
||||
`
|
||||
|
||||
## Recover your Coins from a failing RaspiBlitz
|
||||
|
||||
|
||||
Reference in New Issue
Block a user