admin/metatron-open-seo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #4 from every-app/opencode/sunny-cactus

Browse Source 
Standalone OpenSEO docker
This commit is contained in:
Ben Senescu 2026-03-09 23:52:36 -04:00 committed by GitHub
commit 1c26449c93
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 99 additions and 461 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
.env.example
View File

@ -15,22 +15,17 @@ VITE_APP_ID=open-seo
# # PORT=3001 # # PORT=3001
# ------------------------------------------------------------- # -------------------------------------------------------------
# --- Docker self-hosting only (see SELF_HOSTING_DOCKER.md) --- # --- Docker self-hosting only (local mode) ---
# For Docker, set GATEWAY_URL and VITE_GATEWAY_URL to: # See SELF_HOSTING_DOCKER.md
# http://every-app-gateway.localhost:3000 # Docker compose runs with BYPASS_GATEWAY_LOCAL_ONLY=true.
# VITE_GATEWAY_URL=http://every-app-gateway.localhost:3000 # Optional host/container port (defaults to 3001):
# GATEWAY_URL=http://every-app-gateway.localhost:3000 # PORT=3001
# # Optional in .env because compose already sets it.
# Optional: pin to a specific Gateway release tag. # BYPASS_GATEWAY_LOCAL_ONLY=true
# By default the latest release is pulled automatically (recommended). # Optional override (defaults to open-seo):
# GATEWAY_RELEASE_TAG= # VITE_APP_ID=open-seo
# # See README.md for instructions for how to get this. # # See README.md for instructions for how to get this.
# DATAFORSEO_API_KEY= # DATAFORSEO_API_KEY=
# Required for Gateway auth when running Docker self-host. # Legacy gateway auth keys are not needed in Docker self-host mode.
# Generate with: pnpm run docker:generate-secrets
# Validate with: pnpm run docker:check-env
# BETTER_AUTH_SECRET=
# JWT_PRIVATE_KEY=""
# JWT_PUBLIC_KEY=""

3
.worktreeinclude
View File

@ -1,3 +0,0 @@
.env.local
.wrangler
node_modules/

107
README.md
View File

