> ## Documentation Index
> Fetch the complete documentation index at: https://getfloo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Build an Astro app on floo

> Deploy an Astro app with server rendering, Postgres, sign-in, and a custom domain.

From an Astro 7 project on GitHub to a live app at `https://<app>.getfloo.app`, with server-rendered pages, managed Postgres, signed-in users, and your own domain.

New to floo? Start with the [Quickstart](https://getfloo.com/docs/introduction.md).

## What your agent controls

floo builds the `Dockerfile` in your repository. Add one that specifies the runtime for your app:

* The base image and the exact Node version.
* System packages, such as `ffmpeg` or Chromium for headless browsing, each one `apt-get install` line.
* The build steps and the start command.
* More services from the same repository, such as a background worker or a [cron job](https://getfloo.com/docs/guides/cron-jobs.md).

Declare services, managed Postgres, sign-in, and domains in `floo.app.toml`. Store secrets outside git.

## 1. Add a Dockerfile

Server rendering needs the [Node adapter](https://docs.astro.build/en/guides/integrations-guide/node/) in standalone mode:

```bash theme={null}
npx astro add node
```

```js astro.config.mjs theme={null}
import { defineConfig } from "astro/config";
import node from "@astrojs/node";

export default defineConfig({
  output: "server",
  adapter: node({ mode: "standalone" }),
});
```

```dockerfile Dockerfile theme={null}
FROM node:22-slim AS deps
WORKDIR /app
COPY package.json package-lock.json ./
RUN npm ci

FROM node:22-slim AS build
WORKDIR /app
COPY --from=deps /app/node_modules ./node_modules
COPY . .
RUN npm run build
RUN npm prune --omit=dev

FROM node:22-slim
WORKDIR /app
ENV NODE_ENV=production \
    HOST=0.0.0.0
COPY --from=build /app/node_modules ./node_modules
COPY --from=build /app/dist ./dist
CMD ["node", "./dist/server/entry.mjs"]
```

The standalone server reads `PORT` from the environment. `HOST=0.0.0.0` makes it listen on every interface, which floo needs to reach it. Add a `.dockerignore` listing `node_modules` and `dist`.

For a fully static Astro site, keep the default `output: "static"` and serve `dist/` from a small web server image that listens on `$PORT`.

## 2. Initialize the floo config

Install the CLI and sign in: `curl -fsSL https://getfloo.com/install.sh | bash`, then `floo auth login`. An agent can run the same journey over the HTTP API instead, starting from [getfloo.com/agents.md](https://getfloo.com/agents.md).

```bash theme={null}
floo init my-astro-app
```

For a single-service Astro app:

```toml floo.app.toml theme={null}
[app]
name = "my-astro-app"

[services.web]
type = "web"
path = "."
port = 4321
ingress = "public"
dev_command = "npm run dev -- --port 4321 --host 127.0.0.1 --ignore-lock"
```

After adding Postgres, set `migrate_command` under `[services.web]` to your migration tool, such as `"npx drizzle-kit migrate"`. Keep that tool in `dependencies`, not `devDependencies`, so `npm prune` leaves it in the image, and copy its config and migration files into the final stage. It runs as a one-off job with the new image before traffic moves to it. A failed migration stops the deploy. Use [expand-then-contract migrations](https://getfloo.com/docs/guides/postgres.md#schema-portability-across-dev-and-prod) to keep the schema compatible with both old and new code.

## 3. Connect the repo and deploy

floo builds from your GitHub repository, not local files, so commit first. `floo deploy` pushes the commit and waits until the dev URL is live. The first time, it stops with one link if the floo GitHub App can't read the repository yet: a human opens it and installs the App on the account that owns the repository, then you run `floo deploy` again. See [Give floo access to your GitHub repository](https://getfloo.com/docs/introduction.md#2-give-floo-access-to-your-github-repository).

```bash theme={null}
git add . && git commit -m "feat: floo config + Dockerfile"
floo deploy --preflight
floo deploy
```

No GitHub repository? `floo deploy --hosted` has floo host the repository. See [Deploy without GitHub](https://getfloo.com/docs/deploy/without-github.md).

When it's done:

```bash theme={null}
floo apps show my-astro-app
```

> [!TIP]
>
> **Your Astro app is live** at `https://my-astro-app.getfloo.app`.
>
> Every `git push origin main` ships to dev.

## 4. Add a Postgres database

```toml floo.app.toml theme={null}
[managed.default]
type = "postgres"
```

```bash theme={null}
npm install postgres
git add . && git commit -m "feat: add postgres"
floo deploy --preflight
floo deploy
```

Preflight warns `MANAGED_CREDS_TO_WEB` because the web service receives the database credentials. That is expected when the web service queries the database.

`DATABASE_URL` is injected at runtime. Read it from `process.env`, which the Node server sees when it starts. `import.meta.env` is filled in at build time, when the variable is not set:

```ts src/lib/db.ts theme={null}
import postgres from "postgres";

export const sql = postgres(process.env.DATABASE_URL!);
```

```astro src/pages/index.astro theme={null}
---
import { sql } from "../lib/db";

const [{ now }] = await sql`select now()`;
---
<p>Database time: {now.toISOString()}</p>
```

`postgres` connects on the first query and reads the TLS settings in the URL. Dev and prod each get a separate Postgres database and credentials, with no shared state.

## 5. Add per-user auth

Set `access_mode = "accounts"` and floo handles sign-in:

```toml floo.app.toml theme={null}
[app]
name = "my-astro-app"
access_mode = "accounts"
```

From the next deploy onward, floo's gateway:

* Redirects unauthenticated requests to a hosted login page.
* Validates the session cookie on every request.
* Injects identity headers into every request that reaches your Astro server.

Read them once in middleware, with no auth code, callback handlers, or session storage:

```ts src/middleware.ts theme={null}
import { defineMiddleware } from "astro:middleware";

export const onRequest = defineMiddleware((context, next) => {
  const headers = context.request.headers;
  const email = headers.get("x-floo-user-email");
  const id = headers.get("x-floo-user-id");
  context.locals.user = email && id
    ? { email, id, name: headers.get("x-floo-user-name") }
    : null;
  return next();
});
```

```ts src/env.d.ts theme={null}
declare namespace App {
  interface Locals {
    user: { email: string; id: string; name: string | null } | null;
  }
}
```

Then use `Astro.locals.user` in any page or endpoint:

```astro src/pages/dashboard.astro theme={null}
---
const { user } = Astro.locals;
if (!user) return new Response("Sign in required", { status: 401 });
---
<h1>Hello, {user.name ?? user.email}</h1>
```

Locally, run `floo dev --fixture-user` (see [section 7](#7-local-development-with-dev-credentials)) or send the headers yourself with `curl -H 'X-Floo-User-Email: you@example.com' ...`. Access modes and identity headers in full: [App sign-in](https://getfloo.com/docs/guides/app-auth.md).

## 6. Add a custom domain

Declare the domain in `floo.app.toml`:

```toml theme={null}
[domains."app.example.com"]
service = "web"
```

Commit and push, wait for that commit's dev deploy to go live, then release it
to prod and read the DNS records:

Replace `owner/repo` with your GitHub repository. For a floo-hosted project, see [Environments](https://getfloo.com/docs/guides/environments.md#the-flow).

```bash theme={null}
gh release create v1 --repo owner/repo
```

Wait for the prod deploy to finish, then read the DNS records:

```bash theme={null}
floo domains show app.example.com --app my-astro-app
```

Publish the traffic and certificate CNAME records that `show` prints, then watch
activation:

```bash theme={null}
floo domains watch app.example.com --app my-astro-app
```

Set `site` in `astro.config.mjs` to the custom domain so canonical URLs and the sitemap use it. DNS setup and troubleshooting: [Custom domains](https://getfloo.com/docs/guides/custom-domains.md).

## 7. Local development with dev credentials

```bash theme={null}
floo dev --app my-astro-app
```

Runs `dev_command` locally with `DATABASE_URL` and readable env vars from the app's dev environment: a real connection to your dev Postgres, with no credentials in your shell history. Write-only secrets are withheld; supply separate local values when needed. Prod credentials never reach a local session.

The database exists after the first deploy that declares `[managed.default]`. Before that deploy, `floo dev` starts without `DATABASE_URL`.

To test signed-in flows, add `--fixture-user`:

```bash theme={null}
floo dev --app my-astro-app --fixture-user you@example.com
```

`floo dev` then puts a proxy in front of each accounts-mode service that injects the same `X-Floo-User-*` headers floo's gateway adds in production. The output table shows the raw service URL and the auth-proxied URL; use the auth-proxied one for any path that reads identity headers.

## Common gotchas

* **`/healthz` is reserved.** floo's edge intercepts that exact path. Use `/health` or `/livez`.
* **`--host 127.0.0.1` in `dev_command`.** On macOS the dev server listens on `::1` by default, and the `floo dev --fixture-user` proxy reaches it at `127.0.0.1`. Without the flag, proxied requests fail with an empty reply.
* **`--ignore-lock` in `dev_command`.** When an agent runs `astro dev`, Astro moves the server to the background and the command exits, so `floo dev` reports the service stopped. `--ignore-lock` keeps it in the foreground.
* **`HOST=0.0.0.0` in the final stage.** The standalone server binds `localhost` otherwise, which floo cannot reach.
* **`process.env`, not `import.meta.env`, for runtime values.** `import.meta.env` is replaced at build time. floo passes only `NEXT_PUBLIC_*`, `VITE_*`, and `REACT_APP_*` to the build.
* **Prerendered pages.** A page with `export const prerender = true` is built once, so it cannot read identity headers or query the database per request.

## Next steps

> [card] [App sign-in](https://getfloo.com/docs/guides/app-auth.md)
>
> Identity headers, access policies, and access modes in detail.

> [card] [Environment variables](https://getfloo.com/docs/guides/environment-variables.md)
>
> Secrets, build-time variables, and per-service values.

> [card] [Dockerfiles](https://getfloo.com/docs/guides/dockerfiles.md)
>
> Layer order for fast pushes and recommended multi-stage builds.

> [card] [Production environments](https://getfloo.com/docs/guides/environments.md)
>
> Dev vs prod, promotion, env overrides.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.