🏰 dashboard

Dashboard is the web-based user interface of [Citadel] and is accessible at http://umbrel.local. It runs by-default as a containerized service.

⚠️ Outdated information

The information below might be outdated and / or refering to Umbrel. This project is not yet fully off it's Umbrel roots.

🚀 Getting started

TBD

🛠 Running dashboard

Make sure both citadel-manager and umbrel-middleware are running and available.

Step 1. Install dependencies

yarn

Step 2. Set environment variables

The following environment variables are set in .env file of the project's root:

Variable	Description	Default
VUE_APP_MANAGER_API_URL	URL of umbrel-manager API	http://localhost:3006
VUE_APP_MIDDLEWARE_API_URL	URL of umbrel-middleware API	http://localhost:3005

If you want to change the local development environment (e.g. to use your local Umbrel instance), create the .env.development with the following content:

VUE_APP_MIDDLEWARE_API_URL=http://umbrel.local/api
VUE_APP_MANAGER_API_URL=http://umbrel.local/manager-api

Step 3. Run dashboard

yarn serve

Dashboard should now be accessible at http://localhost:8080.

Building dashboard

To build dashboard for production, run:

yarn build

Built code will be inside /dist.

---

⚡️ Don't be too reckless

Cidadel 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!

📜 License

⚠️ This information is refering Citadel's Umbrel basis, it is migrating off Umbrel to AGPL.

Umbrel (and Umbrel Dashboard) is licensed under the PolyForm Noncommercial 1.0.0 license. [...]