This guide walks you through deploying and managing your own instance of Superglue for complete control over your data processing pipeline.

​
Prerequisites

Before you begin, ensure you have:

  • Docker (version 20.10.0 or higher)
  • Redis (version 6.0 or higher) for persistent storage
  • OpenAI or Gemini API key
  • At least 2GB of RAM and 1 CPU core
  • Git (optional, for building from source)

​
Deployment Options

  1. Create a Docker Compose File

Create a docker-compose.yml file:

version: '3.8'

services:
  superglue:
    image: superglueai/superglue:latest
    ports:
      - "3000:3000"  # GraphQL API
      - "3001:3001"  # Web Dashboard
    environment:
      - NODE_ENV=production
    env_file:
      - .env
    depends_on:
      - redis
    restart: unless-stopped

  redis:
    image: redis:6.2-alpine
    ports:
      - "6379:6379"
    command: redis-server --requirepass ${REDIS_PASSWORD}
    volumes:
      - redis_data:/data
    restart: unless-stopped

volumes:
  redis_data:
  1. Configure Environment Variables

Copy .env.example to .env and fill in your values. Here are all available variables:

# Port for the Superglue server
GRAPHQL_PORT=3000

# Endpoint for the graphql api (used so the web dashboard knows where to find the server)
GRAPHQL_ENDPOINT=http://localhost:3000

# Port for the web dashboard 
WEB_PORT=3001
# Authentication token for API access
AUTH_TOKEN=your-secret-token

# Datastore type (redis or memory or file)
DATASTORE_TYPE=file

# if file, the path to the datastore directory
# if not given or existing, the datastore will be created in the current directory
STORAGE_DIR=/data

# AI Provider - OPENAI or GEMINI
# best performance / price ratio right now is GEMINI with gemini-2.5-flash-preview-04-17
LLM_PROVIDER=GEMINI

# If GEMINI: Your Google API key
# You can get one here : https://aistudio.google.com/app/apikey
GEMINI_API_KEY=XXXXXXX
# Gemini model to use. We recommend gemini-2.5-flash-preview-04-17
GEMINI_MODEL=gemini-2.5-flash-preview-04-17

# If OPENAI: Your OpenAI API key
# You can get one here : https://platform.openai.com/api-keys
OPENAI_API_KEY=sk-proj-XXXXXXXX
# OpenAI model to use. Use gpt-4.5-preview-2025-02-27 for best results or gpt-4o for speed / cost.
OPENAI_MODEL=gpt-4o
# Optional: Set a custom OpenAI API URL (for self-hosted models or providers like fireworks.ai)
# for fireworks, use https://api.fireworks.ai/inference/v1
OPENAI_API_BASE_URL=https://api.openai.com/v1

# Disable the welcome/onboarding screen for development
NEXT_PUBLIC_DISABLE_WELCOME_SCREEN=false
  1. Start the Services
docker-compose up -d

​
Option 2: Manual Docker Setup

If you prefer more control over the container setup:

  1. Pull the Docker Image
docker pull superglueai/superglue
  1. Create a Docker Network
docker network create superglue-network
  1. Start Redis
docker run -d \
  --name superglue-redis \
  --network superglue-network \
  -v redis_data:/data \
  -p 6379:6379 \
  redis:6.2-alpine \
  redis-server --requirepass your-secure-password
  1. Start Superglue
docker run -d \
  --name superglue \
  --network superglue-network \
  --env-file .env \
  -p 3000:3000 \
  -p 3001:3001 \
  superglueai/superglue

​
Health Checks and Monitoring

​
Basic Health Check

curl http://localhost:3000/health

Expected response: OK

​
Monitoring Endpoints

  • Dashboard: http://localhost:3001/
  • GraphQL Playground: http://localhost:3000/graphql

​
Other Considerations

  1. Network Security

    • Use reverse proxy (nginx/traefik) for TLS termination
    • Implement IP whitelisting if needed
    • Keep access to the dashboard private since it is not protected by auth, or implement nginx basic auth to protect it

  2. Authentication

    • Change default AUTH_TOKEN
    • Use strong Redis passwords
    • Rotate credentials regularly

  3. Telemetry

    • Superglue uses telemetry to understand how many users are using the platform.
    • You can opt out by setting the DISABLE_TELEMETRY environment variable to true.

​
Performance Tuning

​
Redis Configuration

Optimize Redis for your workload:

maxmemory 2gb
maxmemory-policy allkeys-lru
appendonly yes

​
Resource Allocation

Recommended minimum resources:

  • 2 CPU cores
  • 4GB RAM
  • 20GB storage

​
Troubleshooting

​
Common Issues

  1. Connection Refused

    • Check if containers are running: docker ps
    • Verify network connectivity: docker network inspect superglue-network

  2. Authentication Failed

    • Verify if the query params token or the Authorization Bearer is present and set to AUTH_TOKEN in the .env file
    • Check Redis credentials

  3. High Memory Usage

    • Monitor Redis memory: docker stats
    • Adjust cache settings
    • Consider upgrading resources

​
Logs

Access container logs:

# Superglue logs
docker logs superglue

# Redis logs
docker logs superglue-redis

# Follow logs
docker logs -f superglue

​
Upgrading

  1. Pull Latest Image
docker pull superglueai/superglue:latest
  1. Update Services
docker-compose down
docker-compose up -d

​
Support and Resources