Skip to content

Commit f9962e6

Browse files
emmaling27Convex, Inc.
authored andcommitted
release 161e326 (#34708)
GitOrigin-RevId: 0c3035c92cbb6ea7ebd7e63127f4edc09c199df1
1 parent cacbe5b commit f9962e6

File tree

5 files changed

+31
-5
lines changed

5 files changed

+31
-5
lines changed

self-hosted/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Different versions are not guaranteed to be compatible with one another.
1010
Follow the instructions in the [README](README.md#software-upgrades) to upgrade
1111
your self-hosted backend and dashboard.
1212

13+
## 2025-02-26 `161e32648a971fb8ef591e61212f7b9fb7ff4f2c`
14+
15+
- Add support for S3 storage for exports, snapshots, modules, files, and search
16+
indexes. Read more on how to set up S3 storage
17+
[here](README.md#using-s3-storage).
18+
1319
## 2025-02-24 `fff8e431b95f4d9fde899ce348f8e8f23210aad3`
1420

1521
- Support streaming import. Read more on how to set up streaming import

self-hosted/README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,9 @@ that you'll need to set up persistent storage on whatever cloud hosting platform
8484
you choose to run the Docker container on (e.g. AWS EBS). By default the
8585
database is stored locally in SQLite but you may also point it to a SQL database
8686
either locally or on a cloud service of your choice following
87-
[these instructions](#running-the-database-on-postgres-or-mysql).
87+
[these instructions](#running-the-database-on-postgres-or-mysql). You can also
88+
configure the backend to use S3 storage for exports, snapshots, modules, files,
89+
and search indexes following [these instructions](#using-s3-storage).
8890

8991
You should now be able to use the self-hosted backend. Read on for alternative
9092
hosting options for production workloads.
@@ -253,6 +255,24 @@ export MYSQL_URL=mysql://<your-username>:<your-password>@aws.connect.psdb.cloud
253255
docker compose up
254256
```
255257

258+
## Using S3 Storage
259+
260+
To run the backend with S3 storage, set up the following buckets and environment
261+
variables.
262+
263+
```sh
264+
export AWS_REGION="your-region"
265+
export AWS_ACCESS_KEY_ID="your-access-key-id"
266+
export AWS_SECRET_ACCESS_KEY="your-secret-access-key"
267+
export S3_STORAGE_EXPORTS_BUCKET="convex-snapshot-exports"
268+
export S3_STORAGE_SNAPSHOT_IMPORTS_BUCKET="convex-snapshot-imports"
269+
export S3_STORAGE_MODULES_BUCKET="convex-modules"
270+
export S3_STORAGE_FILES_BUCKET="convex-user-files"
271+
export S3_STORAGE_SEARCH_BUCKET="convex-search-indexes"
272+
```
273+
274+
Then run the backend!
275+
256276
## Optional configurations
257277

258278
- The cloud-hosted product automatically redacts logs to prevent any leaking of

self-hosted/docker/docker-compose.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
services:
22
backend:
3-
image: ghcr.io/get-convex/convex-backend:fff8e431b95f4d9fde899ce348f8e8f23210aad3
3+
image: ghcr.io/get-convex/convex-backend:161e32648a971fb8ef591e61212f7b9fb7ff4f2c
44
ports:
55
- "${PORT:-3210}:3210"
66
- "${SITE_PROXY_PORT:-3211}:3211"
@@ -37,7 +37,7 @@ services:
3737
start_period: 10s
3838

3939
dashboard:
40-
image: ghcr.io/get-convex/convex-dashboard:fff8e431b95f4d9fde899ce348f8e8f23210aad3
40+
image: ghcr.io/get-convex/convex-dashboard:161e32648a971fb8ef591e61212f7b9fb7ff4f2c
4141
ports:
4242
- "${DASHBOARD_PORT:-6791}:6791"
4343
environment:

self-hosted/fly/backend/fly.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ app = 'convex-backend'
77
primary_region = 'iad'
88

99
[build]
10-
image = 'ghcr.io/get-convex/convex-backend:fff8e431b95f4d9fde899ce348f8e8f23210aad3'
10+
image = 'ghcr.io/get-convex/convex-backend:161e32648a971fb8ef591e61212f7b9fb7ff4f2c'
1111

1212
[env]
1313
TMPDIR = '/convex/data/tmp'

self-hosted/fly/dashboard/fly.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ app = 'convex-dashboard'
77
primary_region = 'iad'
88

99
[build]
10-
image = 'ghcr.io/get-convex/convex-dashboard:fff8e431b95f4d9fde899ce348f8e8f23210aad3'
10+
image = 'ghcr.io/get-convex/convex-dashboard:161e32648a971fb8ef591e61212f7b9fb7ff4f2c'
1111

1212
[[services]]
1313
protocol = 'tcp'

0 commit comments

Comments
 (0)