michael.heier/umbrel-apps
1
0
Fork 1
mirror of https://github.com/getumbrel/umbrel-apps.git synced 2024-11-11 16:09:18 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md (#896)

Browse Source
This commit is contained in:
smolgrrr 2023-12-09 08:44:55 +11:00 committed by GitHub
parent 22b2f09e70
commit 27b1e008da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -322,56 +322,6 @@ sudo ./scripts/repo checkout https://github.com/<username>/umbrel-apps.git
sudo ./scripts/app update btc-rpc-explorer
```
### 3.1 Testing the app on Umbrel development environment
Umbrel development environment ([`umbrel-dev`](https://github.com/getumbrel/umbrel-dev)) is a lightweight regtest instance of Umbrel that runs inside a virtual machine on your system. It's currently only compatible with Linux or macOS, so if you're on Windows, you may skip this section and directly test your app on a Raspberry Pi 4 running [Umbrel OS](https://github.com/getumbrel/umbrel-os).
1\. First, we'll install the `umbrel-dev` CLI and it's dependencies [Virtual Box](https://www.virtualbox.org) and [Vagrant](https://vagrantup.com) on our system. If you use [Homebrew](https://brew.sh) you can do that with just:
```sh
brew install lukechilds/tap/umbrel-dev gnu-sed
brew install --cask virtualbox vagrant
```
2\. Now let's initialize our development environment and boot the VM:
```sh
mkdir umbrel-dev
cd umbrel-dev
umbrel-dev init
umbrel-dev boot
```
> The first `umbrel-dev` boot usually takes a while due to the initial setup and configuration of the VM. Subsequent boots are much faster.
After the VM has booted, we can verify if the Umbrel dashboard is accessible at http://umbrel-dev.local in our browser to make sure everything is running fine.
3\. We need to use our forked remote app repo:
```sh
cd getumbrel/umbrel
sudo ./scripts/repo checkout https://github.com/<username>/umbrel-apps.git
```
4\. And finally, it's time to install our app:
```sh
sudo ./scripts/app install btc-rpc-explorer
```
That's it! Our BTC RPC Explorer app should now be accessible at http://umbrel-dev.local:3002
5\. To make changes:
Let's commit and push our changes to our forked Umbrel app repo then run:
```sh
sudo ./scripts/repo checkout https://github.com/<username>/umbrel-apps.git
sudo ./scripts/app update btc-rpc-explorer
```
>Don't forget to shutdown the `umbrel-dev` virtual machine after testing with `umbrel-dev shutdown`!
### 3.2 Testing on Umbrel OS (Raspberry Pi 4)
1\. We'll first install and run Umbrel OS on a Raspberry Pi 4. [Full instructions can be found here](https://getumbrel.com/#start). After installation, we'll set it up on http://umbrel.local, and then SSH into the Pi:
@ -432,7 +382,6 @@ _(Upload 3 to 5 high-quality gallery images (1440x900px) of your app in PNG form
### I have tested my app on:
- [ ] [Umbrel dev environment](https://github.com/getumbrel/umbrel-dev)
- [ ] [Umbrel OS on a Raspberry Pi 4](https://github.com/getumbrel/umbrel-os)
- [ ] [Custom Umbrel install on Linux](https://github.com/getumbrel/umbrel#-installation)
```