orb
orb copied to clipboard
Orb is a cross-platform (Mac / Windows / OSX / IOS / Android) application for managing an LND / CLN Lightning node. It features bulk payments, an editor, API, App Store, node automation engines and a...
โก๐ฎ is now Free & Open Source
๐คWe're pleased to announce that Orb is now fully free ๐ธ and open source๐ under the GNU GENERAL PUBLIC LICENSE.๐พ๐๐ฅ
Downloading the Desktop builds โฌ๏ธ
Windows and OSX binary builds can be found in the repo's releases page. Please install on your ๐ป๐ฑ not your node.
Downloading the Mobile builds โฌ๏ธ
Android
Android users please download the latest APK in the releases page. The Google Play listing is probably out of date.
IOS
You can get Orb IOS using TestFlight (Please consider donating to our Apple dev license fund).
Running Orb from source ๐
If you have Python3 & git on a unix-like device:
git clone https://github.com/lightningorb/orb.git
cd orb
pip3 install -r requirements.txt
python3 main.py
With venv
Consider installing Orb's dependencies in a virtual ๐ฆ to keep things clean:
git clone https://github.com/lightningorb/orb.git
cd orb
python3 -m venv venv
. venv/bin/activate
pip3 install -r requirements.txt
python3 main.py
Don't trust: verify๐ต๏ธ
It's prudent to ๐ code before running it on a mainnet node:
- Fork the repo
- Enable actions for your fork
- Create a new branch called 'build_multi'
- ๐ฌ the code whilst it's building
- โฌ๏ธ your build from your fork's 'releases' page
Documentation
๐คEvery inch ๐ of ๐ฎ is documented: Read the docs.
Call to action๐ช
Non-devs
Do you believe in โฟ and โก and want to help? ๐ Then pick any one of these at random:
- Bookmark ๐ this repo.
- Use Orb.
- โญ this repo.
- Tweet / Note about trying out ๐ฎ.
- Write a blog post.
- Create Youtube ๐ฎ tutorial.
- Find bugs & Log issues.
- Triage issues.
- Contribute to the docs.
Devs
- โก๏ธ Fork โก๏ธ Use โก๏ธ PR ๐