Platform Documentation

Install the GitHub App, we open an onboarding PR. Try the preview right away, or merge for your first staging deploy.

Getting Started

1

Install the FluxNow GitHub App

Go to the FluxNow GitHub App and connect your GitHub account. Select the repositories you want FluxNow to manage. That's your signup — no separate account creation required.

2

We open a PR for you

No config required. FluxNow auto-detects your runtime, generates manifests and workflows, and opens an onboarding PR in your repo. The first preview is created on that PR, so you can try it without merging.

Want to customize first? Add a fluxnow.yaml in your repo root before merging — we'll use it. Otherwise we'll suggest one in the PR.

Auto-detected runtime
Preview per PR
Custom SSL
Env variables
fluxnow.yaml reference expand for technical details
# fluxnow.yaml is optional — everything is auto-detected.
# Add this file only to override defaults.
version: v1
kind: Service
metadata:
  name: my-app
spec:
  runtime: bun     # auto-detected — any Railpack-supported runtime
  port: 3000       # auto-detected from runtime defaults
  build:
    strategy: auto  # auto | railpack | dockerfile
  env:
    - name: NODE_ENV
      value: production
  secrets:
    - name: DATABASE_URL
      key: database/url
preview:
  db:
    enabled: false  # true = fresh Postgres 18 per PR (pgvector + PostGIS included)

This file is optional — FluxNow auto-detects your runtime, port, and build strategy from your repo. Add fluxnow.yaml only to override defaults or configure secrets and preview databases.

3

Try the preview (or merge for staging)

The onboarding PR creates your first preview environment — you can try it right from the PR. When you're ready for your first staging deploy, merge the PR.

4

Deploy

Preview: Opening or updating any PR creates a preview environment. Staging: Merging to your default branch (e.g. main) triggers a staging deploy. No deploy button — push and merge drive everything.

Staging

Push to main → auto-deployed to staging

Preview

Open a PR → isolated preview environment per branch

Ready to Build?

Install the GitHub App — we'll open an onboarding PR with a preview environment you can try immediately.