Skip to content
ricochet

Host

Ricochet Server is distributed as native .deb and .rpm packages and runs as a systemd service. This guide covers manual installation on a single Linux server.

DistributionArchitecturePackage format
Debian / Ubuntuamd64.deb
AlmaLinux / RHEL / ELx86_64.rpm

Ricochet Server packages are published to object storage.

Terminal window
VERSION=$(curl -s https://ricochet.rs/releases.json | grep -o '"latest": *"[^"]*"' | grep -o 'v[0-9.]*')
curl -fLO https://s3.eu-central-003.backblazeb2.com/ricochet-server/${VERSION#v}/ricochet-server_${VERSION#v}-1_amd64.deb
sudo apt install ./ricochet-server_${VERSION#v}-1_amd64.deb

The package installs the ricochet binary and a ricochet-server.service systemd unit.

Ricochet reads its configuration from /var/lib/ricochet/ricochet-config.toml.
Create or edit this file with your deployment’s settings.

At a minimum you need to configure OIDC authentication:

/var/lib/ricochet/ricochet-config.toml
[auth.oidc]
issuer_url = "https://your-idp.example.com/"
client_id = "your-client-id"
client_secret = "your-client-secret"
redirect_url = "https://your-ricochet-host.example.com/oauth/callback"

Ensure appropriate permissions are set on the config file:

Terminal window
sudo chmod 0644 /var/lib/ricochet/ricochet-config.toml
sudo chown root:root /var/lib/ricochet/ricochet-config.toml
  1. Reload systemd to pick up the new unit file:

    Terminal window
    sudo systemctl daemon-reload
  2. Enable and start the service:

    Terminal window
    sudo systemctl enable --now ricochet-server.service
  3. Verify the service is running:

    Terminal window
    sudo systemctl status ricochet-server.service

Ricochet Server listens on port 6188 by default.

The standalone binary can run either as a blocking foreground process or as a daemonized background process.

By default, ricochet start runs in the foreground and prints logs to stdout/stderr:

Terminal window
ricochet start --config /path/to/ricochet-config.toml

The --config flag specifies the path to your ricochet-config.toml. If omitted, ricochet looks for ricochet-config.toml in the current working directory, so it is recommended to always pass --config with an explicit path.

Use --daemon when you want ricochet to keep running after your terminal session ends. This is useful on remote servers where you do not want the process tied to your SSH connection. This is similar to running ricochet through systemd, which is what the .rpm and .deb installers do by default. For production use, the prepackaged installers are recommended over the standalone binary.

Pass --daemon to detach the process and run it in the background:

Terminal window
ricochet start --config /path/to/ricochet-config.toml --daemon

When running as a daemon, ricochet writes the following files under RICOCHET_HOME:

FilePurpose
ricochet.pidProcess ID of the running daemon
ricochet.stdoutStandard output from the process
ricochet.errStandard error from the process

ricochet.stdout and ricochet.err capture raw process output such as startup errors, panics, and anything printed before the logging system initializes. They are separate from the structured log files written by the [logs] configuration. For operational logging, configure [logs] in your ricochet-config.toml. See File Logging for configuration options.

Use ricochet stop to gracefully stop a daemonized process:

Terminal window
ricochet stop --config /path/to/ricochet-config.toml

If you passed a custom --config path to ricochet start, pass the same path to ricochet stop so it can locate the correct ricochet.pid file.

To upgrade to a new version, download the new package and install it over the existing one.

Terminal window
curl -fLO https://s3.eu-central-003.backblazeb2.com/ricochet-server/${VERSION}/ricochet-server_${VERSION}-1_amd64.deb
sudo apt install ./ricochet-server_${VERSION}-1_amd64.deb
sudo systemctl restart ricochet-server.service

Ricochet works without any interpreters installed. However, if you plan to deploy R, Python, or Julia content, you must install the respective interpreters on the host machine. Container and Kubernetes deployments bundle their own interpreters and do not require this step.

The .deb and .rpm packages bundle the following tools so that ricochet can manage language environments without relying on system-installed versions:

ToolVendor pathPurpose
uvRICOCHET_HOME/vendor/py/uvPython package management, running Python content, and Python version discovery
juliaupRICOCHET_HOME/vendor/jl/juliaupManaging Julia environments and Julia version discovery
renvRICOCHET_HOME/vendor/r/renvR package environment restoration

When using the systemd service, RICOCHET_HOME defaults to /var/lib/ricochet/data. See the storage configuration for more details.

If deploying Python-based content, Ricochet will discover Python installations on the host. We encourage installing Python via uv for the best experience managing multiple Python versions.

Terminal window
uv python install <version>

We recommend using rig to install R:

Terminal window
rig add <version>

You can also install R from CRAN or your distribution’s package manager. However, if you want to make use of multiple R versions, rig is the easiest and most flexible option.

If deploying Julia-based content, Ricochet uses juliaup to discover installed Julia channels. Julia must be installed via juliaup. Only juliaup-managed Julia installations are supported.

Terminal window
juliaup add <version>

If you manage your infrastructure with Ansible, the devxy.data_science_core collection provides roles for installing R, Python, and their system dependencies:

Terminal window
ansible-galaxy collection install devxy.data_science_core
roles:
- role: devxy.data_science_core.r
- role: devxy.data_science_core.python

The interpreters may require additional system libraries for compiling packages at runtime.
Here’s a baseline of system libraries which we recommend installing:

Terminal window
sudo apt install \
libgit2-dev libxml2-dev libharfbuzz-dev libfreetype-dev libfontconfig-dev \
libgdal-dev libproj-dev libgeos-dev libjq-dev libmagick++-dev \
libnetcdf-dev libfribidi-dev jags libglpk-dev libpng-dev \
libsecret-1-dev poppler-utils libreadline-dev unixodbc-dev \
default-jdk-headless libicu-dev libudunits2-dev libsodium-dev \
zlib1g-dev libglu1-mesa-dev libcairo2-dev git freetds-common \
libv8-dev librsvg2-dev libsqlite3-dev libpq-dev libgmp3-dev libmpfr-dev
Terminal window
sudo systemctl stop ricochet-server.service
sudo systemctl disable ricochet-server.service
sudo apt purge ricochet-server

The configuration file at /var/lib/ricochet/ricochet-config.toml is not removed automatically. Delete it manually if it is no longer needed.