Step 1 - Install ReadySet

Install ReadySet

These guides walk you through the process for downloading, configuring, and running ReadySet using Docker.

Database Requirements

For ReadySet to work properly, the following database setttings are required:

  1. Logical replication must be turned on in your database
  2. ReadySet must have superuser permissions

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.

Supported Database Versions

Database TypeVersionsSupport Level
PostgreSQL13.0+Beta
MySQL8.0Alpha

Supported Hosting Providers

Hosting ProviderSupport Level
Self-hostedBeta
AWS RDSBeta
AWS AuroraBeta
Azure SQL DatabaseAlpha
GCP SQLAlpha

Beta support conveys that ReadySet is routinely tested in those contexts.

Alpha support conveys that ReadySet has previously been validated to work in those contexts, but we don't actively check for regressions.

Troubleshooting

If you experience any issues, please reach out to us in Slack (opens in a new tab) or open a Github issue (opens in a new tab). We will help you troubleshoot.