Skip to content

Setup

Choose superglue Cloud for the fastest setup, or run the open-source version in your own environment.

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 it through a webhook.

Open-source version (self-hosted)

Section titled “Open-source version (self-hosted)”

Prerequisites: Docker, a PostgreSQL database, S3-compatible object storage (AWS S3 or MinIO), and an LLM API key.

  1. Create .env file

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

    Object storage is a required dependency. Configure either AWS S3 or MinIO before starting superglue. The container command below starts only superglue, so PostgreSQL and object storage must already be running and reachable from the container.

  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
# Optional: start the bundled PostgreSQL and MinIO services.
docker compose --profile infra up -d postgres minio minio-init


npm install
npm run dev

When using the bundled infrastructure, set POSTGRES_HOST=localhost, S3_PROVIDER=minio, S3_ENDPOINT=http://localhost:9000, and S3_PUBLIC_ENDPOINT=http://localhost:9000 in .env.

Production setup

Section titled “Production setup”

For production deployments:

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


# Deployment
DEPLOYMENT_MODE=enterprise


# Public endpoints
API_PORT=3002
WEB_PORT=3001
PUBLIC_API_URL=https://your-domain.com:3002
PUBLIC_APP_URL=https://your-domain.com:3001


# Authentication and encryption
# Generate separate values with: openssl rand -hex 32
JWT_AUTH_SECRET=replace-with-random-secret
INTERNAL_API_TOKEN=replace-with-different-random-secret
MASTER_ENCRYPTION_KEY=replace-with-random-encryption-secret
AUTH_PROVIDERS=email_password
AUTH_DISABLE_SIGNUP=false
AUTH_DISABLE_INVITES=false
# Set false only when superglue must connect to private or on-prem systems.
BLOCK_LOCAL_REQUESTS=true


# PostgreSQL
POSTGRES_HOST=your-postgres-host
POSTGRES_PORT=5432
POSTGRES_USERNAME=superglue
POSTGRES_PASSWORD=secure-password
POSTGRES_DB=superglue
POSTGRES_SSL=true


# Object storage
# This example uses AWS S3. See Object Storage below for MinIO.
S3_PROVIDER=aws
AWS_S3_REGION=us-east-1
AWS_BUCKET_NAME=your-bucket-name
AWS_BUCKET_PREFIX=raw
# Optional: omit these to use the AWS SDK default credential chain.
# AWS_S3_ACCESS_KEY_ID=your-access-key
# AWS_S3_SECRET_ACCESS_KEY=your-secret-key


# LLM provider
PRIMARY_LLM_PROVIDER=gemini
PRIMARY_LLM_MODEL=gemini-2.5-flash
SUMMARIZE_LLM_PROVIDER=gemini
SUMMARIZE_LLM_MODEL=gemini-2.5-flash
GEMINI_API_KEY=your-gemini-key


# Runtime behavior
START_SCHEDULER_SERVER=true
WEB_SEARCH_PROVIDER=disabled


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


# Set these when containers use private service URLs that differ from public URLs.
# INTERNAL_API_URL=http://superglue:3002
# INTERNAL_APP_URL=http://superglue:3001


# Tavily web search
# WEB_SEARCH_PROVIDER=tavily
# WEB_SEARCH_API_KEY=your-tavily-key

Set START_SCHEDULER_SERVER=true on application instances that should claim scheduled work. Set POSTGRES_SSL=false only for a local or otherwise unsecured PostgreSQL server. BLOCK_LOCAL_REQUESTS=true prevents tool execution from reaching private and link-local networks.

Object storage

Section titled “Object storage”

Object storage is required. superglue validates this configuration during startup and has no storage-disabled mode. It stores system documentation, uploads, processed files, and run artifacts in either AWS S3 or MinIO. Choose exactly one provider. Create the bucket before starting superglue and ensure the configured identity can list, read, write, and delete objects in it.

Add to your .env:

S3_PROVIDER=aws
AWS_S3_REGION=us-east-1
AWS_BUCKET_NAME=your-bucket-name
AWS_BUCKET_PREFIX=raw


# Optional: omit these to use an instance role, task role, web identity,
# or another source in the AWS SDK default credential chain.
AWS_S3_ACCESS_KEY_ID=your-access-key
AWS_S3_SECRET_ACCESS_KEY=your-secret-key
# AWS_S3_SESSION_TOKEN=your-session-token

The S3 bucket must already exist. Uploaded files are stored in it and automatically parsed after upload.