danvics/warden-worker
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

docs: update README and wrangler.toml comments

Browse source
This commit is contained in:
qaz741wsd856 2025-12-27 05:37:59 +00:00
parent eaa2f3b652
commit 7f0f6e376c
2 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -138,21 +138,24 @@ If the binding is missing, requests proceed without rate limiting (graceful degr
### Durable Objects (CPU Offloading) ### Durable Objects (CPU Offloading)
Cloudflare Workers Free plan has a very small per-request CPU budget. Two endpoints are particularly CPU-heavy: Cloudflare Workers Free plan has a very small per-request CPU budget. Two kinds of endpoints are particularly CPU-heavy:
- `POST /api/ciphers/import`: large JSON payload (typically 500kB–1MB) + parsing + batch inserts. - import endpoint: large JSON payload (typically 500kB–1MB) + parsing + batch inserts.
- `POST /identity/connect/token`: server-side PBKDF2 for password verification. - registration, login and password verification endpoint: server-side PBKDF2 for password verification.
To keep the main Worker fast while still supporting these operations, Warden can **offload selected endpoints to Durable Objects (DO)**: To keep the main Worker fast while still supporting these operations, Warden can **offload selected endpoints to Durable Objects (DO)**:
- **Heavy DO (`HEAVY_DO`)**: implemented in Rust as `HeavyDo` (reuses the existing axum router) so CPU-heavy endpoints (import/login/password verification) can run with a higher CPU budget. - **Heavy DO (`HEAVY_DO`)**: implemented in Rust as `HeavyDo` (reuses the existing axum router) so CPU-heavy endpoints can run with a higher CPU budget.
**How to enable/disable** **How to enable/disable**
Whether CPU-heavy endpoints are offloaded is determined by whether the `HEAVY_DO` Durable Object binding is configured in `wrangler.toml`. Whether CPU-heavy endpoints are offloaded is determined by whether the `HEAVY_DO` Durable Object binding is configured in `wrangler.toml`.
> [!NOTE] > [!NOTE]
> Durable Objects have much higher CPU budget of 30 seconds per request in free plan(see [Cloudflare Durable Objects limits](https://developers.cloudflare.com/durable-objects/platform/limits/)), so we can use it to offload the CPU-heavy endpoints.
>
> Durable Objects can incur two types of billing: compute and storage. Storage is not used in this project, and the free plan allows 100,000 requests and 13,000 GB-s duration per day, which should be more than enough for most users. See [Cloudflare Durable Objects pricing](https://developers.cloudflare.com/durable-objects/platform/pricing/) for details. > Durable Objects can incur two types of billing: compute and storage. Storage is not used in this project, and the free plan allows 100,000 requests and 13,000 GB-s duration per day, which should be more than enough for most users. See [Cloudflare Durable Objects pricing](https://developers.cloudflare.com/durable-objects/platform/pricing/) for details.
>
> If you choose to disable Durable Objects, you may need subscribe to a paid plan to avoid being throttled by Cloudflare. > If you choose to disable Durable Objects, you may need subscribe to a paid plan to avoid being throttled by Cloudflare.
### Environment Variables ### Environment Variables

2
wrangler.toml
View file

@ -45,7 +45,7 @@ run_worker_first = ["/api/*", "/identity/*"]
[vars] [vars]
# Server-side password hashing PBKDF2 iterations (stored per-user). # Server-side password hashing PBKDF2 iterations (stored per-user).
# Defaults to 600000, and will be clamped to a minimum of 600000 even if set lower. # Defaults to 600000, and will be clamped to a minimum of 600000 even if set lower.
# Existing users created before this change are assumed to be at 100000 and will be upgraded on login. # Existing users whose password iterations are less than this value will be upgraded on login.
# PASSWORD_ITERATIONS = "600000" # PASSWORD_ITERATIONS = "600000"
# Optional: Set the batch size for imports. Defaults to 30 if not set. # Optional: Set the batch size for imports. Defaults to 30 if not set.