@ -11,8 +11,8 @@ OpenSEO is an SEO tool for _the people_. If tools like Semrush or Ahrefs are too
- [Roadmap](#roadmap) - [Roadmap](#roadmap)
- [Community](#community) - [Community](#community)
- [Pricing / Costs (Free + API costs)](#pricing--costs) - [Pricing / Costs (Free + API costs)](#pricing--costs)
- [Self Hosting (Deploy on Cloudflare) \[5-10 minutes\]](#self-hosting-deploy-on-cloudflare-5-10-minutes) - [DataForSEO API Key Setup](#dataforseo-api-key-setup)
- [Docker Self Hosting (Gateway + OpenSEO)](#docker-self-hosting-gateway--openseo) - [Docker Self Hosting](#docker-self-hosting)
- [Local Development](#local-development) - [Local Development](#local-development)
- [Contributing](#contributing) - [Contributing](#contributing)
- [SEO API Cost Reference](#seo-api-cost-reference) - [SEO API Cost Reference](#seo-api-cost-reference)
@ -63,68 +63,7 @@ There are two separate things:
For cost estimates, see [DataForSEO API Cost Reference](#seo-api-cost-reference). For cost estimates, see [DataForSEO API Cost Reference](#seo-api-cost-reference).
## Self Hosting (Deploy on Cloudflare) [5-10 minutes] ## DataForSEO API Key Setup
> [!TIP]
> If anything in this section is confusing or unfamiliar like running terminal commands, copy this link into ChatGPT or Claude and ask it explain.
OpenSEO is built on [Every App](https://github.com/every-app/every-app), a platform for easily self-hosting open source apps like OpenSEO in your own Cloudflare account. Cloudflare enables much more powerful functionality than is possible running on your own computer or on a VPS.
_Windows Users_
This has not been tested on Windows. Please let me know if you run into problems. Using WSL will likely work better. Also, try using [fly.io Sprites](https://sprites.dev/) to get a linux sandbox for free if you get totally stuck.
### Video Walkthrough
This video walks through setting up the Gateway and self hosting OpenSEO. If you run into any problems, reference the [Community](#community) section for how to reach out.
https://github.com/user-attachments/assets/e40d5089-971f-43c9-85ff-1213aea35156
### Prerequisites
If you don't want to make a Cloudflare account yet (its easy!) and just want to test out OpenSEO, skip to the [Run Locally](#seo-api-cost-reference) section.
1. Install [Node.js](https://nodejs.org/) (includes `npx`).
2. Create a Cloudflare account: [dash.cloudflare.com/sign-up](https://dash.cloudflare.com/sign-up)
3. Authenticate Wrangler:
```sh
npx wrangler login
```
4. Deploy the Every App Gateway (one-time per account):
```sh
npx everyapp gateway deploy
```
5. Create an Account
- Follow the link output by the last command to create an account. You will access OpenSEO through this account.
### Self Host OpenSEO
Deploy the app to cloudflare.
1. Clone the repo to your machine
```sh
git clone https://github.com/every-app/open-seo.git
```
2. Switch to the directory
```sh
cd open-seo
```
3. Self host via the Every App CLI
```sh
npx everyapp app deploy
```
#### DataForSEO API Key Setup [5 minutes]
OpenSEO use DataForSEO to get the SEO info. You need an API key to connect OpenSEO to the service. OpenSEO use DataForSEO to get the SEO info. You need an API key to connect OpenSEO to the service.
@ -136,19 +75,21 @@ OpenSEO use DataForSEO to get the SEO info. You need an API key to connect OpenS
printf '%s' 'YOUR_LOGIN:YOUR_PASSWORD' | base64 printf '%s' 'YOUR_LOGIN:YOUR_PASSWORD' | base64
``` ```
4. Set this as a secret in Cloudflare. Use the value from the previous step when prompted. 4. Set this as `DATAFORSEO_API_KEY` in your environment file:
```sh - Docker self-hosting: `.env`
npx wrangler secret put DATAFORSEO_API_KEY - Local development: `.env.local`
```
Now you're all set! Go back to the gateway, click on the OpenSEO app, and start getting better at SEO! ## Docker Self Hosting
## Docker Self Hosting (Gateway + OpenSEO) Quickstart:
If you want a single Docker Compose command that runs both Every App Gateway and OpenSEO together, see [`SELF_HOSTING_DOCKER.md`](./SELF_HOSTING_DOCKER.md). 1. `cp .env.example .env`
2. Set `DATAFORSEO_API_KEY` in `.env`
3. `docker compose up`
4. Open `http://localhost:<PORT>` (default `3001`)
This runtime uses local dev servers to emulate Cloudflare Worker bindings. It is intended for **local use only** — do not expose ports directly to the public internet. For remote access, use [Tailscale](https://tailscale.com/). For internet-facing deployments, use the Cloudflare deployment path above. See the [security and runtime caveats](./SELF_HOSTING_DOCKER.md#security-and-runtime-caveats) in the Docker guide for details. For runtime details, caveats, and troubleshooting, see [`SELF_HOSTING_DOCKER.md`](./SELF_HOSTING_DOCKER.md).
## Local Development ## Local Development
@ -172,31 +113,17 @@ cp .env.example .env.local
pnpm install pnpm install
# Initialize local DB schema (required on a fresh machine) # Initialize local DB schema (required on a fresh machine)
pnpm run db:migrate:local pnpm run db:migrate:local
# This runs in BYPASS_GATEWAY mode so that you don't need to set up the Every App gateway. This is fine for local use and best for local dev / quick testing since you don't need to access the app through the gatway # This runs in BYPASS_GATEWAY mode for local use and quick testing.
pnpm dev:agents pnpm dev:agents
``` ```
`pnpm dev` runs on `http://localhost:3001` by default (or `PORT` from `.env.local`). `pnpm dev` runs on `http://localhost:3001` by default (or `PORT` from `.env.local`).
`pnpm dev:agents` runs through portless at `http://open-seo.localhost:1355` by default. `pnpm dev:agents` runs through [portless](https://github.com/vercel-labs/portless) at `http://open-seo.localhost:1355` by default.
When using a git worktree, portless prefixes the branch name, for example `http://feature-name.open-seo.localhost:1355`. When using a git worktree, [portless](https://github.com/vercel-labs/portless) prefixes the branch name, for example `http://feature-name.open-seo.localhost:1355`.
Running locally is the fastest way to test core flows. In the future, local mode will not include some Cloudflare-backed capabilities (for example cron-based rank tracking and infrastructure-powered performance improvements for heavier audits). Running locally is the fastest way to test core flows.
### Local Development (In Gateway)
If you want auth or any other gateway only features enabled for local dev, you must access through your Gateway and set a devUrl on the app.
See the next section which is a workflow for agents which works much better with worktrees and doens't require the Gateway.
```sh
# This configures your .env.local, installs dependencies and runs migrations against your local database.
npx everyapp app setup-local
# terminal 1: start once and keep running
pnpm dev:agents
```
### Local Development Workflow (for coding agents) ### Local Development Workflow (for coding agents)

147
SELF_HOSTING_DOCKER.md
View File

@ -1,137 +1,76 @@
# Docker Self-Hosting # Docker Self-Hosting
This guide runs both Every App Gateway and OpenSEO with one Docker Compose command. This guide runs OpenSEO as a local service without Every App Gateway.
OpenSEO is an app built on Every App so things like authentication and user management are delegated to the Gateway. Every App is built with deployment to Cloudflare as its target with the goal of making self hosting more accessible to people not already running home labs. Because of that design principle, self hosting with docker is a bit complicated right now, but will hopefully will get smoother over time. In this mode, OpenSEO runs with `BYPASS_GATEWAY_LOCAL_ONLY=true`, so authentication and Gateway-managed user accounts are disabled.
The stack uses local Cloudflare-compatible runtime behavior (`wrangler` + Vite/worker runtime) so bindings and auth behavior stay close to Workers while running on your own machine or server.
## Prerequisites ## Prerequisites
- Docker Desktop (or Docker Engine + Docker Compose) - Docker Desktop (or Docker Engine + Docker Compose)
## Runtime model
- OpenSEO runs from this repository source in containerized local runtime mode.
- Gateway is built from `apps/every-app-gateway` source at a release tag in https://github.com/every-app/every-app
Default gateway release policy:
- Source: `every-app/every-app` releases
- Tag: latest release (recommended)
You can optionally pin to a specific release by setting `GATEWAY_RELEASE_TAG` in your env file.
## Security and runtime caveats ## Security and runtime caveats
This stack runs local dev servers to emulate Cloudflare Worker bindings — this is currently the best way to self-host outside Cloudflare, but it means dev-only surfaces (HMR, verbose errors, broader file-serving) are exposed on the serving ports. Do not expose these ports directly to the public internet. If you need remote access, use [Tailscale](https://tailscale.com/) instead of a public tunnel. For internet-facing deployments, use the [Cloudflare deployment path](./README.md#self-hosting-deploy-on-cloudflare-5-10-minutes). This stack is local-first and uses dev runtimes to emulate Cloudflare Worker bindings.
- Do not expose these ports directly to the public internet.
- There is no built-in Gateway auth in this mode.
- If you expose it beyond localhost, put it behind the same authentication layer you use for your other self-hosted services (or use the [Cloudflare deployment path](./README.md#self-hosting-deploy-on-cloudflare-5-10-minutes)).
## 1) Configure env values ## 1) Configure env values
From the repository root: From the repository root:
```bash ```bash
cp .env.example .env.local cp .env.example .env
``` ```
Set values as needed in `.env.local`. Set values as needed in `.env`.
Important values: Required:
- `GATEWAY_URL` and `VITE_GATEWAY_URL` should be set to `http://every-app-gateway.localhost:3000` for local Docker networking and JWT issuer consistency. - `DATAFORSEO_API_KEY`
- Add a host entry for `every-app-gateway.localhost` if needed:
- macOS/Linux: add `127.0.0.1 every-app-gateway.localhost` to `/etc/hosts`
- Windows: add `127.0.0.1 every-app-gateway.localhost` to `C:\Windows\System32\drivers\etc\hosts`
- If you use a different host or port, set both `GATEWAY_URL` and `VITE_GATEWAY_URL` to the same origin.
- `DATAFORSEO_API_KEY` is required for OpenSEO SEO-data workflows.
- See [README: DataForSEO API Key Setup](./README.md#dataforseo-api-key-setup-5-minutes).
- `BETTER_AUTH_SECRET`, `JWT_PRIVATE_KEY`, and `JWT_PUBLIC_KEY` are required for gateway auth (see how to generate them below)
Generate auth values with: Optional:
- `PORT` (defaults to `3001`)
- `VITE_APP_ID` (defaults to `open-seo`)
- `BYPASS_GATEWAY_LOCAL_ONLY=true` (Docker compose already sets this)
## 2) Start OpenSEO
```bash ```bash
pnpm run docker:generate-secrets docker compose up
``` ```
Copy the printed lines into `.env.local`. URL:
Validate env before startup: - OpenSEO: `http://localhost:<PORT>` (defaults to `3001`)
```bash Boot behavior:
pnpm run docker:check-env
```
## 2) Start both services with one command - Uses dependencies installed during image build.
```bash
pnpm run docker:up
```
URLs:
- Gateway: `http://every-app-gateway.localhost:3000`
- OpenSEO: `http://localhost:3001`
Gateway boot behavior:
- Resolves the latest gateway release tag (unless explicitly pinned).
- Pulls gateway source for that tag, installs dependencies during image build, and runs in local runtime mode.
- Applies local D1 migrations on start. - Applies local D1 migrations on start.
- Persists local gateway Wrangler/D1 state in Docker volume `every_app_gateway_wrangler_state`. - Starts local dev runtime (Vite).
OpenSEO boot behavior:
- Uses dependencies installed during image build, then applies local D1 migrations on start.
- Starts local dev runtime (Vite). See [Security and runtime caveats](#security-and-runtime-caveats) above.
## 3) Bootstrap Gateway and app access
1. Open `http://every-app-gateway.localhost:3000/sign-up` and create the owner account.
2. In Gateway admin (`/admin/apps`), add OpenSEO:
- App ID: `open-seo`
- App URL: `http://localhost:3001`
- Or whatever port you have this running at
3. Start using OpenSEO by accessing it through Gateway: `http://every-app-gateway.localhost:3000/`.
## Optional: Run only one service
Run gateway only:
```bash
pnpm run docker:check-env
docker compose -f self-host/docker-compose.yml --env-file .env.local up --build gateway
```
Run OpenSEO only (expects gateway already reachable at `GATEWAY_URL`):
```bash
pnpm run docker:check-env
docker compose -f self-host/docker-compose.yml --env-file .env.local up --build open-seo
```
## Updating gateway version
By default this stack pulls the latest published gateway release (recommended).
To pin to a specific gateway release instead:
1. Set `GATEWAY_RELEASE_TAG` in `.env.local` (for example `gateway-v0.1.11`).
2. Rebuild gateway:
```bash
docker compose -f self-host/docker-compose.yml --env-file .env.local build --no-cache gateway
docker compose -f self-host/docker-compose.yml --env-file .env.local up -d gateway
```
When tracking latest, rebuild gateway with `--no-cache` to pull newer gateway source for the latest tag.
## Troubleshooting ## Troubleshooting
- `Issuer must be provided` or `signature verification failed`: make sure `GATEWAY_URL` and `VITE_GATEWAY_URL` both point to `http://every-app-gateway.localhost:3000`, then clear browser cookies/storage for `localhost` and `every-app-gateway.localhost` and sign in again.
- OpenSEO env values seem stale: restart OpenSEO: - OpenSEO env values seem stale: restart OpenSEO:
```bash ```bash
docker compose -f self-host/docker-compose.yml --env-file .env.local up -d --build open-seo docker compose up -d open-seo
```
- If migrations fail on first run, rebuild and retry:
```bash
docker compose down
docker compose up
```
If you update dependencies or Docker build config, force a rebuild:
```bash
docker compose up --build
``` ```
## Stop and cleanup ## Stop and cleanup
@ -139,17 +78,11 @@ docker compose -f self-host/docker-compose.yml --env-file .env.local up -d --bui
Stop stack: Stop stack:
```bash ```bash
docker compose -f self-host/docker-compose.yml --env-file .env.local down docker compose down
``` ```
Stop and remove Docker volumes: Stop and remove Docker volumes:
```bash ```bash
docker compose -f self-host/docker-compose.yml --env-file .env.local down -v docker compose down -v
```
To reset only the gateway local DB state explicitly:
```bash
docker volume rm every_app_gateway_wrangler_state
``` ```

30
compose.yaml Normal file
View File

@ -0,0 +1,30 @@
services:
open-seo:
build:
context: .
dockerfile: self-host/Dockerfile.selfhost
working_dir: /app
environment:
- PORT=${PORT:-3001}
- BYPASS_GATEWAY_LOCAL_ONLY=true
- VITE_APP_ID=${VITE_APP_ID:-open-seo}
- VITE_GATEWAY_URL=${VITE_GATEWAY_URL:-http://localhost:${PORT:-3001}}
- GATEWAY_URL=${GATEWAY_URL:-http://localhost:${PORT:-3001}}
- DATAFORSEO_API_KEY=${DATAFORSEO_API_KEY}
- VITE_SHOW_DEVTOOLS=false
command:
[
"sh",
"-c",
"pnpm run db:migrate:local && pnpm exec vite dev --host 0.0.0.0 --port ${PORT:-3001}",
]
ports:
- "127.0.0.1:${PORT:-3001}:${PORT:-3001}"
volumes:
- .:/app
- open_seo_node_modules:/app/node_modules
- open_seo_pnpm_store:/pnpm/store
volumes:
open_seo_node_modules:
open_seo_pnpm_store:

2
knip.jsonc
View File

@ -8,8 +8,6 @@
"drizzle.config.ts", "drizzle.config.ts",
// DB index re-exports schema for convenience // DB index re-exports schema for convenience
"src/db/index.ts", "src/db/index.ts",
// Docker self-host runtime entrypoint scripts
"self-host/scripts/*.mjs",
], ],
"project": ["**/*.{js,mjs,ts,tsx}", "!src/routeTree.gen.ts"], "project": ["**/*.{js,mjs,ts,tsx}", "!src/routeTree.gen.ts"],
"ignore": [ "ignore": [

4
package.json
View File

@ -20,10 +20,6 @@
"db:migrate:prod": "npx everyapp app remote-d1-shell -- drizzle-kit migrate --config=drizzle-prod.config.ts", "db:migrate:prod": "npx everyapp app remote-d1-shell -- drizzle-kit migrate --config=drizzle-prod.config.ts",
"db:studio:local": "drizzle-kit studio", "db:studio:local": "drizzle-kit studio",
"db:studio:prod": "npx everyapp app remote-d1-shell -- drizzle-kit studio --config=drizzle-prod.config.ts", "db:studio:prod": "npx everyapp app remote-d1-shell -- drizzle-kit studio --config=drizzle-prod.config.ts",
"docker:check-env": "node ./self-host/scripts/validate-selfhost-env.mjs",
"docker:up": "pnpm run docker:check-env && docker compose -f self-host/docker-compose.yml --env-file .env.local up --build",
"docker:down": "docker compose -f self-host/docker-compose.yml --env-file .env.local down",
"docker:generate-secrets": "node ./self-host/scripts/generate-selfhost-secrets.mjs",
"knip": "knip", "knip": "knip",
"ci": "prettier --check . && knip && tsc --noEmit && oxlint ." "ci": "prettier --check . && knip && tsc --noEmit && oxlint ."
}, },

22
self-host/Dockerfile.gateway-selfhost
View File

@ -1,22 +0,0 @@
FROM node:22
ENV PNPM_HOME=/pnpm
ENV PATH=$PNPM_HOME:$PATH
WORKDIR /app
RUN corepack enable
COPY self-host/scripts/resolve-gateway-tag.mjs self-host/scripts/download-archive.mjs /tmp/scripts/
ARG GATEWAY_RELEASE_TAG=
RUN gateway_tag=$(node /tmp/scripts/resolve-gateway-tag.mjs) \
&& echo "Downloading Gateway source for tag: ${gateway_tag}" \
&& node /tmp/scripts/download-archive.mjs "https://github.com/every-app/every-app/archive/refs/tags/${gateway_tag}.tar.gz" /tmp/every-app-source.tar.gz \
&& mkdir -p /tmp/every-app-source \
&& tar -xzf /tmp/every-app-source.tar.gz -C /tmp/every-app-source \
&& source_root=$(find /tmp/every-app-source -mindepth 1 -maxdepth 1 -type d | head -n 1) \
&& cp -R "$source_root/apps/every-app-gateway/." /app \
&& rm -rf /tmp/every-app-source /tmp/every-app-source.tar.gz /tmp/scripts
RUN pnpm install --frozen-lockfile

63
self-host/docker-compose.yml
View File

@ -1,63 +0,0 @@
services:
gateway:
build:
context: ..
dockerfile: self-host/Dockerfile.gateway-selfhost
args:
GATEWAY_RELEASE_TAG: ${GATEWAY_RELEASE_TAG:-}
env_file:
- ../.env.local
command:
[
"sh",
"-c",
"pnpm run db:migrate:local && pnpm exec vite dev --host 0.0.0.0 --port 3000",
]
ports:
- "127.0.0.1:3000:3000"
volumes:
- ../.env.local:/app/.env:ro
- gateway_wrangler_state:/app/.wrangler/state
networks:
selfhost:
aliases:
- every-app-gateway.localhost
open-seo:
build:
context: ..
dockerfile: self-host/Dockerfile.selfhost
working_dir: /app
environment:
- PORT=3001
- VITE_APP_ID=${VITE_APP_ID}
- VITE_GATEWAY_URL=${VITE_GATEWAY_URL}
- GATEWAY_URL=${GATEWAY_URL}
- DATAFORSEO_API_KEY=${DATAFORSEO_API_KEY}
- OPENAI_API_KEY=${OPENAI_API_KEY:-}
- VITE_SHOW_DEVTOOLS=false
command:
[
"sh",
"-c",
"pnpm run db:migrate:local && pnpm exec vite dev --host 0.0.0.0 --port 3001",
]
depends_on:
- gateway
ports:
- "127.0.0.1:3001:3001"
volumes:
- ..:/app
- open_seo_node_modules:/app/node_modules
- open_seo_pnpm_store:/pnpm/store
networks:
- selfhost
networks:
selfhost:
volumes:
gateway_wrangler_state:
name: every_app_gateway_wrangler_state
open_seo_node_modules:
open_seo_pnpm_store:

20
self-host/scripts/download-archive.mjs
View File

@ -1,20 +0,0 @@
// Downloads a file from a URL and writes it to a local path.
// Usage: node self-host/scripts/download-archive.mjs <url> <output-path>
import { writeFileSync } from "node:fs";
const [url, outputPath] = process.argv.slice(2);
if (!url || !outputPath) {
console.error(
"Usage: node self-host/scripts/download-archive.mjs <url> <output-path>",
);
process.exit(1);
}
const res = await fetch(url);
if (!res.ok) {
throw new Error("Failed to download source archive: " + String(res.status));
}
writeFileSync(outputPath, Buffer.from(await res.arrayBuffer()));

19
self-host/scripts/generate-selfhost-secrets.mjs
View File

@ -1,19 +0,0 @@
import { generateKeyPairSync, randomBytes } from "node:crypto";
function escapeForEnv(value) {
return value.replace(/\r?\n/g, "\\n");
}
const betterAuthSecret = randomBytes(32).toString("base64");
const { privateKey, publicKey } = generateKeyPairSync("rsa", {
modulusLength: 2048,
publicKeyEncoding: { type: "spki", format: "pem" },
privateKeyEncoding: { type: "pkcs8", format: "pem" },
});
console.log(
"# Copy these lines into .env.local\n# See SELF_HOSTING_DOCKER.md for setup instructions",
);
console.log(`BETTER_AUTH_SECRET=${betterAuthSecret}`);
console.log(`JWT_PRIVATE_KEY="${escapeForEnv(privateKey)}"`);
console.log(`JWT_PUBLIC_KEY="${escapeForEnv(publicKey)}"`);

23
self-host/scripts/resolve-gateway-tag.mjs
View File

@ -1,23 +0,0 @@
// Resolves the gateway release tag to use for the selfhost Docker build.
// If GATEWAY_RELEASE_TAG is set, prints it and exits.
// Otherwise fetches the latest release tag from the GitHub API.
const tag = process.env.GATEWAY_RELEASE_TAG;
if (tag) {
process.stdout.write(tag);
process.exit(0);
}
const res = await fetch(
"https://api.github.com/repos/every-app/every-app/releases/latest",
);
if (!res.ok) {
throw new Error("Failed to resolve latest release: " + String(res.status));
}
const parsed = await res.json();
if (!parsed.tag_name) {
throw new Error("Missing tag_name in latest release payload");
}
process.stdout.write(parsed.tag_name);

92
self-host/scripts/validate-selfhost-env.mjs
View File

@ -1,92 +0,0 @@
import { existsSync, readFileSync } from "node:fs";
function parseEnvFile(path) {
const raw = readFileSync(path, "utf8");
const out = {};
for (const line of raw.split(/\r?\n/)) {
const trimmed = line.trim();
if (trimmed.length === 0 || trimmed.startsWith("#")) {
continue;
}
const equalsIndex = trimmed.indexOf("=");
if (equalsIndex <= 0) {
continue;
}
const key = trimmed.slice(0, equalsIndex).trim();
let value = trimmed.slice(equalsIndex + 1).trim();
if (
(value.startsWith('"') && value.endsWith('"')) ||
(value.startsWith("'") && value.endsWith("'"))
) {
value = value.slice(1, -1);
}
out[key] = value.replace(/\\n/g, "\n");
}
return out;
}
function isBlank(value) {
return typeof value !== "string" || value.trim().length === 0;
}
const envPath = process.argv[2] || ".env.local";
if (!existsSync(envPath)) {
console.error(`Missing env file: ${envPath}`);
console.error("Create it with: cp .env.example .env.local");
process.exit(1);
}
const env = parseEnvFile(envPath);
const requiredKeys = [
"GATEWAY_URL",
"VITE_GATEWAY_URL",
"VITE_APP_ID",
"DATAFORSEO_API_KEY",
"BETTER_AUTH_SECRET",
"JWT_PRIVATE_KEY",
"JWT_PUBLIC_KEY",
];
const missingKeys = requiredKeys.filter((key) => isBlank(env[key]));
if (missingKeys.length > 0) {
console.error("Missing required keys in env file:");
for (const key of missingKeys) {
console.error(`- ${key}`);
}
console.error("\nGenerate auth keys with: pnpm run docker:generate-secrets");
process.exit(1);
}
if (env.GATEWAY_URL !== env.VITE_GATEWAY_URL) {
console.error(
"GATEWAY_URL and VITE_GATEWAY_URL must match for auth issuer consistency.",
);
process.exit(1);
}
if (!env.JWT_PRIVATE_KEY.includes("BEGIN PRIVATE KEY")) {
console.error("JWT_PRIVATE_KEY does not look like a PEM private key.");
process.exit(1);
}
if (!env.JWT_PUBLIC_KEY.includes("BEGIN PUBLIC KEY")) {
console.error("JWT_PUBLIC_KEY does not look like a PEM public key.");
process.exit(1);
}
if (env.BETTER_AUTH_SECRET.trim().length < 32) {
console.error(
"BETTER_AUTH_SECRET is too short. Generate a new one with docker:generate-secrets.",
);
process.exit(1);
}
console.log(`Env validation passed: ${envPath}`);

3
worker-configuration.d.ts vendored
View File

@ -12,6 +12,7 @@ declare namespace Cloudflare {
VITE_APP_ID: string; VITE_APP_ID: string;
VITE_GATEWAY_URL: string; VITE_GATEWAY_URL: string;
GATEWAY_URL: string; GATEWAY_URL: string;
GATEWAY_APP_API_TOKEN: string;
EVERY_APP_GATEWAY: Fetcher /* every-app-gateway */; EVERY_APP_GATEWAY: Fetcher /* every-app-gateway */;
SITE_AUDIT_WORKFLOW: Workflow<Parameters<import("./src/server").SiteAuditWorkflow['run']>[0]['payload']>; SITE_AUDIT_WORKFLOW: Workflow<Parameters<import("./src/server").SiteAuditWorkflow['run']>[0]['payload']>;
} }
@ -21,7 +22,7 @@ type StringifyValues<EnvType extends Record<string, unknown>> = {
[Binding in keyof EnvType]: EnvType[Binding] extends string ? EnvType[Binding] : string; [Binding in keyof EnvType]: EnvType[Binding] extends string ? EnvType[Binding] : string;
}; };
declare namespace NodeJS { declare namespace NodeJS {
interface ProcessEnv extends StringifyValues<Pick<Cloudflare.Env, "VITE_APP_ID" | "VITE_GATEWAY_URL" | "GATEWAY_URL">> {} interface ProcessEnv extends StringifyValues<Pick<Cloudflare.Env, "VITE_APP_ID" | "VITE_GATEWAY_URL" | "GATEWAY_URL" | "GATEWAY_APP_API_TOKEN">> {}
} }
// Begin runtime types // Begin runtime types