Docs
GitHubDiscord

Self-hosting

Run the Zoneless API, dashboard, and database with Docker.

The steps below start a local instance on Solana devnet. For a public mainnet instance, follow Deployment after testing locally.

Prerequisites

1Run Zoneless with Docker

Clone the repository, then build and start the containers.

Start Zoneless
git clone https://github.com/zonelessdev/zoneless.git
cd zoneless
docker compose up -d --build

2Check the containers

Confirm that the containers are running and the API health check succeeds. The first build may take a few minutes.

Verify the installation
docker compose ps
curl http://localhost/api/health

3Complete the setup wizard

Open localhost/setup. Create your account, generate an API key, and create or connect a Solana wallet.

4Connect to the API

Use the API key from setup and http://localhost as the base URL. See Authentication for key handling.

Initialize against your instance
import { Zoneless } from '@zoneless/node';

const apiKey = process.env.ZONELESS_API_KEY;

if (!apiKey) {
  throw new Error('Missing Zoneless API key');
}

const zoneless = new Zoneless(apiKey, 'http://localhost');

Next steps