Install Readyset
These guides walk you through the process for downloading, configuring, and running Readyset using Docker or using Linux binary distribution packages. For production workloads, we recommend using the Linux binary.
Database Requirements
For Readyset to work properly, the following database settings are required:
- Logical replication must be turned on in your database
- 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 Type | Versions | Support Level |
|---|---|---|
| PostgreSQL | 13.0+ | GA |
| MySQL | 8.0+ | GA |
Supported Hosting Providers
| Hosting Provider | Support Level |
|---|---|
| Self-hosted | GA |
| AWS RDS | GA |
| AWS Aurora | GA |
| Azure SQL Database | Alpha |
| GCP SQL | Alpha |
| Supabase | Alpha |
| Aiven for MySQL | Alpha |
GA support conveys that Readyset has reached General Availability and is fully supported in those contexts.
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.