🚀 Download & Installation

Welcome to the Alesqui Intelligence installation guide. This page will help you get the platform up and running on your infrastructure.

---

---

📦 Installation Options

Choose the installation method that best fits your needs:

🚀 Option 1: Quick Install (Recommended)

The fastest way to get started. Our automated installer will guide you through the entire setup process.

curl -fsSL https://install.alesqui.com/install.sh | bash

What the installer does:

• ✅ Installs Docker and Docker Compose (if not present)
• ✅ Downloads the latest Alesqui Intelligence images
• ✅ Creates configuration files with secure defaults
• ✅ Guides you through SMTP configuration (required for user activation)
• ✅ Sets up MongoDB (Atlas or local)
• ✅ Starts all services automatically

Time to complete: ~5 minutes

💡 Note: The installer will guide you through SMTP configuration (required for user activation).

---

📦 Option 2: Manual Download

For organizations that prefer manual control over the installation process.

Step 1: Download the Release

Download the latest release from our distribution repository:

# Download the latest release
wget https://github.com/eloisa-alesqui/alesqui-intelligence-distribution/releases/latest/download/alesqui-intelligence.tar.gz

# Extract the archive
tar -xzf alesqui-intelligence.tar.gz
cd alesqui-intelligence

Step 2: Configure Environment

Create and configure your .env file:

# Copy the example configuration
cp .env.example .env

# Configure your environment (including SMTP for user activation)
nano .env

Required configurations:

• ✅ OpenAI API key
• ✅ MongoDB connection string (Atlas or local)
• ✅ SMTP credentials (REQUIRED for account activation)
• ✅ JWT secret key
• ✅ Frontend URL

See the Configuration Guide for detailed information about each setting.

Step 3: Start Services

# Pull Docker images
docker-compose pull

# Start all services
docker-compose up -d

# Check service status
docker-compose ps

Step 4: Verify Installation

# Check logs
docker-compose logs -f

# Access the application
# Frontend: http://localhost:3000
# Backend: http://localhost:8080

Time to complete: ~15 minutes

---

🔄 Deployment Type Comparison

Choose between MongoDB Atlas (managed) or local MongoDB based on your requirements:

---

✅ Prerequisites

Before installing Alesqui Intelligence, ensure you have the following:

System Requirements

• Operating System: Linux (Ubuntu 20.04+, RHEL 8+, Debian 11+) or macOS
• CPU: 4 cores minimum (8 cores recommended)
• RAM: 8GB minimum (16GB recommended)
• Disk Space: 50GB minimum (SSD recommended)
• Network: Outbound internet access for Docker Hub and OpenAI API

Required Software

• Docker: Version 24.0+ (Install Docker)
• Docker Compose: Version 2.20+ (usually included with Docker Desktop)

Required Services & Credentials

1. OpenAI API Key

• ✅ Sign up at OpenAI Platform
• ✅ Create an API key
• ✅ Ensure billing is set up (pay-as-you-go)

Cost estimate: ~$0.002 per API interaction (varies by query complexity)

2. SMTP Server Credentials (REQUIRED for user account activation)

Alesqui Intelligence requires SMTP credentials to send account activation emails and password reset links.

Supported providers:

• Gmail (with App Password) - How to generate App Password
• SendGrid - SendGrid SMTP
• Mailgun - Mailgun SMTP
• Amazon SES - AWS SES SMTP
• Your company's SMTP server - Contact your IT department for credentials

What you'll need:

• SMTP Host (e.g., smtp.gmail.com)
• SMTP Port (typically 587 for TLS)
• SMTP Username (e.g., your-email@gmail.com)
• SMTP Password or App Password

Used for:

• ✉️ Sending account activation emails
• ✉️ Password reset requests
• ✉️ System notifications

⚠️ Important: Without SMTP configuration, users will not be able to activate their accounts and the platform will not function properly.

3. MongoDB Database (Choose One)

