Welcome to SplitQuest On-Premise

For optimal performance, we recommend:

• CPU: 2+ cores (64-bit), 4+ cores recommended for production
• RAM: 4GB minimum, 8GB+ recommended for heavy document processing
• Storage: 10GB+ available space (5GB for application, 5GB+ for documents)
• OS: Linux (Ubuntu 22.04+, CentOS 7+, RHEL 8+), Windows 10+ with WSL2, macOS 10.15+
• Docker: Engine 20.10+ and Compose 2.0+
• Network: Ports 80 and 443 available, internet connectivity for initial setup

Verification commands:

# Check system resources
df -h  # Should show 10GB+ available
free -h  # Should show 4GB+ available
docker --version  # Should be 20.10+
docker compose --version  # Should be 2.0+

Yes, but ONLY through WSL2! SplitQuest On-Premise does not support direct Windows Server installation. You must use WSL2 (Windows Subsystem for Linux) for all Windows deployments.

Required Setup Steps:

1. Install Windows Subsystem for Linux 2 (WSL2): wsl --install -d Ubuntu
2. Install Docker Desktop with WSL2 backend
3. Enable WSL2 integration in Docker Desktop settings
4. Run ALL installation commands from a WSL2 terminal (never PowerShell/CMD)

Yes! SplitQuest On-Premise runs excellently on macOS using Docker Desktop for Mac. Requirements:

1. macOS 10.15+ (Catalina or later) - works on both Intel and Apple Silicon (M1/M2/M3)
2. Install Xcode Command Line Tools: xcode-select --install
3. Install Docker Desktop for Mac (download from docker.com or use Homebrew)
4. Configure adequate resources in Docker Desktop settings (4GB+ RAM, 2+ CPU cores)

Platform performance ranking for SplitQuest On-Premise:

After installation, verify everything is working:

# Check if containers are running (should show all services as 'Up')
docker compose -f docker-compose.onprem.yml ps

# View application logs (should show successful startup)
docker compose -f docker-compose.onprem.yml logs splitquest_web | tail -20

# Test web interface (should return HTTP 200)
curl -I http://localhost/health

# Test database connectivity
docker compose -f docker-compose.onprem.yml exec mysql mysql -u splitquest -p splitquest_onprem -e "SELECT 1;"

Expected results:

• All containers should show status 'Up'
• Health check should return HTTP 200 OK
• Web interface should be accessible at http://localhost
• Database connection should succeed

If issues occur: Check the installation logs with docker compose -f docker-compose.onprem.yml logs

To obtain an on-premise license:

1. Contact our sales team at [email protected]
2. Provide your organization details and use case
3. Receive a quote based on your requirements
4. After purchase, you'll receive your license key
5. Configure this in your .env file

Yes! We offer a 30-day trial license for evaluation purposes. Contact our sales team to request a trial license. The trial includes:

• Full feature access
• Processing up to 1,000 documents
• Technical support during evaluation
• Migration assistance if you decide to purchase

When your license expires:

• The application will display warnings 30 days before expiration
• Processing capabilities will be limited after expiration
• Existing data and documents remain accessible
• Contact sales to renew your license before expiration

We recommend setting up license renewal alerts in your calendar.

SplitQuest On-Premise uses MySQL as the database, which is pre-configured in the Docker deployment. The MySQL database is automatically set up when you run the installation script.

# MySQL Database Configuration in .env
MYSQL_DATABASE=splitquest_onprem
MYSQL_USER=splitquest
MYSQL_PASSWORD=your_secure_mysql_password_here
MYSQL_HOST=mysql
MYSQL_PORT=3306
MYSQL_ROOT_PASSWORD=your_secure_root_password_here

Why MySQL?

• Proven stability: MySQL is battle-tested for production workloads
• Excellent performance: Optimized for the SplitQuest document processing workflow
• Easy management: Simple backup, restore, and maintenance procedures
• Wide compatibility: Works seamlessly across all supported platforms (Linux, macOS, Windows with WSL2)

