Update .env.example
This commit is contained in:
parent
be50738dad
commit
c20ea9f851
28
.env.example
28
.env.example
@ -1,24 +1,32 @@
|
||||
# Local app port
|
||||
PORT=3001
|
||||
|
||||
# Every App / Gateway settings
|
||||
VITE_APP_ID=open-seo
|
||||
VITE_GATEWAY_URL=https://your-gateway-domain.example.com
|
||||
GATEWAY_URL=https://your-gateway-domain.example.com
|
||||
|
||||
# DataForSEO Basic auth value: base64(login:password)
|
||||
DATAFORSEO_API_KEY=base64_login_colon_password
|
||||
# -------------------------------------------------------------
|
||||
# # --- Local development --
|
||||
# # Run everyapp app setup-local to automatically configure you .env.local if you've set up your gateway in cloudflare
|
||||
# # This should be: https://every-app-gateway.
|
||||
# VITE_GATEWAY_URL=
|
||||
# GATEWAY_URL=
|
||||
|
||||
# # See README.md for instructions for how to get this.
|
||||
# DATAFORSEO_API_KEY=
|
||||
|
||||
# # Choose local app port
|
||||
# # PORT=3001
|
||||
|
||||
# -------------------------------------------------------------
|
||||
# --- Docker self-hosting only (see SELF_HOSTING_DOCKER.md) ---
|
||||
# For Docker, set GATEWAY_URL and VITE_GATEWAY_URL to:
|
||||
# http://every-app-gateway.localhost:3000
|
||||
|
||||
# VITE_GATEWAY_URL=http://every-app-gateway.localhost:3000
|
||||
# GATEWAY_URL=http://every-app-gateway.localhost:3000
|
||||
#
|
||||
# Optional: pin to a specific Gateway release tag.
|
||||
# By default the latest release is pulled automatically (recommended).
|
||||
# GATEWAY_RELEASE_TAG=
|
||||
|
||||
# Optional: needed only for Gateway AI proxy routes.
|
||||
# OPENAI_API_KEY=
|
||||
# # See README.md for instructions for how to get this.
|
||||
# DATAFORSEO_API_KEY=
|
||||
|
||||
# Required for Gateway auth when running Docker self-host.
|
||||
# Generate with: pnpm run docker:generate-secrets
|
||||
|
||||
14
README.md
14
README.md
@ -184,6 +184,20 @@ When using a git worktree, portless prefixes the branch name, for example `http:
|
||||
|
||||
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).
|
||||
|
||||
### 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)
|
||||
|
||||
```sh
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user