You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Mayank Chhabra a3c6efa7fe
Merge pull request #20 from mayankchhabra/repo
5 years ago
.github/workflows Add apt-get update 5 years ago
export-image Umbrel box 5 years ago
export-noobs Umbrel box 5 years ago
scripts Umbrel box 5 years ago
stage0 Umbrel box 5 years ago
stage1 Umbrel box 5 years ago
stage2 repo name update 5 years ago
.gitignore Umbrel box 5 years ago
CODE_OF_CONDUCT.md Add Code of conduct into the Repo 5 years ago
CONTRIBUTING.md correct urls, and signed 5 years ago
LICENSE Initial commit 5 years ago
README.md correct urls, and signed 5 years ago
build.sh Umbrel box 5 years ago
config Update config 5 years ago
depends Umbrel box 5 years ago

README.md

Umbrel Box Base Operating system

Run Release Script on push to MASTER

Customized Underlying Raspbian Operating System for the Umbrel box (based on https://github.com/RPi-Distro/pi-gen)

Config/Build instructions

  1. Run sudo ./build.sh
  2. Look in deploy/
  3. Use etcher to deploy

Alternatively, you may check the latest release too and you may find the image built automatically by github (upon tagging).

Default logins

Hostname: umbrel.local Username: umbrel Password: umbr3lb0x

You may also find them here

Config variables

In the config file there are system defaults, which are used when building the image and for automated builds.

  • GITHUB_USERNAME - Used if you want to automatically log in to the box without typing a password. This is used at build time.

Then theres other raspbian stuff, that you may find in the Raspbian documentation which will still work.

Post bootup checks

For building an API (or scripting), look in /home/umbrel/statuses for the following files

  • disk-partitioned : meaning the disk is partitioned
  • service-configured : meaning the umbrel system bootup service is configured and running.

(To add more later as needed)

Console Commands (Cheat codes)

There is some console commands you can run.

Lightning Console Commands

Get Info

docker exec -it "${USER}_lnd_1" lncli getinfo

Wallet Balance

docker exec -it "${USER}_lnd_1" lncli walletbalance

List Channels

docker exec -it "${USER}_lnd_1" lncli listchannels

Opening a channel

# where XXX = sats per byte and YYY = the amount
docker exec -it "${USER}_lnd_1" lncli connect pubkey@host:port
docker exec -it "${USER}_lnd_1" lncli open --sat_per_byte=XXX pubkey YYY
# Return value is the txid

TODO:

See the following list