Quickstart

Go from a GitHub repo to a private app your teammates can open, in five steps.

Note Foyr is in early access. You need an invite from the waitlist before you can connect a repo.

Before you start

You need a GitHub account and an app in a repository. Foyr builds Next.js today. Node and Python are next, and any app with a Dockerfile works.

1. Join the waitlist

Join the waitlist on the Foyr website with the email you use for GitHub. We're onboarding in small batches and email you when your spot opens.

2. Connect GitHub

In the dashboard, choose New app and install the Foyr GitHub app on the repositories you pick. Access is read-only and per repo.

Tip Only pick the repos you want to deploy. You can add more later from your GitHub settings.

3. Push

Push to your default branch. Your app gets a URL like acme-crm.foyrapps.online.

Terminal

git push origin main

What happens on push

Stage	What Foyr does
Detect	Finds your framework and package manager.
Build	Builds your app into a container image.
Health check	Starts the new version and waits for it to respond.
Go live	Switches traffic with zero downtime.

Warning If the health check fails, the new version never goes live. The previous version keeps serving, and the build log shows why.

4. Invite a teammate

Open Members, add their email and pick a role: owner, admin, member or viewer. They get a magic link and sign in without a password.

Teammate

opens your URL

Foyr proxy

checks login and role

Your app

reads the user

Every request passes the Foyr proxy before it reaches your app.

5. Read the user in code

The proxy passes the signed-in user to your app. Read it with getUser:

import { getUser } from "@foyr/auth";
 
export async function GET(req: Request) {
  const user = getUser(req); // { id, email, role }
  return Response.json({ hello: user.email });
}

The SDK is optional. Without it, read the same user from the request header the proxy adds. See How auth works.

PreviousIntroduction NextHow auth works

Last updated 26 Sep 2026