The one-stop guide to getting Citadel up and running on your own Cubit. If you want to print your own case you can find the files in the print_files
directory.
This guide will cover how to install Citadel on two Cubit configurations:
- Recommended: OS on the NVMe drive, data on the RAID1 (server enthusiast edition and sovereign individual edition)
- All on the NVMe drive (bitcoiner edition)
In order to use Cubit, you need SSH installed on your primary machine, being it a desktop or laptop. Linux and MacOS have it pre-installed; if you use Windows you will have to install it.
Here is a tutorial (Windows): https://youtu.be/g2I6en4Mdjo?feature=shared
- Download
ubuntu server 22.04 LTS
from the official website here: https://ubuntu.com/download/server - Flash it on your USB drive, using an App like Balena Etcher: https://etcher.balena.io/
- Safely remove the USB drive, plug it into Cubit, and power-on
- Repetetly press the
Del
key to enter the BIOS - Use the arrow keys to go to the
Boot
tab and make sure the USB is the first option (highest priority)
Extra: From the BIOS you can configure the speed of the fan (if it's PWM compatible)
- Go through with the installation wizard. Select the default choice in all steps except those indicated below
- When you arrive at the storage configuration, select
Custom Storage
and copy the following configuration you see in the image (the NVMe is the boot drive, mounted at/
; The two SATA drives are neither formatted nor mounted)
- Install OpenSSH
- After the installation, power up your Cubit and plug in the ethernet cable
- Get the
ip_address
of your Cubit, using an App like Angry IP Scanner: https://angryip.org/ - Open the terminal (or prompt in Windows), and SSH into your Cubit with the command
ssh [username]@ip_address
, using theusername
andpassword
you specified during the installation
Copy the following commands in the terminal of your Cubit
- Configure the RAID:
sudo mdadm --create --verbose /dev/md0 --level=1 --raid-devices=2 /dev/sda /dev/sdb
- Install Docker:
curl -fsSL https://get.docker.com | sh
- Install Citadel dependencies:
sudo apt -y install fswatch jq rsync curl python3-requests python3-yaml git
- Download Citadel:
git clone https://gitlab.com/nirvati/citadel/lts/core.git ~/citadel
- Install Citadel:
sudo ~/citadel/scripts/citadel-os/cubit/install
- Create directories:
mkdir -p /home/cubit/citadel/app-data/bitcoin && mkdir -p /home/cubit/citadel/app-data/electrs
- Reboot:
sudo reboot
- Wait 5 min, then SSH again into Cubit
- Test if the storage configuration works with
sudo systemctl status citadel-external-storage
If it showsactive
everything should work. If you now runlsblk
you should see something like this
- Wait up to 10 min
- On any device that's connected to the home network, type Cubit's
ip_address
in a browser and start using Citadel!
Note: After one reboot, your Ubuntu password will be the same as the password you entered on Citadel
- Go through with the installation wizard. Select the default choice in all steps except those indicated below.
- When you arrive at the storage configuration, select
Custom Storage
and copy the following configuration you see in the image (the NVMe is the boot drive, mounted at/
)
- Install OpenSSH
- After the installation, power up your Cubit and plug in the ethernet cable
- Get the
ip_address
of your Cubit, using an App like Angry IP Scanner: https://angryip.org/ - Open the terminal (or prompt in Windows), and SSH into your Cubit with the command
ssh [username]@ip_address
, using theusername
andpassword
you specified during the installation
Copy the following commands in the terminal of your Cubit
- Install Docker:
curl -fsSL https://get.docker.com | sh
- Install Citadel dependencies:
sudo apt -y install fswatch jq rsync curl python3-requests python3-yaml git
- Download Citadel:
git clone https://gitlab.com/nirvati/citadel/lts/core.git ~/citadel
- Install Citadel:
sudo ~/citadel/scripts/citadel-os/cubit/install
- Reboot:
sudo reboot
- Wait 5 min, then SSH again into Cubit
- Test if configuration works with
sudo systemctl status citadel-startup
If it showsactive
everything should work.
- Wait up to 10 min
- On any device that's connected to the home network, type Cubit's
ip_address
in a browser and start using Citadel!
Note: After one reboot, your Ubuntu password will be the same as the password you entered on Citadel