Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Update server README with S3, Cloudflare R2, and Sentry env vars
Damian Legawiec2e22a773e28d
diff --git a/server/README.md b/server/README.mdindex 62384ebdc5..9902860d81 100644--- a/server/README.md+++ b/server/README.md@@ -108,3 +108,33 @@ Spree works with any SMTP provider (Resend, Postmark, Mailgun, SendGrid, Amazon| `SMTP_PASSWORD` | — | SMTP auth password || `SMTP_FROM_ADDRESS` | — | Default "from" email address || `RAILS_HOST` | `example.com` | Host used in mailer URLs |++### File Storage (S3 / Cloudflare R2)++By default, uploaded files are stored on the local disk. Set the appropriate environment variables to use S3 or Cloudflare R2 instead. When both are configured, S3 takes priority.++**AWS S3:**++| Variable | Default | Description |+|---|---|---|+| `AWS_ACCESS_KEY_ID` | — | AWS access key |+| `AWS_SECRET_ACCESS_KEY` | — | AWS secret key |+| `AWS_REGION` | — | AWS region (e.g. `us-east-1`) |+| `AWS_BUCKET` | `spree-<env>` | S3 bucket name |++**Cloudflare R2:**++| Variable | Default | Description |+|---|---|---|+| `CLOUDFLARE_ACCESS_KEY_ID` | — | R2 access key |+| `CLOUDFLARE_SECRET_ACCESS_KEY` | — | R2 secret key |+| `CLOUDFLARE_ENDPOINT` | — | R2 endpoint URL (e.g. `https://<account_id>.r2.cloudflarestorage.com`) |+| `CLOUDFLARE_BUCKET` | `spree-<env>` | R2 bucket name |++### Error Monitoring (Sentry)++| Variable | Default | Description |+|---|---|---|+| `SENTRY_DSN` | — | Sentry DSN to enable error and performance monitoring |+| `SENTRY_REPORT_ON_DEVELOPMENT` | — | Set to any value to also report errors in development |+| `RENDER_GIT_COMMIT` | — | Git SHA used as Sentry release identifier |