Install ReadySet System Packages
ReadySet can be installed as a stand-alone
systemd service using a Linux
distribution package. We currently only produce a
deb package for the
x86_64/amd64 architecture which installs on Debian-based systems running
OpenSSL 3 (i.e. Ubuntu 22.04, Debian 12).
To install the package:
- Download the
Assetson our GitHub release page (opens in a new tab).
- Install the package using
sudo dpkg -i <PACKAGE_NAME>
The ReadySet service must be configured to connect to an upstream database
before it can be started. Edit the default
installed by the package and update the
UPSTREAM_DB_URL to point to the
database. Additional configuration variables are documented in
as well as on the CLI
For directions on how to check and alter these configurations, please see our database reference documentation. The steps to configure these settings vary by database type and hosting provider.
readyset.conf has been updated, the service can be controlled with
systemctl (opens in a new tab). For example,
sudo systemctl start readysetto start the service
sudo systemctl stop readysetto stop the service
readyset.conf file configures service logging to go to the
/var/lib/readyset directory, but that can be changed using the
setting. If logging to
journalctl is desired instead, comment out
To uninstall, use
sudo apt remove readyset. This will uninstall the service
and executable, but will leave the
file. To remove all
readyset files entirely, use
sudo apt purge readyset.