Installation
Binary Packages
Getting started with Cascade is really easy by installing a binary package for either Debian and Ubuntu or for Red Hat Enterprise Linux (RHEL) and compatible systems such as Rocky Linux. Alternatively, you can run with Docker.
You can also build Cascade from the source code using Cargo, Rust’s build system and package manager. Cargo lets you to run Cascade on almost any operating system and CPU architecture. Refer to the Building From Source section to get started.
To install a Cascade package, you need the 64-bit version of one of these Debian versions:
Debian Trixie 13
Debian Bookworm 12
Debian Bullseye 11
Packages for the amd64/x86_64 architecture are available for
all listed versions. In addition, we offer armhf architecture
packages for Debian/Raspbian Bullseye, and arm64 for Buster.
First update the apt package index:
sudo apt update
Then install packages to allow apt to use a repository over HTTPS:
sudo apt install \
ca-certificates \
curl \
gnupg \
lsb-release
Add the GPG key from NLnet Labs:
curl -fsSL https://packages.nlnetlabs.nl/aptkey.asc | sudo gpg --dearmor -o /etc/apt/keyrings/nlnetlabs-archive-keyring.gpg
Now, use the following command to set up the main repository:
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/nlnetlabs-archive-keyring.gpg] https://packages.nlnetlabs.nl/linux/debian \
$(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/nlnetlabs.list > /dev/null
Update the apt package index once more:
sudo apt update
You can now install Cascade with:
sudo apt install cascade
Then you can start Cascade with:
sudo systemctl start cascaded
You can also configure Cascade to start at boot:
sudo systemctl enable cascaded
You can check the status of Cascade with:
sudo systemctl status cascaded
You can view the logs with:
sudo journalctl --unit=cascaded
To install a Cascade package, you need the 64-bit version of one of these Ubuntu versions:
Ubuntu Noble 24.04 (LTS)
Ubuntu Jammy 22.04 (LTS)
Ubuntu Focal 20.04 (LTS)
Packages are available for the amd64/x86_64 architecture only.
First update the apt package index:
sudo apt update
Then install packages to allow apt to use a repository over HTTPS:
sudo apt install \
ca-certificates \
curl \
gnupg \
lsb-release
Add the GPG key from NLnet Labs:
curl -fsSL https://packages.nlnetlabs.nl/aptkey.asc | sudo gpg --dearmor -o /etc/apt/keyrings/nlnetlabs-archive-keyring.gpg
Now, use the following command to set up the main repository:
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/nlnetlabs-archive-keyring.gpg] https://packages.nlnetlabs.nl/linux/ubuntu \
$(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/nlnetlabs.list > /dev/null
Update the apt package index once more:
sudo apt update
You can now install Cascade with:
sudo apt install cascade
If you want to use a PKCS#11-based HSM, also install the KMIP to PKCS#11 relay with:
sudo apt install kmip2pkcs11
Then you can start Cascade with:
sudo systemctl start cascaded
You can also configure Cascade to start at boot:
sudo systemctl enable cascaded
You can check the status of Cascade with:
sudo systemctl status cascaded
You can view the logs with:
sudo journalctl --unit=cascaded
To install a Cascade package, you need Red Hat Enterprise Linux
(RHEL) 8 or 9, or compatible operating system such as Rocky Linux.
Packages are available for the amd64/x86_64 architecture only.
First create a file named /etc/yum.repos.d/nlnetlabs.repo,
enter this configuration and save it:
[nlnetlabs]
name=NLnet Labs
baseurl=https://packages.nlnetlabs.nl/linux/centos/$releasever/main/$basearch
enabled=1
Add the GPG key from NLnet Labs:
sudo rpm --import https://packages.nlnetlabs.nl/aptkey.asc
You can now install Cascade with:
sudo yum install -y cascade
If you want to use a PKCS#11-based HSM, also install the KMIP to PKCS#11 relay with:
sudo yum install -y kmip2pkcs11
Then you can start Cascade with:
sudo systemctl start cascaded
You can also configure Cascade to start at boot:
sudo systemctl enable cascaded
You can check the status of Cascade with:
sudo systemctl status cascaded
You can view the logs with:
sudo journalctl --unit=cascaded
Cascade Docker images are built with Alpine Linux. The supported
CPU architectures are shown on the Docker Hub Cascade page per Cascade
version (aka Docker “tag”) in the OS/ARCH column.
To run Cascade as a background daemon with the default settings can be done like so:
sudo docker run -d --restart=unless-stopped --name cascade
[TODO]
Updating
To update an existing Cascade installation, first update the repository using:
sudo apt update
You can use this command to get an overview of the available versions:
sudo apt policy cascade
You can upgrade an existing Cascade installation to the latest version using:
sudo apt --only-upgrade install cascade
To update an existing Cascade installation, first update the repository using:
sudo apt update
You can use this command to get an overview of the available versions:
sudo apt policy cascade
You can upgrade an existing Cascade installation to the latest version using:
sudo apt --only-upgrade install cascade
To update an existing Cascade installation, you can use this command to get an overview of the available versions:
sudo yum list --showduplicates cascade
You can update to the latest version using:
sudo yum update -y cascade
Assuming that you run Docker with image nlnetlabs/cascade, upgrading to the latest version can be done by running the following commands:
sudo docker pull nlnetlabs/cascade
sudo docker rm --force cascade
sudo docker run <your usual arguments> nlnetlabs/cascade
Installing Specific Versions
Before every new release of Cascade, one or more release candidates are provided for testing through every installation method. You can also install a specific version, if needed.
If you would like to try out release candidates of Cascade you can add the proposed repository to the existing main repository described earlier.
Assuming you already have followed the steps to install regular releases, run this command to add the additional repository:
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/nlnetlabs-archive-keyring.gpg] https://packages.nlnetlabs.nl/linux/debian \
$(lsb_release -cs)-proposed main" | sudo tee /etc/apt/sources.list.d/nlnetlabs-proposed.list > /dev/null
Make sure to update the apt package index:
sudo apt update
You can now use this command to get an overview of the available versions:
sudo apt policy cascade
You can install a specific version using <package name>=<version>,
e.g.:
sudo apt install Cascade=0.1.0~rc1-1bookworm
If you would like to try out release candidates of Cascade you can add the proposed repository to the existing main repository described earlier.
Assuming you already have followed the steps to install regular releases, run this command to add the additional repository:
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/nlnetlabs-archive-keyring.gpg] https://packages.nlnetlabs.nl/linux/ubuntu \
$(lsb_release -cs)-proposed main" | sudo tee /etc/apt/sources.list.d/nlnetlabs-proposed.list > /dev/null
Make sure to update the apt package index:
sudo apt update
You can now use this command to get an overview of the available versions:
sudo apt policy Cascade
You can install a specific version using <package name>=<version>,
e.g.:
sudo apt install cascade=0.1.0~rc1-1jammy
To install release candidates of Cascade, create an additional repo
file named /etc/yum.repos.d/nlnetlabs-testing.repo, enter this
configuration and save it:
[nlnetlabs-testing]
name=NLnet Labs Testing
baseurl=https://packages.nlnetlabs.nl/linux/centos/$releasever/proposed/$basearch
enabled=1
You can use this command to get an overview of the available versions:
sudo yum list --showduplicates cascade
You can install a specific version using
<package name>-<version info>, e.g.:
sudo yum install -y cascade-0.1.0~rc1
All release versions of Cascade, as well as release candidates and builds based on the latest main branch are available on Docker Hub.
For example, installing Cascade 0.1.0 RC1 is as simple as:
sudo docker run <your usual arguments> nlnetlabs/cascade:v0.1.0-rc1