Create umbrel deployment

[yzernik]

It would be really cool to have agora as an app in the Umbrel app store. It would really simplify the deployment for the average user.

https://github.com/getumbrel/umbrel/blob/master/apps/README.md

Notes:

• Use debian:buster-slim as base image, per Umbrel recommendations.

[casey]

Thanks for opening this issue! This is something we've been thinking about, and definitely want to do. Would you be interested in helping us beta-test the Unbrel app? We don't run unbrel nodes ourselves, so having someone who was more familiar with the platform would be super helpful.

[yzernik]

I'd be glad to help. I already have two umbrels running (one testnet and one mainnet), and I just deployed my own app recently:
https://github.com/getumbrel/umbrel/blob/master/apps/squeaknode/docker-compose.yml

[casey]

That's awesome, we'll definitely take up up on that if we package it.

Does Umbrel have a way for users to upload files to a directory on their umbrel node, and then map that into an app's container?

We don't have a web UI for managing files on an Agora instance, so it would be convenient if users could so something like:

$ rsync -avz files/ umbrel.local:/apps/agora/files/

And then pass /apps/agora/files into our container for Agora to serve.

[yzernik]

It looks like each app gets its own APP_DATA_DIR that you have full permission to use from your app.

For example, my app I use it like this:
https://github.com/getumbrel/umbrel/blob/cfad63d8a4f63dda79b180932369ad3fcb0cd406/apps/squeaknode/docker-compose.yml#L12

[casey]

It looks like each app gets its own APP_DATA_DIR that you have full permission to use from your app.

Nice! Can users SSH into their Umbrel nodes? And if they can, where is the APP_DATA_DIR of a particular app from their perspective?

[yzernik]

This is just an example of mine:

yzernik@yzernik-MacBookPro:~$ ssh [email protected]
[email protected]'s password: 
Linux umbrel 5.10.52-v8+ #1441 SMP PREEMPT Tue Aug 3 18:14:03 BST 2021 aarch64

The programs included with the Debian GNU/Linux system are free software;
the exact distribution terms for each program are described in the
individual files in /usr/share/doc/*/copyright.

Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
permitted by applicable law.
Last login: Sat Oct 16 07:22:41 2021 from 192.168.86.21
umbrel@umbrel:~ $ ls umbrel/app-data/squeaknode/sqk/
data
umbrel@umbrel:~ $

[casey]

Awesome, that's perfect. We can have users rsync/sftp/scp files to app-data/agora/files, in order to make them available on their Agora instance.

[yzernik]

Yeah, I think that would work.

[casey]

@neunenak and I started working on this, but we couldn't get umbrel-dev working on either his Linux box[0] or my Mac laptop[1], so this is currently blocked on having a working development environment. Someone else could definitely tackle this. The Umbrel dockerfile will probably be only useful for running Agora in Umbrel, so it should be added as umbrel/Dockerfile.

[0] getumbrel/umbrel-dev#25
[1] getumbrel/umbrel-dev#4

[yzernik]

@casey I also was unable to get umbrel-dev working. So I did all of my testing directly on my raspberry pi.

[casey]

@yzernik I'm getting a Bitcoin Machine soon, so unless someone picks this up before then, I'll plan to develop with that.

[yzernik]

I have an open PR to add Agora to the Umbrel App Store: getumbrel/umbrel#1282

If you want to test the PR on your own Umbrel, try:

ssh [email protected]
cd umbrel
sudo scripts/update/update --repo yzernik/umbrel#add_agora_app
scripts/app install agora

Then copy files to sell into ~/umbrel/app-data/agora/files

Then go to http://umbrel.local:12080/

[casey]

Nice! I should have an Umbrel node to test on soon.

[yzernik]

getumbrel/umbrel#1343

[casey]

@yzernik Awesome!