Skip to content
Documentation

Setup

Section titled “Hosted Version (Recommended)”

Get started in under 5 minutes with no infrastructure setup.

  1. Sign up at app.superglue.cloud

    Or book a demo to talk to our team first.

  2. Connect a system

    Click one of the system icons (Slack, Stripe, GitHub, etc.) or describe the system you want to connect in the agent chat:

    Superglue agent interface

    The agent will guide you through authentication and configuration.

  3. Build and test a tool

    Describe what you need — the agent will set up your tool, test it, and let you review before saving.

  4. Execute or schedule

    Save the tool, run it on-demand, schedule it, or trigger via webhook.

Self-Hosted

Section titled “Self-Hosted”

Deploy on your infrastructure for complete control and customizability.

Quick Start

Section titled “Quick Start”

Prerequisites: Docker, a PostgreSQL database, and an LLM API key (OpenAI, Anthropic, or Gemini)

  1. Create .env file

    For full environment setup, see Production Setup below or the .env.example.

  2. Run

    Run the following command:

    Terminal window
    docker run -d \
      --name superglue \
      --env-file .env \
      -p 3001:3001 \
      -p 3002:3002 \
      superglueai/superglue:latest

  3. Access dashboard and API

Local Development

Section titled “Local Development”
Terminal window
git clone https://github.com/superglue-ai/superglue.git
cd superglue
cp .env.example .env

Edit .env with your configuration, then:

Terminal window
npm install
npm run dev

Production Setup

Section titled “Production Setup”

For production deployments:

# ===================
# REQUIRED
# ===================


# Server endpoints (required for web dashboard to connect)
API_PORT=3002
API_ENDPOINT=https://your-domain.com:3002
WEB_PORT=3001
SUPERGLUE_APP_URL=https://your-domain.com:3001


# Authentication (required)
AUTH_TOKEN=your-secret-token
NEXT_PUBLIC_SUPERGLUE_API_KEY=your-secret-token


# LLM Provider: OPENAI, ANTHROPIC, GEMINI, BEDROCK, VERTEX, or AZURE
LLM_PROVIDER=ANTHROPIC
# Provide the API key and model for your chosen provider:
# ANTHROPIC_API_KEY=sk-ant-xxxxx
# ANTHROPIC_MODEL=claude-sonnet-4-5


# GEMINI_API_KEY=your-gemini-key
# GEMINI_MODEL=gemini-2.5-flash


# OPENAI_API_KEY=sk-proj-xxxxx
# OPENAI_MODEL=gpt-4.1


# PostgreSQL (required)
POSTGRES_HOST=your-postgres-host
POSTGRES_PORT=5432
POSTGRES_USERNAME=superglue
POSTGRES_PASSWORD=secure-password
POSTGRES_DB=superglue
# Uncomment for local/unsecured postgres:
# POSTGRES_SSL=false


# Credential encryption (HIGHLY recommended)
# Generate a strong key: openssl rand -hex 32
MASTER_ENCRYPTION_KEY=your-32-byte-encryption-key


# ===================
# OPTIONAL
# ===================


# Web search in agent
# TAVILY_API_KEY=your-tavily-key


# Workflow scheduling (only enable on a single instance)
# START_SCHEDULER_SERVER=false

File Storage

Section titled “File Storage”

File storage (S3 or MinIO) is required for system documentation — including URL scraping, OpenAPI spec fetching, and file uploads. Without it, tools can still be created and executed, but systems won’t have documentation context for the AI agent.

Add to your .env:

FILE_STORAGE_PROVIDER=aws
AWS_ACCESS_KEY_ID=your-access-key
AWS_SECRET_ACCESS_KEY=your-secret-key
AWS_REGION=us-east-1
AWS_BUCKET_NAME=your-bucket-name
AWS_BUCKET_PREFIX=raw

Uploaded files (PDFs, CSVs, etc.) are stored in S3 and automatically parsed after upload.

Next Steps

Section titled “Next Steps”
Core ConceptsUnderstand systems, tools, and execution
Creating a ToolBuild your first tool
MCP OverviewUse superglue tools in your internal GPT, Cursor or Claude