SplitQuest provides automated SSL/HTTPS setup using Let's Encrypt certificates. To configure HTTPS:

1. Configure your domain in the .env file:

   # In your .env file
   DOMAIN=your-domain.com
   [email protected]
   LETSENCRYPT_STAGING=false  # Set to true for testing

2. Ensure DNS is configured: Point your domain's A record to your server's IP address
3. Run the SSL setup script: ./setup-ssl.sh --production

The script will automatically:

• Request SSL certificates from Let's Encrypt
• Configure nginx for HTTPS
• Set up automatic certificate renewal
• Enable HTTP to HTTPS redirection

Yes! Configure custom storage paths in your .env file:

# Storage Configuration in .env
STORAGE_TYPE=local
LOCAL_STORAGE_PATH=/custom/path/to/storage

# Maximum file size in MB
MAX_FILE_SIZE_MB=1000

# Storage cleanup settings
STORAGE_CLEANUP_ENABLED=true
STORAGE_CLEANUP_DAYS=30

Alternative: S3 Storage

# S3 Storage Configuration in .env
STORAGE_TYPE=s3
AWS_BUCKET_NAME=your-bucket-name
AWS_ACCESS_KEY=your-access-key
AWS_SECRET_KEY=your-secret-key
AWS_REGION=us-east-1

Follow this troubleshooting checklist:

1. Check Docker status: docker --version && docker compose --version
2. Verify configuration file: cat .env | grep -E "LICENSE_KEY|MYSQL_PASSWORD" | head -2
3. Check port availability: netstat -tulpn | grep -E ":80|:443|:3306"
4. Review installation logs: docker compose -f docker-compose.onprem.yml logs --tail=50
5. Check system resources: df -h && free -h
6. Re-run installation: Run ./install.sh again - it includes validation and will show specific errors.

Permission issues vary by platform. Here are platform-specific solutions:

Platform-specific Docker troubleshooting steps:

# Check Docker service status
sudo systemctl status docker

# Start Docker if not running
sudo systemctl start docker
sudo systemctl enable docker

# Check Docker daemon logs
sudo journalctl -fu docker

# Verify Docker installation
docker version
docker info

# Check available resources
df -h
free -h

# Check WSL2 status (in PowerShell)
wsl --list --verbose

# Ensure WSL2 integration is enabled in Docker Desktop
# Docker Desktop > Settings > Resources > WSL Integration

# Check Docker in WSL2 terminal
docker version
docker info

# Restart Docker Desktop if needed
# Right-click Docker Desktop > Restart

# Check WSL2 resources
wsl --shutdown
# Then restart WSL2 terminal

# Check Docker Desktop status
docker version
docker info

# Restart Docker Desktop
# Docker Desktop > Troubleshoot > Restart

# Check resource allocation
# Docker Desktop > Settings > Resources
# Ensure 4GB+ RAM, 2+ CPU cores allocated

# Check Docker Desktop logs
# Docker Desktop > Troubleshoot > Get support

# Clear Docker cache if needed
docker system prune -a

Create regular backups of your SplitQuest data:

1. Database backup: docker compose -f docker-compose.onprem.yml exec mysql mysqldump -u splitquest -p splitquest_onprem > backup-$(date +%Y%m%d).sql
2. Document storage backup: tar -czf documents-backup-$(date +%Y%m%d).tar.gz ./data/documents/ ./data/uploads/
3. Configuration backup: cp .env config-backup-$(date +%Y%m%d).env
4. Complete backup script: #!/bin/bash DATE=$(date +%Y%m%d) docker compose -f docker-compose.onprem.yml exec mysql mysqldump -u splitquest -p splitquest_onprem > backup-$DATE.sql tar -czf splitquest-backup-$DATE.tar.gz .env docker-compose.onprem.yml ./data/ backup-$DATE.sql

Tip: Set up automated backups using cron jobs for regular data protection. Store backups in a separate location from your SplitQuest installation.