Prerequisites

To run a Void platform, you need:

• A Cloudflare account with Workers for Platforms, R2, and Analytics Engine enabled.
• An empty hosted PostgreSQL database.
• An account with your chosen login provider: GitHub, Google, OIDC, or Cloudflare Access.
• A domain for your apps, or workers.dev for testing. You can add a domain later.

Void creates the Workers, storage, queues, routing, and database tables through the CLI.

Workers for Platforms requires a paid plan. Your database and Cloudflare usage are billed separately.

Prepare Your Cloudflare Account and Domain

In the Cloudflare dashboard, select the account where you want the platform to live:

1. Open Workers & Pages once to let Cloudflare provision Workers for the account.
2. Open Workers for Platforms and enable its plan. Review Workers for Platforms pricing before confirming.
3. Open R2 Object Storage and complete its activation. Void creates the bucket later.
4. For a domain installation, choose a domain you own, such as example.app. If you need one, register it with your preferred registrar. Use a spare domain's root: apps will be served at my-app.example.app. For workers.dev testing, skip this step and the DNS setup below.

If that domain is already in this Cloudflare account, use its existing zone. Otherwise, add the domain to Cloudflare and follow the nameserver instructions until the zone is active. A zone is Cloudflare's DNS configuration for a domain; creating one does not buy the domain.

You can also let Void create the zone during installation. Setting it up now lets you scope the API tokens to that zone and finish installation without a DNS pause. The platform API uses workers.dev by default, so it needs no additional domain.

If Cloudflare rejects Analytics Engine

The platform stores request metrics and logs in Analytics Engine. If installation stops with "You need to enable Analytics Engine" (code 10089), add an Analytics Engine binding to a Worker that is not part of the platform under Settings > Bindings, and deploy it once from the dashboard. A new Hello World Worker works. Do not edit the platform's own Workers. Then run the printed void platform install --resume command.

Install the CLI and Preview

With Node.js 24.21.0 or later, install the CLI:

pnpm add --global void
void platform install --plan

Sign in to Cloudflare when prompted, then choose an installation name and account. --plan previews the resources without changing them or requiring runtime secrets. Completed plans save your choices locally. Run void platform install again to select a saved plan; Void checks the current Cloudflare state before asking you to apply it.

For a domain installation, use these answers. Testing mode skips the application domain, zone, and catch-all questions:

Prompt	Answer
Installation name	A short name, such as team
Application base domain	Your domain, such as example.app
Cloudflare zone	The same domain
Platform display name	Any name your team will recognize
Optional custom API hostname	Leave empty to use workers.dev
Dedicate all unmatched traffic to Void?	Yes only if this whole zone belongs to the platform

Choose an unused installation name in your account. For example, team creates resources such as void-team-api and void-team-proxy.

The preview lists the credentials you will need. Review Credentials, then run the install command printed at the end. The guided installation provides setup links and the login callback when needed.

You can select either path directly:

void platform install --application-domain example.app --plan
void platform install --workers-dev --plan

--workers-dev cannot be combined with --application-domain, --zone, or --dedicated-zone.

Create the Platform Database

Use an empty PostgreSQL database dedicated to this platform. It stores users, projects, and deployments; individual apps can still use D1. Void creates the tables and the Hyperdrive connection, but does not provision the PostgreSQL server.

Use any PostgreSQL provider that accepts connections from your computer and Cloudflare:

1. Create a fresh database or project dedicated to the platform, with no existing application tables. Use a database role that can create and manage its tables and schemas.
2. Open the provider's connection details and select the primary database. Use a direct connection or a session-mode pooler, not transaction pooling. The connection must work from both your computer and Cloudflare.
3. Copy the PostgreSQL connection URL, including the password and SSL settings, into your password manager. Paste only the URL—not a surrounding psql command—into Void's PostgreSQL DATABASE_URL prompt, as the provider gives it, including SSL settings such as sslmode=verify-full. A Hyperdrive that Void creates trusts only public certificate authorities, so if your database uses a private certificate authority, use a separately managed Hyperdrive, as described below.

Provider	Connection setup
PlanetScale Postgres	Choose Postgres, not Vitess/MySQL. Open Connect, create role credentials, and use the direct primary connection on port 5432, not PgBouncer on 6432.
Neon	Open Connect, select the database and owner role, and turn connection pooling off.

Once installation claims the database, continue using that same database for resume and maintenance commands. If installation stops because it cannot use the database, for example because the database is not empty, set VOID_PLATFORM_DATABASE_URL to another database's URL before you resume. Uninstall never deletes external PostgreSQL.

Use a provider CLI

You can create the database and retrieve its connection URL from either provider's CLI instead of its dashboard.

PlanetScale Postgres

Install the latest PlanetScale CLI. On macOS, use brew install pscale; the installation guide also covers Linux and Windows.

Sign in and list your organizations and regions:

pscale auth login
pscale org list
pscale region list --org <organization>

Replace <organization> with your organization slug and choose a region. List the available Postgres cluster sizes and their prices for that region:

pscale size cluster list --org <organization> --engine postgresql --region <region>

Create a dedicated Postgres database with your chosen cluster size, then create a role with permission to create and migrate Void's tables:

pscale database create void-platform \
  --org <organization> \
  --engine postgresql \
  --region <region> \
  --cluster-size <cluster-size> \
  --wait

pscale role create void-platform main void_owner \
  --org <organization> \
  --inherited-roles postgres

Save the DATABASE URL printed by the role-creation command in your password manager and paste it into Void's PostgreSQL DATABASE_URL prompt. Use the direct primary connection on port 5432 with sslmode=verify-full. The role's password is shown when it is created, so save it before closing the terminal.

See PlanetScale's database commands and role commands for more options.

Neon

Install the latest Neon CLI and sign in:

pnpm add --global neon@latest
neon login

Create a dedicated project, database, and owner role. Replace <region-id> with one of Neon's supported regions, such as aws-us-east-2:

neon projects create --name void-platform \
  --database void_platform \
  --role void_owner \
  --region-id <region-id>

Use the project ID from the output to retrieve a direct primary connection URL with TLS certificate verification:

neon connection-string --project-id <project-id> \
  --database-name void_platform \
  --role-name void_owner \
  --endpoint-type read_write \
  --ssl verify-full

Save the printed URL in your password manager and paste it into Void's PostgreSQL DATABASE_URL prompt. Keep this connection unpooled. See Neon's connection-string command for more options.

Use an existing Hyperdrive

The installer can create Hyperdrive for you or use one you manage separately. For an existing configuration:

1. Point it at the dedicated platform database using a runtime user, and disable SQL result caching.
2. Select it in the installer and review the database, host, port, and runtime user.
3. Supply a database owner connection at the PostgreSQL URL prompt so Void can apply migrations.

To create one first, choose Set up a separately managed Hyperdrive and follow the printed instructions or Cloudflare’s setup guide. Rerun the installer once it is ready. Void leaves its configuration under your control. For unattended setup, use the Hyperdrive variables in Install from CI.