Quick Start Guide¶

Get Studio Platform running in minutes with this comprehensive quick start guide.

🚀 Prerequisites¶

System Requirements¶

Software Dependencies¶

• Docker Desktop (Windows/Mac) or Docker Engine (Linux)
• Git for cloning the repository
• Text editor for configuration (VS Code recommended)

📋 Step-by-Step Installation¶

Step 1: Clone the Repository¶

# Clone the Studio repository
git clone https://github.com/OmerRastgar/studio.git
cd studio

Step 2: Configure Environment¶

# Copy the example environment file
cp .env.example .env

Edit the .env file with your preferred text editor:

# Open in VS Code (recommended)
code .env

# Or use nano
nano .env

Step 3: Essential Environment Variables¶

These are the minimum required variables to get Studio running:

# Database Configuration
POSTGRES_USER=studio_user
POSTGRES_PASSWORD=your_secure_password_here
POSTGRES_DB=auditdb

# Security Secrets (Generate strong random strings)
JWT_SECRET=your_jwt_secret_here_32_chars_min
MINIO_SECRET_KEY=your_minio_secret_here_32_chars_min

# Neo4j Configuration
NEO4J_AUTH=neo4j/your_neo4j_password_here

# Fleet Database
FLEET_MYSQL_PASSWORD=your_fleet_mysql_password_here

# AI Configuration (Optional but recommended)
GOOGLE_API_KEY=your_google_api_key_here

# Generate JWT Secret
openssl rand -base64 32

# Generate Database Passwords
openssl rand -base64 24

Step 4: Start the Platform¶

# Build and start all services
docker-compose up -d --build

Step 5: Verify Installation¶

# Check service status
docker-compose ps

# Run health verification
docker-compose exec backend node live-verification/live-all.js

🌐 Accessing Studio¶

Once the services are running, you can access Studio at:

Default Login Credentials¶

✅ Verification Checklist¶

Service Health Check¶

# Check all services are running
docker-compose ps

# Expected output should show "healthy" status for:
# - postgres
# - backend
# - frontend
# - kong
# - kratos
# - redis
# - neo4j
# - minio

Platform Functionality Test¶

1. Login to the main application
2. Create a new project with a compliance framework
3. Upload a sample evidence file
4. Test the AI assistant with a compliance question
5. View the risk dashboard

API Health Check¶

# Test backend API
curl http://localhost/api/health

# Test frontend
curl http://localhost/

# Expected: HTTP 200 OK responses

🔧 Common Setup Issues¶

Port Conflicts¶

If you encounter port conflicts, modify the docker-compose.yml:

# Example: Change frontend port
frontend:
  ports:
    - "3001:3000"  # Changed from 3000:3000

Permission Issues¶

On Linux, you might need to adjust Docker permissions:

# Add user to docker group
sudo usermod -aG docker $USER

# Restart Docker service
sudo systemctl restart docker

Memory Issues¶

If services fail to start due to memory constraints:

1. Increase Docker memory allocation in Docker Desktop settings
2. Or reduce resource limits in docker-compose.yml:

# Example: Reduce backend memory limits
backend:
  deploy:
    resources:
      limits:
        memory: 1G  # Reduced from 2G

Network Issues¶

If services can't communicate:

# Reset Docker networks
docker network prune

# Restart services
docker-compose down
docker-compose up -d

🏗️ Production Considerations¶

Security Enhancements¶

For production deployment, implement these security measures:

1. SSL/TLS Certificates

   # Generate SSL certificates
   ./scripts/generate-certs.sh
   

2. Environment Variables

   # Use production-ready secrets
   JWT_SECRET=$(openssl rand -base64 64)
   

3. Network Security

4. Use firewall rules
5. Implement VPN access
6. Configure intrusion detection

Performance Optimization¶

1. Resource Allocation

   # Increase limits for production
   backend:
     deploy:
       resources:
         limits:
           cpus: '2.0'
           memory: 4G
   

2. Database Optimization

3. Configure connection pooling
4. Enable query caching
5. Set up read replicas

Backup Strategy¶

# Set up automated backups
./scripts/backup-setup.sh

# Manual backup
docker-compose exec postgres pg_dump -U studio_user auditdb > backup.sql

📚 Next Steps¶

Explore Features¶

• User Guide - Learn about all platform features
• Admin Guide - Configure system settings
• Developer Guide - Explore APIs and integrations

Integrations¶

• FleetDM Integration - Set up device management
• Prowler Integration - Configure cloud scanning
• n8n Workflows - Create automation workflows

Advanced Configuration¶

• SSL/TLS Setup - Enable HTTPS
• Monitoring Setup - Configure observability
• Backup & Recovery - Set up data protection

🆘 Getting Help¶

Troubleshooting¶

• Common Issues - Solutions to frequent problems
• Performance Issues - Optimization guides
• Security Issues - Security troubleshooting

Community Support¶

• GitHub Issues - Report bugs and request features
• Documentation - Browse comprehensive guides
• Community Forums - Connect with other users

Enterprise Support¶

For enterprise customers: - Priority Support - 24/7 assistance - Dedicated Account Manager - Personalized guidance - Custom Training - Team onboarding sessions