Compilation and Installation

Below is a guide on how to compile Rosenpass yourself, including via the binary files. This can be used to compile Rosenpass for systems not yet fully supported, such as Debian, and provides a more customised experience.

Compile it yourself

  • You can compile Rosenpass yourself. This gives you the advantage of ensuring that you use Rosenpass as exactly as the source code is in Git.
  1. Install the dependencies. Under Debian, you can do this with the following command:
sudo apt-get --yes install libsodium-dev libclang-dev cmake pkg-config git build-essential
  1. If you want to use Rosenpass with WireGuard, install WireGuard. On Debian, you can do this with the following command:
sudo apt-get --yes install wireguard
  1. Install Rust >= 1.64.0 (as of 2023-07-01). This can be achieved using Rustup, for example.
  2. Clone the Git Repository:
git clone https://github.com/rosenpass/rosenpass.git
  1. Change to the Rosenpass directory:
cd rosenpass
  1. Switch to the version you want to install. Without switching, you will install and compile the dev version. Find the name of the version that you would like to install on the releases page, or find the name of the latest release. Use the following command to switch to version, e.g., 0.2.1:
git checkout v0.2.1
  1. Compile Rosenpass, this may take a while:
cargo build --release
  1. Install Rosenpass:
sudo install target/release/rosenpass /usr/local/bin
  1. If you want the Rosenpass helper:
rp

It can be installed it with:

sudo install rp /usr/local/bin

That’s it! You have now downloaded, compiled, and installed Rosenpass.

Installation via binary files

  • If Rosenpass is not yet available for your distribution, you can attempt to download it manually.
  1. Download the desired version for your operating system from the releases page, or directly jump to the latest version.
  2. Unzip the file. On Linux you can use tar for this:
tar xf rosenpass-x86_64-linux-0.2.1.tar
  1. Install Rosenpass:
sudo install bin/rosenpass /usr/local/bin
  1. If you want the Rosenpass helper:
rp

It can be installed it with:

sudo install bin/rp /usr/local/bin
  1. Delete the downloaded files:
rm -r rosenpass-x86_64-linux-0.1.1.tar bin/

That’s it! You have now downloaded and installed Rosenpass.