System Requirements
- ✓ Linux (Ubuntu 20.04+, RHEL 8+, Debian 11+)
- ✓ 4 GB RAM minimum (8 GB recommended)
- ✓ 10 GB free disk space
- ✓ Docker Engine 24+ (installer can install this for you)
- ✓ Ports 3001 (app) and 5432 (database)
- ✓ Internet access for image pull (~700 MB one-time)
What Gets Installed
- ✓ DATA Compass application server
- ✓ PostgreSQL 16 database
- ✓ 93 database migrations (auto-applied)
- ✓ Interactive setup wizard (TUI)
- ✓ Admin user creation
- ✓ Auto-generated secrets (JWT, MFA, DB)
- ✓ Health monitoring endpoints
- ✓ Backup and restore tooling
Quick Start
1
Download the installer
A single ~15KB shell script. No dependencies beyond curl or wget.
2
Run the installer
chmod +x compass-setup.sh && sudo ./compass-setup.sh
3
Walk through the setup wizard
The wizard checks prerequisites, installs Docker if needed, generates secrets, pulls images from our registry, and starts all services. You'll answer 6 questions: license, API key, org name, admin email, name, and password.
4
Open DATA Compass
Navigate to http://your-server:3001 and log in with your admin credentials. You're ready to analyze.
Verify Your Download
After downloading, verify the integrity of the installer:
# Download the checksum
curl -fsSL https://github.com/a-uppal/fair-compass/releases/download/v1.0.0/compass-setup.sh.sha256 -o compass-setup.sh.sha256
# Verify
sha256sum -c compass-setup.sh.sha256
curl -fsSL https://github.com/a-uppal/fair-compass/releases/download/v1.0.0/compass-setup.sh.sha256 -o compass-setup.sh.sha256
# Verify
sha256sum -c compass-setup.sh.sha256