Skip to content

Commit 8ea634b

Browse files
committed
add large payloads section
1 parent 86f3b36 commit 8ea634b

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/open-source-self-hosting.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,25 @@ echo "FORCE_CHECKPOINT_SIMULATION=0" >> .env
289289
./stop.sh worker && ./start.sh worker
290290
```
291291

292+
## Large payloads
293+
294+
By default, payloads over 512KB will be offloaded to S3-compatible storage. If you don't provide the required env vars, runs with payloads larger than this will fail.
295+
296+
For example, using Cloudflare R2:
297+
298+
```bash
299+
OBJECT_STORE_BASE_URL="https://<bucket>.<account>.r2.cloudflarestorage.com"
300+
OBJECT_STORE_ACCESS_KEY_ID="<r2 access key with read/write access to bucket>"
301+
OBJECT_STORE_SECRET_ACCESS_KEY="<r2 secret key>"
302+
```
303+
304+
Alternatively, you can increase the threshold:
305+
306+
```bash
307+
# size in bytes, example with 5MB threshold
308+
TASK_PAYLOAD_OFFLOAD_THRESHOLD=5242880
309+
```
310+
292311
## Updating
293312

294313
Once you have everything set up, you will periodically want to update your Docker images. You can easily do this by running the update script and restarting your services:

0 commit comments

Comments
 (0)