Skip to content

Instantly share code, notes, and snippets.

@AaronDewes

AaronDewes/citadel.md

Created August 19, 2021 20:58
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save AaronDewes/0e607de2a678811fdaf09d3feb6350a2 to your computer and use it in GitHub Desktop.
Save AaronDewes/0e607de2a678811fdaf09d3feb6350a2 to your computer and use it in GitHub Desktop.
Download ZIP
Details about Citadel
Raw
citadel.md

Citadel - Umbrel evolved

Citadel takes your Umbrel node to the next level with new features, more speed, easier backups, and many more things.

You can move between Umbrel and Citadel at any time, in both directions using our migration tool.

What does Citadel provide?

Citadel is a fork of Umbrel with the goal of giving you early access to new features we're also contributing to the Umbrel team.

Citadel also implements a completely separate server for your automated backups which implements restore capabilities and is fully open source and you can host a personal one for free.

How fast will new features be added?

New features from Citadel developers are typically added faster than in Umbrel. Features we develop will be contributed to Umbrel and need to be tested and reviewed by them first. New features from the Umbrel team will typically be merged within one week of the Umbrel release introducing them. New features inside apps are often in Citadel faster because Citadel provides updates more often.

What about the license?

Citadel consists of many components with different licenses:

  • Citadel Core: The core node manager. This is currently a fork of Umbrel, and licensed under the PolyForm Noncommercial License 1.0.0, but we're working on recreating this part as fully free software

  • Citadel OS for Raspberry Pi: this is a fork of Umbrel OS and is licensed under the Apache 2.0 license

  • Citadel OS Bullseye: This new version of Citadel OS for multiple platforms will replace Citadel OS for the Raspberry Pi and will use the AGPL 3.0 license

  • Citadel Manager: This is the connection between Citadel Core and Citadel dashboard - A docker container which communicates with Citadel Core by reading and writing files, and exposes an API to the dashboard. This will use the MIT license.

  • Citadel Middleware: This is the bridge between Bitcoind, LND and the dashboard, which exposes the APIs provided by these services in a simpler way to the dashboard. This will use the MIT license.

  • Citadel dashboard: A fork of Umbrel's dashboard with new features. This will use the PolyForm Noncommercial License 1.0.0.

  • Citadel backup server: An open source server which stores your backups on Firebase. This will be licensed under the AGPL 3.0. This component will not run on your node, but will be hosted by Citadel to store encrypted backups of your Lightning channels for easy recovery in case of hardware failure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment