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. Build a tool

   Click “Give me an example” to see sample tools, or describe what you need in the agent interface:

   

   The agent will help you set up your systems and tests tools automatically.

3. 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 and an LLM API key (OpenAI, Anthropic, or Gemini)

1. Create .env file

   AUTH_TOKEN=your-secret-token
   LLM_PROVIDER=OPENAI
   LLM_FALLBACK_PROVIDER=ANTHROPIC
   OPENAI_API_KEY=sk-proj-xxxxx
   DATASTORE_TYPE=file
   

   For full environment setup instructions, check out the .env.example.

2. Run

   Run the following command:

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

   • Dashboard: http://localhost:3001
   • GraphQL API: http://localhost:3000?token=your-secret-token
   • REST API: http://localhost:3002

---

Docker Compose

Use docker-compose for a complete setup with PostgreSQL and MinIO (S3-compatible file storage).

Profiles

The docker-compose.yml supports different profiles for flexible deployments:

Command	Services	Use Case
docker compose up	superglue only	Run superglue with external database/storage
docker compose --profile infra up	PostgreSQL + MinIO	Run infrastructure only (connect your own superglue instance)
docker compose --profile all up	superglue + PostgreSQL + MinIO	Full stack in containers

Infrastructure Only (Recommended for Development)

Run PostgreSQL and MinIO in Docker, superglue locally:

docker compose --profile infra up -d

Then configure your .env:

AUTH_TOKEN=your-secret-token
LLM_PROVIDER=GEMINI
GEMINI_API_KEY=your-gemini-key

DATASTORE_TYPE=postgres
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
POSTGRES_USERNAME=superglue
POSTGRES_PASSWORD=superglue
POSTGRES_DB=superglue
POSTGRES_SSL=false

FILE_STORAGE_PROVIDER=minio
S3_ENDPOINT=http://localhost:9000
S3_PUBLIC_ENDPOINT=http://localhost:9000
MINIO_BUCKET_NAME=superglue-files
MINIO_ROOT_USER=minioadmin
MINIO_ROOT_PASSWORD=minioadmin
MINIO_WEBHOOK_AUTH_TOKEN=your-secret-token

Run superglue locally:

npm install && npm run dev

Full Stack

Run everything in Docker:

docker compose --profile all up -d

Services

Service	Ports	Description
superglue	3000, 3001, 3002	GraphQL, Web Dashboard, REST API
postgres	5432	PostgreSQL database
minio	9000, 9001	S3-compatible storage (API, Console)

Access MinIO Console at http://localhost:9001 (default credentials: minioadmin/minioadmin).

---

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:

AUTH_TOKEN=your-secret-token
LLM_PROVIDER=OPENAI
LLM_FALLBACK_PROVIDER=ANTHROPIC
OPENAI_API_KEY=sk-proj-xxxxx

# PostgreSQL
DATASTORE_TYPE=postgres
POSTGRES_HOST=your-postgres-host
POSTGRES_PORT=5432
POSTGRES_USERNAME=superglue
POSTGRES_PASSWORD=secure-password
POSTGRES_DB=superglue
# when using a unsecured postgres db that does not support ssl - like a local docker container, uncomment this:
# POSTGRES_SSL=false

# Credential encryption
MASTER_ENCRYPTION_KEY=generate-with-openssl-rand-hex-32


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

Environment Variables

Variable	Required	Description
AUTH_TOKEN	Yes	Secret for API authentication
DATASTORE_TYPE	Yes	memory, file, or postgres
LLM_PROVIDER	Yes	OPENAI, ANTHROPIC, or GEMINI
LLM_FALLBACK_PROVIDER	No	Optional fallback provider
OPENAI_API_KEY	If active	OpenAI API key
ANTHROPIC_API_KEY	If active	Anthropic API key
GEMINI_API_KEY	If active	Gemini API key
MASTER_ENCRYPTION_KEY	No	Encrypt stored credentials (generate: openssl rand -hex 32)
START_SCHEDULER_SERVER	No	Enable scheduled tools (default: false)

PostgreSQL (when DATASTORE_TYPE=postgres)

Variable	Required	Description
POSTGRES_HOST	Yes	Database host
POSTGRES_PORT	No	Database port (default: 5432)
POSTGRES_USERNAME	Yes	Database user
POSTGRES_PASSWORD	Yes	Database password
POSTGRES_DB	Yes	Database name
POSTGRES_SSL	No	Set to false for local dev

File Storage

Variable	Required	Description
FILE_STORAGE_PROVIDER	No	aws or minio (enables file uploads)
AWS_BUCKET_NAME	If aws	S3 bucket name
AWS_ACCESS_KEY_ID	If aws	AWS access key
AWS_SECRET_ACCESS_KEY	If aws	AWS secret key
S3_ENDPOINT	If minio	MinIO endpoint (e.g., http://localhost:9000)
S3_PUBLIC_ENDPOINT	If minio	Public endpoint for presigned URLs
MINIO_BUCKET_NAME	If minio	Bucket name (default: superglue-files)
MINIO_ROOT_USER	If minio	MinIO admin user
MINIO_ROOT_PASSWORD	If minio	MinIO admin password
MINIO_WEBHOOK_AUTH_TOKEN	If minio	API key for file processing webhooks

---

Next Steps

Core Concepts

Understand systems, tools, and execution

Using the Agent

Build your first tool

MCP Overview

Use superglue tools in your internal GPT, Cursor or Claude