Getting started
Cosmian KMS may be installed on a variety of platforms, including Docker, Ubuntu, RHEL, MacOS, and Windows.
It is also available on the major cloud providers marketplaces, prepackaged to run confidentially in a Cosmian VM. Please check this page for more information.
When installed using the options below, the KMS server will be automatically configured to run using an SQLite database. If you wish to change the database configuration, please refer to the database guide.
For high availability and scalability, please refer to the high availability guide.
Cosmian CLI
The Cosmian CLI lets you interact with the KMS from the command line. Install it from Cosmian CLI and configure it.
Run the container as follows:
The KMS will be available on http://localhost:9998, and the server will store its data inside the
container in the /root/cosmian-kms/sqlite-data directory.
FIPS version is also available:
To persist data between restarts, map the /root/cosmian-kms/sqlite-data path to a filesystem
directory or a Docker volume, e.g. with a volume named cosmian-kms:
Download package and install it:
sudo apt update && sudo apt install -y wget
wget https://package.cosmian.com/kms/4.22.1/ubuntu-20.04/cosmian-kms-server_4.22.1-1_amd64.deb
sudo apt install ./cosmian-kms-server_4.22.1-1_amd64.deb
cosmian_kms --version
Or install the FIPS version:
wget https://package.cosmian.com/kms/4.22.1/ubuntu-20.04/cosmian-kms-server-fips_4.22.1-1_amd64.deb
sudo apt install ./cosmian-kms-server-fips_4.22.1-1_amd64.deb
cosmian_kms --version
A cosmian_kms service will be configured; the service file is located at /etc/systemd/system/cosmian_kms.service.
The server will use a configuration file located at /etc/cosmian_kms/kms.toml.
To start the KMS, run:
Download package and install it:
sudo apt update && sudo apt install -y wget
wget https://package.cosmian.com/kms/4.22.1/ubuntu-22.04/cosmian-kms-server_4.22.1-1_amd64.deb
sudo apt install ./cosmian-kms-server_4.22.1-1_amd64.deb
cosmian_kms --version
Or install the FIPS version:
wget https://package.cosmian.com/kms/4.22.1/ubuntu-22.04/cosmian-kms-server-fips_4.22.1-1_amd64.deb
sudo apt install ./cosmian-kms-server-fips_4.22.1-1_amd64.deb
cosmian_kms --version
A cosmian_kms service will be configured; the service file is located at /etc/systemd/system/cosmian_kms.service.
The server will use a configuration file located at /etc/cosmian_kms/kms.toml.
To start the KMS, run:
Download package and install it:
sudo apt update && sudo apt install -y wget
wget https://package.cosmian.com/kms/4.22.1/ubuntu-24.04/cosmian-kms-server_4.22.1-1_amd64.deb
sudo apt install ./cosmian-kms-server_4.22.1-1_amd64.deb
cosmian_kms --version
Or install the FIPS version:
wget https://package.cosmian.com/kms/4.22.1/ubuntu-24.04/cosmian-kms-server-fips_4.22.1-1_amd64.deb
sudo apt install ./cosmian-kms-server-fips_4.22.1-1_amd64.deb
cosmian_kms --version
A cosmian_kms service will be configured; the service file is located at /etc/systemd/system/cosmian_kms.service.
The server will use a configuration file located at /etc/cosmian_kms/kms.toml.
To start the KMS, run:
Download package and install it:
On ARM MacOS, download the build archive and extract it:
wget https://package.cosmian.com/kms/4.22.1/macos_arm-release.zip
unzip macos_arm-release.zip
cp ./macos_arm-release/Users/runner/work/kms/kms/target/aarch64-apple-darwin/release/cosmian_kms /usr/local/bin/
chmod u+x /usr/local/bin/cosmian_kms
cosmian_kms --version
On Intel MacOS, download the build archive and extract it: