SWIRL Enterprise Edition

Notice: this repository is commercially licensed. A valid license key is required for use. Please contact hello@swirlaiconnect.com for more information.

There are two ways to run SWIRL Enterprise from this repository:

1. Quick Start (evaluation) — a local install on a Mac or Linux workstation, running in minutes.
2. Production deployment — a Linux VM with systemd, TLS ingress, and DNS.

See Monitoring and Logs for watching either kind of deployment.

Product documentation lives at docs.swirlaiconnect.com — see the Installation Guide and Quick Start.

Quick Start (evaluation)

git clone https://github.com/swirlai/docker-compose swirl-enterprise-compose
cd swirl-enterprise-compose
cp env.example .env

Edit .env and set the REQUIRED values: SWIRL_LICENSE (the signed license JSON from SWIRL), ADMIN_PASSWORD, SQL_USER, and SQL_PASSWORD. To enable the MCP server, also set MCP_ENABLED=true and SWIRL_MCP_TOKEN.

docker compose pull
docker compose up -d
docker compose logs -f swirl-init   # watch the one-time database setup complete

Then open http://localhost:8000/galaxy/ and log in as admin with the ADMIN_PASSWORD you set.

Monitoring and Logs

Quick Start (docker compose) — from this directory:

docker compose logs -f              # all services, follow
docker compose logs -f swirl        # the SWIRL app only
docker compose logs swirl-init     # one-time database setup
docker compose logs swirl-job      # one-time seed/config job

Application log files — bind-mounted to logs/ in this checkout, so you can tail them directly on the host:

tail -f logs/django.log                  # web/API server
tail -f logs/celery-search-worker.log    # federated search execution

Also present: celery-pagefetch-worker.log, celery-interactive-worker.log, celery-maintenance-worker.log, celery-healthcheck-worker.log, and celery-beats.log.

Production (systemd service):

sudo journalctl -f -u swirl

In the browser: administrators can watch live logs in the Business Console Log Viewer.

Installation

Minimum System Requirements

Linux

• OS: Linux platform (Ubuntu, RHEL)
• Processor: +8 VCPU
• Memory: +16 GB RAM
• Storage: 500 GB available space
• Docker: v28 or later

MacOS

• OS: MacOS 14.5 Sonoma or later
• Processor: Apple Silicon (M1 or later)
• Memory (RAM): 8 GB minimum (16 GB recommended)
• Storage: 100 GB of available disk space for installation
• Docker: v27.3.1 or later

Production Setup Documentation

• Production Deployment (Linux VM + systemd)
• Downloading SWIRL Enterprise
• Description of Docker Support Installation Script
• Details of Setting up the SWIRL Service
  • TLS Scenarios
    • No TLS
    • Bring Your Own Certificate (BYOC)
    • TLS Configuration with Let's Encrypt & Certbot (optional)
  • License
  • Database
    • PostgreSQL
  • Connecting SWIRL to the Enterprise
    • Connecting to Microsoft IDP
    • Connecting to Google IDP
• Controlling SWIRL Service
• Configuring the SWIRL MCP Server (optional)

SWIRL Documentation

Overview | Quick Start | User Guide | Admin Guide | M365 Guide | Developer Guide | Developer Reference | AI Search Guide | AI Search Assistant Guide

Support

For general support, please use the private Slack or Microsoft Teams channel connecting SWIRL and your company. To report an issue please create a ticket.