TheSunIsLeaking/recflare
3
0
Fork 0
mirror of https://github.com/djdevin/recflare.git synced 2026-09-08 14:41:28 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update deployment requirements and instructions

Browse Source 
Emphasize the importance of prerequisites for RecFlare deployment and clarify usage of `just` for installation.
This commit is contained in:
devin
2026-08-03 21:56:42 -04:00
committed by GitHub
parent 108b061019
commit 821bf54b9b
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
DEPLOYING.md
+10 -6
View File
@@ -43,10 +43,12 @@ services but would require small code changes.
## Prerequisites ## Prerequisites
- node (modern) **You must have all these requirements or RecFlare deployment will fail!**
- pnpm
- bun - node 24 (https://nodejs.org)
- jq/awk/sed - pnpm (install with `npm install -g pnpm`)
- bun (https://bun.sh)
- jq/awk/sed (on Windows try `winget jq` etc.)
- A Cloudflare account with a zone (domain) you control, for deploying. - A Cloudflare account with a zone (domain) you control, for deploying.
Cloudflare's free plan is good enough for testing (100k worker requests/day) but the Cloudflare's free plan is good enough for testing (100k worker requests/day) but the
@@ -65,6 +67,8 @@ We use [Just](https://github.com/casey/just) for convenience. This will install
just install just install
``` ```
You do not have to use `just` but you will have to run things manually with `pnpm`/`bun`.
**Configure your custom domain:** **Configure your custom domain:**
Create a new .env file from the template: Create a new .env file from the template:
@@ -77,11 +81,11 @@ Edit `.env` and set `RECFLARE_DOMAIN` to your domain (or declare it with `export
(Optional) - per-app subdomain overrides come from (Optional) - per-app subdomain overrides come from
`RECFLARE_SUBDOMAINS` (a JSON object, e.g. `'{"playersettings":"settings"}'`). This would be used `RECFLARE_SUBDOMAINS` (a JSON object, e.g. `'{"playersettings":"settings"}'`). This would be used
if you wanted to merge two services together. if you wanted to merge two services together e.g. send `datacollection` calls to `api`.
**Create the storage resources:** **Create the storage resources:**
The workers bind Cloudflare storage primitive. Create them once against your The workers bind Cloudflare storage primitives. Create them once against your
Cloudflare account, then record the IDs in `.env`. The committed `wrangler.jsonc` Cloudflare account, then record the IDs in `.env`. The committed `wrangler.jsonc`
files carry `"local"` placeholders; the real IDs are spliced in at deploy time, so files carry `"local"` placeholders; the real IDs are spliced in at deploy time, so
nothing in version control needs editing. Authenticate wrangler first nothing in version control needs editing. Authenticate wrangler first