diff --git a/.gitignore b/.gitignore index 088ba6b..af91b92 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ Cargo.lock # These are backup files generated by rustfmt **/*.rs.bk +.vscode/settings.json diff --git a/umbrel/README.md b/umbrel/README.md index f765eb5..e6c5bfa 100644 --- a/umbrel/README.md +++ b/umbrel/README.md @@ -1,14 +1,28 @@ ## Testing on an Umbrel device. -If you have an Umbrel device and want to test this app on it, do the following: +If you have an Umbrel device running on the standard Raspberry Pi and want to test this app on it, do the following: -1. Clone this repo to your Umbrel somewhere: `git https://github.com/Podcastindex-org/helipad.git` -2. Change to the `umbrel` sub-directory of the helipad repo: `cd helipad/umbrel` -3. Run the install script with the root folder of your Umbrel install as the only argument: `./install.sh ~/umbrel` or `./install.sh /opt/umbrel` +1. SSH into your Umbrel (which will require your Umbrel password): -If the results of running that command look good, you should now be able to get to the boost-a-gram app by going to `http://:2112` -in your browser. + ssh umbrel@umbrel.local + +2. While in the home directory, prompt will show `umbrel@umbrel:~`, clone this repo to your Umbrel: + + git clone https://github.com/Podcastindex-org/helipad.git + +3. Change to the `umbrel` sub-directory of the helipad repo: + + cd helipad/umbrel + +4. Run the install script with the root folder of your Umbrel install as the only argument: + + ./install.sh ~/umbrel/ + +or you may need this if you've done a non-standard Umbrel install `./install.sh /opt/umbrel` + +If the results of running that command look good, you should now be able to get to the boost-a-gram app by going to `http://umbrel.local:2112` +in your browser. You might need to use your Umbrel's IP address if `umbrel.local` doesn't work for you. It can take a few minutes to populate any existing boostagrams you have received since it has to build the invoice database in the background when it first starts up.