feat(deploy): add PaaS templates and config
This commit is contained in:
+5
-2
@@ -53,8 +53,11 @@ COPY --from=builder /app/package.json ./
|
||||
# Copy SOUL.md if it exists (prompt template loaded at runtime)
|
||||
COPY --from=builder /app/SOUL.md ./
|
||||
|
||||
# Create data directories
|
||||
RUN mkdir -p /data/memory /data/sessions /config
|
||||
# Create data directories and ship a default config at /config/config.yaml so
|
||||
# the image is runnable without an external bind-mount (compose can still
|
||||
# override /config/config.yaml).
|
||||
RUN mkdir -p /data/memory /data/sessions /config && \
|
||||
cp -f /app/config/paas.yaml /config/config.yaml
|
||||
|
||||
# Environment
|
||||
ENV NODE_ENV=production \
|
||||
|
||||
@@ -770,6 +770,14 @@ docker compose logs -f
|
||||
| `/config/config.yaml` | Configuration file (read-only) |
|
||||
| `/data` | Persistent data (sessions DB, memory files, vector index) |
|
||||
|
||||
## PaaS Deployment (Fly.io / Railway / Render)
|
||||
|
||||
See `docs/deployment/PAAS.md` and the templates under `deploy/`.
|
||||
|
||||
## Nix Deployment
|
||||
|
||||
See `docs/deployment/NIX.md` for the flake (package + dev shell + optional NixOS module).
|
||||
|
||||
## Doctor Diagnostics
|
||||
|
||||
`flynn doctor` runs 10 health checks to validate your setup:
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
# Flynn PaaS-friendly configuration template
|
||||
#
|
||||
# Intended for: Fly.io / Railway / Render (or any platform that provides PORT).
|
||||
# - Binds the gateway on all interfaces (required for container/PaaS routing).
|
||||
# - Relies on `${ENV_VAR}` expansion so secrets stay in platform env vars.
|
||||
#
|
||||
# For a full example with more options, see: config/default.yaml
|
||||
|
||||
server:
|
||||
localhost: false
|
||||
port: 18800 # Overridden by PORT env var when set.
|
||||
|
||||
models:
|
||||
default:
|
||||
provider: anthropic
|
||||
model: claude-sonnet-4-20250514
|
||||
api_key: ${ANTHROPIC_API_KEY}
|
||||
|
||||
# Recommended safe defaults for internet-exposed deployments.
|
||||
pairing:
|
||||
enabled: true
|
||||
|
||||
tools:
|
||||
profile: messaging
|
||||
|
||||
sandbox:
|
||||
enabled: true
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
app = "flynn"
|
||||
|
||||
[build]
|
||||
dockerfile = "Dockerfile"
|
||||
|
||||
[env]
|
||||
# Persist state under /data (see volume mount below)
|
||||
FLYNN_DATA_DIR = "/data"
|
||||
|
||||
# The Docker image ships /config/config.yaml (from config/paas.yaml).
|
||||
# Override this if you mount your own config elsewhere.
|
||||
FLYNN_CONFIG = "/config/config.yaml"
|
||||
|
||||
[http_service]
|
||||
internal_port = 18800
|
||||
force_https = true
|
||||
auto_start_machines = true
|
||||
auto_stop_machines = "stop"
|
||||
min_machines_running = 0
|
||||
|
||||
[[mounts]]
|
||||
source = "flynn_data"
|
||||
destination = "/data"
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
[build]
|
||||
builder = "DOCKERFILE"
|
||||
dockerfilePath = "Dockerfile"
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
services:
|
||||
- type: web
|
||||
name: flynn
|
||||
env: docker
|
||||
dockerfilePath: ./Dockerfile
|
||||
autoDeploy: false
|
||||
healthCheckPath: /
|
||||
envVars:
|
||||
- key: ANTHROPIC_API_KEY
|
||||
sync: false
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
# PaaS Deployment (Fly.io / Railway / Render)
|
||||
|
||||
Flynn can run on common PaaS platforms using the repo `Dockerfile`.
|
||||
|
||||
Key requirements:
|
||||
|
||||
- Bind on all interfaces: set `server.localhost: false`.
|
||||
- Use the platform port: Flynn supports `PORT` env override (it overrides `server.port`).
|
||||
|
||||
This repo includes a PaaS-friendly config template at `config/paas.yaml`.
|
||||
|
||||
## Fly.io
|
||||
|
||||
Template: `deploy/flyio/fly.toml`
|
||||
|
||||
```bash
|
||||
# Create app
|
||||
fly apps create
|
||||
|
||||
# Create persistent data volume (sessions + memory)
|
||||
fly volumes create flynn_data --size 1
|
||||
|
||||
# Set required secrets
|
||||
fly secrets set ANTHROPIC_API_KEY=sk-ant-...
|
||||
|
||||
# Deploy
|
||||
fly deploy -c deploy/flyio/fly.toml
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
||||
- The Docker image ships a default config at `/config/config.yaml` (from `config/paas.yaml`).
|
||||
- If you want to supply your own config, set `FLYNN_CONFIG` to your path or mount a file at `/config/config.yaml`.
|
||||
|
||||
## Railway
|
||||
|
||||
Railway can deploy directly from this repo using the `Dockerfile`.
|
||||
|
||||
Checklist:
|
||||
|
||||
- Add env var `ANTHROPIC_API_KEY`.
|
||||
- Ensure your config binds externally (`server.localhost: false`) or use the baked-in `config/paas.yaml`.
|
||||
|
||||
Optional template: `deploy/railway/railway.toml`
|
||||
|
||||
## Render
|
||||
|
||||
Render can deploy directly from this repo using the `Dockerfile`.
|
||||
|
||||
Checklist:
|
||||
|
||||
- Add env var `ANTHROPIC_API_KEY`.
|
||||
- Ensure your config binds externally (`server.localhost: false`) or use the baked-in `config/paas.yaml`.
|
||||
|
||||
Optional blueprint: `deploy/render/render.yaml`
|
||||
|
||||
@@ -7,6 +7,7 @@ This guide covers deploying Flynn in a production environment.
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Docker Deployment](#docker-deployment)
|
||||
- [Nix Deployment](#nix-deployment)
|
||||
- [PaaS Deployment](#paas-deployment)
|
||||
- [Systemd Service](#systemd-service)
|
||||
- [Security](#security)
|
||||
- [Configuration](#configuration)
|
||||
@@ -101,6 +102,10 @@ export OPENAI_API_KEY=sk-...
|
||||
If you use Nix, this repo ships a flake (package + dev shell + optional NixOS
|
||||
module). See `docs/deployment/NIX.md`.
|
||||
|
||||
## PaaS Deployment
|
||||
|
||||
Templates and notes for Fly.io / Railway / Render are in `docs/deployment/PAAS.md`.
|
||||
|
||||
## Systemd Service
|
||||
|
||||
### Service File
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
# Milestone 6 (P3): Deployment Targets (Nix + Fly/Railway/Render)
|
||||
|
||||
Date: 2026-02-16
|
||||
|
||||
## Goals
|
||||
|
||||
- Provide a Nix flake/package that builds `dist/` and preserves `dist/gateway/ui` adjacency.
|
||||
- Provide an optional NixOS module for running Flynn as a systemd service.
|
||||
- Add first-class docs and templates for Fly.io / Railway / Render.
|
||||
- Ensure PaaS network binding works (`server.localhost: false`) and port binding works (`PORT` env override).
|
||||
|
||||
## Implementation
|
||||
|
||||
### Nix
|
||||
|
||||
- Added `flake.nix` with:
|
||||
- `packages.flynn` / `packages.default`
|
||||
- `apps.default` (`nix run`)
|
||||
- `devShells.default` (`nix develop`)
|
||||
- `overlays.default` (exposes `pkgs.flynn`)
|
||||
- `nixosModules.flynn`
|
||||
- Added Nix package definition: `nix/package.nix` (builds via `pnpm build`).
|
||||
- Added NixOS module: `nix/module.nix` (`services.flynn.*`).
|
||||
- Added docs: `docs/deployment/NIX.md`.
|
||||
|
||||
### PaaS
|
||||
|
||||
- Added a PaaS-friendly config template: `config/paas.yaml` (`server.localhost: false`).
|
||||
- Updated `Dockerfile` to ship a default config at `/config/config.yaml` so the image is runnable without a bind-mount.
|
||||
- Added templates:
|
||||
- Fly.io: `deploy/flyio/fly.toml`
|
||||
- Railway: `deploy/railway/railway.toml`
|
||||
- Render: `deploy/render/render.yaml`
|
||||
- Added docs: `docs/deployment/PAAS.md`.
|
||||
|
||||
## Acceptance Notes
|
||||
|
||||
- `pnpm build` still copies gateway UI to `dist/gateway/ui` (required adjacency).
|
||||
- `PORT` env override is implemented in `src/config/loader.ts` (completed earlier on 2026-02-16).
|
||||
- For PaaS/container routing, use `server.localhost: false` (baked into `config/paas.yaml`).
|
||||
|
||||
+23
-1
@@ -72,6 +72,28 @@
|
||||
"test_status": "Not run (Nix build requires pnpmDepsHash update); pnpm test suite unaffected"
|
||||
},
|
||||
|
||||
"deployment-targets-paas": {
|
||||
"file": "2026-02-16-deployment-targets.md",
|
||||
"status": "completed",
|
||||
"date": "2026-02-16",
|
||||
"updated": "2026-02-16",
|
||||
"summary": "Added PaaS deployment templates and docs for Fly.io / Railway / Render, plus a PaaS-friendly config template (server.localhost: false) and a Docker image default /config/config.yaml for easier platform deployment.",
|
||||
"files_created": [
|
||||
"docs/plans/2026-02-16-deployment-targets.md",
|
||||
"docs/deployment/PAAS.md",
|
||||
"config/paas.yaml",
|
||||
"deploy/flyio/fly.toml",
|
||||
"deploy/railway/railway.toml",
|
||||
"deploy/render/render.yaml"
|
||||
],
|
||||
"files_modified": [
|
||||
"Dockerfile",
|
||||
"README.md",
|
||||
"docs/deployment/PRODUCTION.md"
|
||||
],
|
||||
"test_status": "pnpm test suite unaffected (deployment/docs changes)"
|
||||
},
|
||||
|
||||
"openclaw-gap-roadmap": {
|
||||
"file": "2026-02-15-openclaw-gap-roadmap.md",
|
||||
"status": "planned",
|
||||
@@ -2176,7 +2198,7 @@
|
||||
"tier2_completion": "4/4 (100%) — inbound webhooks, vector memory search, Dockerfile, heartbeat monitor",
|
||||
"tier3_completion": "5/5 (100%) — lane queue, credential redaction, web UI token dashboard, xAI (Grok) provider, Voyage AI embeddings",
|
||||
"tier4_completion": "4/4 (100%) — gateway lock, shell completion, Tailscale Serve/Funnel, DM pairing codes",
|
||||
"feature_gap_scorecard": "103/128 match (80%), 0 partial (0%), 25 missing (20%)",
|
||||
"feature_gap_scorecard": "104/128 match (81%), 0 partial (0%), 24 missing (19%)",
|
||||
"operator_dx_milestone": "Phase 3 (Live Ops Dashboard): 2/2 plans complete — milestone done",
|
||||
"gmail_auth_cli": "flynn gmail-auth command implemented with OAuth2 flow, doctor check, config routed to Telegram",
|
||||
"native_audio_support": "completed — smart routing for native audio (Gemini/OpenAI/GitHub) vs Whisper transcription fallback",
|
||||
|
||||
Reference in New Issue
Block a user