Option A: MongoDB Atlas (Recommended for quick start)

• ✅ Create a free cluster at MongoDB Atlas
• ✅ Get your connection string
• ✅ Whitelist your IP address

Option B: Local MongoDB

• ✅ The installation includes a MongoDB container
• ✅ No additional setup required if using Docker Compose
• ✅ Suitable for air-gapped environments

---

🎯 After Installation

1. Test SMTP Configuration

Before inviting users, verify that email sending works correctly:

# Create a test user account
curl -X POST http://localhost:8080/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "test@example.com", "password": "TestPassword123!"}'

Verify:

• ✅ Check that the activation email arrives in the inbox
• ✅ Check the spam/junk folder if not received
• ✅ Click the activation link to ensure it works
• ✅ Log in with the activated account

Troubleshooting SMTP:

• Check docker-compose logs backend for SMTP connection errors
• Verify SMTP credentials in .env file
• Ensure firewall allows outbound connections on SMTP port (587/465)
• For Gmail: Ensure App Password is used (not regular password)
• Test SMTP connectivity: telnet smtp.gmail.com 587

2. Configure Your APIs

Once SMTP is working, set up your API integrations:

1. Log in to the admin dashboard
2. Navigate to "API Configuration"
3. Upload your Swagger/OpenAPI specifications
4. Configure authentication (API Key, Bearer, OAuth2)
5. Test API connectivity

See the Configuration Guide for detailed API setup instructions.

3. Create User Accounts

Now you're ready to onboard your team:

1. Users register with their email address
2. They receive an activation email (via SMTP)
3. After activation, they can log in and start using the platform

4. Monitor System Health

# Check service status
docker-compose ps

# View logs
docker-compose logs -f

# Check resource usage
docker stats

5. Set Up Backups

Configure automated backups for your MongoDB database:

For MongoDB Atlas:

• Backups are automatic
• Configure backup schedule in Atlas dashboard

For Local MongoDB:

# Create backup script
docker-compose exec mongodb mongodump --out /data/backup/$(date +%Y%m%d)

# Set up daily cron job
0 2 * * * cd /path/to/alesqui-intelligence && docker-compose exec mongodb mongodump --out /data/backup/$(date +\%Y\%m\%d)

---

📞 Support & Troubleshooting

Common Issues

Issue: "SMTP connection failed"

• Verify SMTP credentials in .env file
• Check SMTP host and port are correct
• Ensure firewall allows outbound SMTP connections
• For Gmail: Use App Password, not regular password

Issue: "Email not received"

• Check spam/junk folder
• Verify sender email is not blocked
• Check backend logs: docker-compose logs backend
• Test SMTP with: telnet smtp.gmail.com 587

Issue: "Cannot activate account"

• Verify activation link hasn't expired (default: 24 hours)
• Check backend logs for errors
• Ensure frontend URL in .env matches your domain

Issue: "MongoDB connection failed"

• Verify MongoDB connection string in .env
• For Atlas: Check IP whitelist
• For local: Ensure MongoDB container is running

Getting Help

• 📧 Email: support@alesqui.com
• Report Issues: GitHub Issues

---

🔐 Security Best Practices

Before going to production:

• ✅ Change all default passwords and secrets
• ✅ Use strong JWT secret key (openssl rand -base64 32)
• ✅ Enable HTTPS with valid SSL certificates
• ✅ Configure firewall rules (only allow necessary ports)
• ✅ Set up regular backups
• ✅ Enable audit logging
• ✅ Review Security Guide

---

📚 Next Steps

Now that you have Alesqui Intelligence installed:

• ✅ Configure APIs - Set up your API integrations

2. ✅ Review Architecture - Understand the system design
3. ✅ Enterprise Readiness - Security and compliance
4. ✅ Trial Quickstart - User guide

---

Ready to get started? Choose your installation method above and you'll be up and running in just a few minutes! 🚀