Setup

The 5 minute guide to building your first superglue tool

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:

   

   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

Deploy on your infrastructure for complete control and customizability.

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:

   docker run -d \
     --name superglue \
     --env-file .env \
     -p 3001:3001 \
     -p 3002:3002 \
     superglueai/superglue:latest
   
3. Access dashboard and API

   • Dashboard: http://localhost:3001
   • REST API: http://localhost:3002

---

Local Development

git clone https://github.com/superglue-ai/superglue.git
cd superglue
cp .env.example .env

Edit .env with your configuration, then:

npm install
npm run dev

---

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

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.

AWS S3

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.

MinIO (Self-Hosted)

MinIO is an S3-compatible object store you can run alongside superglue.

Add to your .env:

FILE_STORAGE_PROVIDER=minio
S3_ENDPOINT=http://minio:9000
S3_PUBLIC_ENDPOINT=http://localhost:9000
MINIO_ROOT_USER=minioadmin
MINIO_ROOT_PASSWORD=change-me-in-production
MINIO_BUCKET_NAME=superglue-files
MINIO_BUCKET_PREFIX=raw

Uploaded files are stored in MinIO and automatically parsed after upload.

---

Next Steps

Core Concepts

Understand systems, tools, and execution

Creating a Tool

Build your first tool

MCP Overview

Use superglue tools in your internal GPT, Cursor or Claude