Self-Host SchemaFX

Run SchemaFX on your own infrastructure.

SchemaFX is a Fastify-based server. Self-hosting means you run that server yourself.

What you’ll deploy

• A Node.js process that starts SchemaFX.

• A connector for persistence.

• A reverse proxy (optional, recommended).

Required configuration

Set these values via environment variables:

• JWT_SECRET (required)

• PORT (optional, default 3000)

• HOST (optional, default 0.0.0.0)

Prerequisites

• Node.js.

• A place to store data.

Don’t hardcode your JWT secret. Load it from your environment or secret manager.

Minimal Setup

1

Create a Project

mkdir schemafx-server
cd schemafx-server
npm init -y
npm install schemafx
npm install -D tsx

2

Create Your Server Entrypoint

Use the same SchemaFX constructor you use locally. Point your connectors at persistent storage.

Example using the file-based connector:

import SchemaFX, { FileConnector } from 'schemafx';

const file = new FileConnector({
  id: 'file',
  filePath: process.env.SCHEMAFX_DATA_DIR ?? './data'
});

const sfx = new SchemaFX({
  jwtOpts: {
    secret: process.env.JWT_SECRET!
  },
  dataServiceOpts: {
    schemaConnector: { connector: file.id },
    connectionsConnector: { connector: file.id },
    permissionsConnector: { connector: file.id },
    connectors: [
      file
    ]
  }
});

await sfx.listen({
  port: Number(process.env.PORT ?? 3000),
  host: process.env.HOST ?? '0.0.0.0'
});

3

Run it

export JWT_SECRET='replace-me'
export SCHEMAFX_DATA_DIR='./data'
export PORT=3000

# TypeScript (no build step)
npx tsx index.ts

# JavaScript
node index.js