Luke Childs
db736e756a
|
4 years ago | |
---|---|---|
.github/workflows | 4 years ago | |
bin | 5 years ago | |
logic | 4 years ago | |
middlewares | 4 years ago | |
models | 5 years ago | |
resources | 5 years ago | |
routes | 4 years ago | |
services | 4 years ago | |
test | 5 years ago | |
utils | 4 years ago | |
.babelrc | 5 years ago | |
.dockerignore | 4 years ago | |
.eslintignore | 5 years ago | |
.eslintrc | 5 years ago | |
.gitignore | 4 years ago | |
Dockerfile | 4 years ago | |
LICENSE | 4 years ago | |
README.md | 4 years ago | |
app.js | 4 years ago | |
package.json | 4 years ago | |
yarn.lock | 4 years ago |
README.md
☂️ manager
Manager runs by-default on Umbrel OS as a containerized service. It provides a low-level system API that handles:
- User authentication using JWT
- Encryption/decryption of sensitive information, such as the lightning wallet's seed
- CRUD operations
- Lifecycle-management of all other containerized services
🚀 Getting started
If you are looking to run Umbrel on your hardware, you do not need to run this service on it's own. Just download Umbrel OS and you're good to go.
🛠 Running manager
Step 1. Install dependencies
yarn
Step 2. Set environment variables
Set the following environment variables directly or by placing them in .env
file of project's root.
Variable | Description | Default |
---|---|---|
PORT |
Port where manager should listen for requests | 3006 |
DEVICE_HOST |
IP or domain from where umbrel-dashboard will request |
http://umbrel.local |
USER_FILE |
Path to the user's data file (automatically created on user registration) | /db/user.json |
SHUTDOWN_SIGNAL_FILE |
Path to write a file to signal a system shutdown | /signals/shutdown |
REBOOT_SIGNAL_FILE |
Path to write a file to signal a system reboot | /signals/reboot |
MIDDLEWARE_API_URL |
IP or domain where umbrel-middleware is listening |
http://localhost |
MIDDLEWARE_API_PORT |
Port where umbrel-middleware is listening |
3005 |
JWT_PUBLIC_KEY_FILE |
Path to the JWT public key (automatically created) | /db/jwt-public-key/jwt.pem |
JWT_PRIVATE_KEY_FILE |
Path to the JWT private key (automatically created) | /db/jwt-public-key/jwt.key |
JWT_EXPIRATION |
JWT expiration in miliseconds | 3600 |
DOCKER_COMPOSE_DIRECTORY |
Path to directory containing docker-compose.yml |
/docker-compose |
UMBREL_DASHBOARD_HIDDEN_SERVICE_FILE |
Path to Tor hostname of umbrel-dashboard |
/var/lib/tor/dashboard/hostname |
Step 3. Run manager
yarn start
You can browse through the available API endpoints here.
⚡️ Don't be too reckless
Umbrel is still in an early stage and things are expected to break every now and then. We DO NOT recommend running it on the mainnet with real money just yet, unless you want to be really #reckless.
❤️ Contributing
We welcome and appreciate new contributions!
If you're a developer looking to help but not sure where to begin, check out these issues that have specifically been marked as being friendly to new contributors.
If you're looking for a bigger challenge, before opening a pull request please create an issue or join our community chat to get feedback, discuss the best way to tackle the challenge, and to ensure that there's no duplication of work.
🙏 Acknowledgements
Umbrel Manager is inspired by and built upon the work done by Casa on its open-source Node Manager API.