Skip to content

Commit 846e589

Browse files
nipunn1313Convex, Inc.
authored and
Convex, Inc.
committed
Update the self-host documentation to make the defaults clear (#35927)
Small wording change - to make sqlite/local file storage defaults clear. GitOrigin-RevId: 5e539fa8198431186d70ea8562de736a1daff090
1 parent f65219d commit 846e589

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

self-hosted/README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -243,13 +243,14 @@ npx convex dev
243243

244244
## Running the database on Postgres or MySQL
245245

246-
The Convex backend is designed to work well with SQLite, Postgres, or MySQL. If
247-
you're running a production workload that requires guaranteed uptime it's likely
248-
you want to use a managed Postgres or MySQL service. We've included instructions
249-
below for connecting to a Postgres database hosted on [Neon](https://neon.tech)
250-
or a MySQL (Vitess) database hosted on [PlanetScale](https://planetscale.com).
251-
We've tested that the Convex backend works with Postgres v17 and MySQL v8, but
252-
it's possible it works with other versions.
246+
The Convex backend is designed to work well with SQLite, Postgres, or MySQL. By
247+
default, the docker image uses SQLite. If you're running a production workload
248+
that requires guaranteed uptime it's likely you want to use a managed Postgres
249+
or MySQL service. We've included instructions below for connecting to a Postgres
250+
database hosted on [Neon](https://neon.tech) or a MySQL (Vitess) database hosted
251+
on [PlanetScale](https://planetscale.com). We've tested that the Convex backend
252+
works with Postgres v17 and MySQL v8, but it's possible it works with other
253+
versions.
253254

254255
Use `npx convex export` to export your data before moving from one database
255256
provider to another.
@@ -328,8 +329,9 @@ docker compose up
328329

329330
## Using S3 Storage
330331

331-
To run the backend with S3 storage, set up the following buckets and environment
332-
variables.
332+
By default, the backend stores file data on the filesystem within the docker
333+
container. To instead run the backend with S3 storage, set up the following
334+
buckets and environment variables.
333335

334336
```sh
335337
export AWS_REGION="your-region"

0 commit comments

Comments
 (0)