Install Readyset Cache
These guides walk you through the process for downloading, configuring, and running Readyset Cache using Docker or using Linux binary distribution packages. For production workloads, we recommend using the Linux binary.
Database Requirements
For deep caching, Readyset Cache snapshots and replicates your tables, which requires the following database settings:
- Logical replication must be turned on in your database
- Readyset Cache 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.
Shallow caching is TTL-based and served without snapshotting or replication, so it does not require these settings. See Shallow Caching for details.
Supported Database Versions
| Database Type | Versions | Support Level |
|---|---|---|
| PostgreSQL | 13.0+ | GA |
| MySQL | 8.0+ | GA |
GA support conveys that Readyset Cache has reached General Availability and is fully supported in those contexts.
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 |
Beta support conveys that Readyset Cache is routinely tested in those contexts.
Alpha support conveys that Readyset Cache 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 or open a Github issue. We will help you troubleshoot.