Edge SDK

Deploy Flitt locally on your infrastructure. The Edge SDK is a standalone, lightweight application that stores your data (players, logs, samples) and automatically communicates with the Flitt backend to distribute requests across your instances.

🌐What is the Edge SDK?

The Edge SDK is a self-hosted solution that allows you to keep your gaming data locally while benefiting from Flitt' powerful distributed architecture. Instead of sending all your data to central servers, you run an Edge instance that:

•Stores player data locally in a fast, embedded database
•Centralizes server logs for all your hosted servers
•Automatically syncs with the Flitt network
•Runs as a standalone binary with no external dependencies

Key Features

🚀

Standalone binary

No external dependencies - download and run

💾

BadgerDB

High-performance embedded database included

🔐

Ed25519 Cryptography

Secure communication with the Flitt network

📊

Complete Management

Players, logs, uptime, and samples all in one place

🔄

Auto Sync

Heartbeat system keeps your data synchronized

💻

Cross-Platform

Run on Windows, Linux, macOS, or Docker

Prerequisites

📦

Edge SDK package

Download the prebuilt binary from your dashboard

💻

Linux, Windows, or macOS

Dedicated machine or VPS recommended

🔌

Network Access

Port 8080 (configurable) open for API

📝

Flitt Account

With registration code from dashboard

Minimum machine specs

Recommended baseline to run the Edge SDK reliably on a VPS/dedicated machine.

CPU:1 vCPU minimum
RAM:0.65 GB minimum
Disk:1 GB minimum
Network:Stable outbound access + port 8080 open (or your configured port)
OS:Linux x64 recommended (Windows supported)

These values have been tested by us, assuming a single server handling average data processing workloads. For larger deployments, scale the resources accordingly.

Downloads

Download the Edge SDK binary for your platform:

Linux binary

Windows .exe

Pterodactyl egg (.json)

Quick Start

Linux (Ubuntu/Debian/Alpine)

# 1. Download the Edge SDK.
# 2. Make it executable (if needed)
chmod +x ./flitt-edge-sdk

# 3. Generate configuration
./flitt-edge-sdk --gen-config

# 4. Edit config.yaml with your details
nano config.yaml

# 5. Start the SDK
./flitt-edge-sdk -config config.yaml

Windows (PowerShell)

# 1. Download the Edge SDK.
# 2. Extract it to a folder (example below)
cd C:\\Flitt\\EdgeSDK

# 3. Generate configuration
.\\flitt-edge-sdk.exe --gen-config

# 4. Edit config.yaml

# 5. Start the SDK
.\\flitt-edge-sdk.exe -config config.yaml

Minimal Configuration

The Edge SDK generates a default config.yaml file. Here's the minimal configuration needed:

server:
  host: 0.0.0.0
  port: 8080

database:
  path: ./data/edge.db

instance:
  registration_code: "VVBS-XXXX-XXXX-XXXX"

💡 Note: VVBS-XXXX-XXXX-XXXX with your actual registration code from the Flitt dashboard.

Full Configuration Reference

server:
  host: 0.0.0.0          # Listen address
  port: 8080             # API port

database:
  path: ./data/edge.db   # Database storage path
  max_connections: 10    # Max DB connections

instance:
  registration_code: "${REGISTRATION_CODE}" # Required for first registration
  id: ""                 # Auto-set after registration
  name: ""               # Defaults to hostname if empty
  state_path: ./data/instance.json # Instance state file
  edge_url: ""           # Defaults to backend URL
  edge_port: 8080         # Defaults to server.port

Backend URLs, heartbeat/reconnect timing, feature flags, and key management are handled automatically and are not configurable in config.yaml.

How It Works

Registration

The Edge SDK registers itself with the Flitt backend using your registration code.

Local Storage

All your data (players, logs, samples) is stored in BadgerDB on your machine.

Heartbeat Sync

The SDK periodically sends heartbeats to Flitt, keeping your instance status up-to-date.

Request Routing

Flitt automatically routes requests to your Edge instances, keeping data close to home.

Troubleshooting

❌ SDK won't start

./flitt-edge-sdk -config config.yaml 2>&1 | head -20

Check your configuration file is valid YAML and all required fields are present.

❌ Reset database

rm -rf ./data/*
./flitt-edge-sdk --gen-config

Remove the data directory to reset the local database.

Migrating to Edge SDK

If you're currently using the hosted solution, you can migrate to Edge SDK:

1️⃣

Generate registration code

Get your code from the Flitt dashboard under Edge instances

2️⃣

Set up Edge SDK

Follow the Quick Start guide above

3️⃣

Migrate from the dashboard

Use /dashboard/edge to move a cloud server to your Edge SDK instance.

4️⃣

Verify

Check the dashboard to see data flowing to your Edge instance