Quick Start Deployment Guide
For the fastest deployment, use the automated deployment script:
One-Command Deployment
Section titled “One-Command Deployment”For the fastest deployment, use the automated deployment script:
# Download and run the deployment scriptcurl -sSL https://raw.githubusercontent.com/your-org/idrv5-myfr8/main/deploy.sh | bash -s -- \ -d your-domain.com \ -e admin@your-domain.com \ -p SecurePassword123Docker Deployment (Recommended)
Section titled “Docker Deployment (Recommended)”1. Prerequisites
Section titled “1. Prerequisites”- Docker and Docker Compose installed
- Domain name pointing to your server
- SSL certificates (optional, can use Let’s Encrypt)
2. Quick Docker Setup
Section titled “2. Quick Docker Setup”# Clone the repositorygit clone https://github.com/your-org/idrv5-myfr8.gitcd idrv5-myfr8
# Copy environment templatecp .env.example .env
# Edit environment variablesnano .env
# Start the applicationdocker-compose up -d
# Check statusdocker-compose ps3. Environment Variables
Section titled “3. Environment Variables”Update .env file with your settings:
# Required SettingsDB_PASSWORD=your_secure_database_passwordSESSION_SECRET=your_32_character_session_secretJWT_SECRET_KEY=your_32_character_jwt_secretSERVER_NAME=your-domain.com
# Optional External ServicesTWILIO_ACCOUNT_SID=your_twilio_sidSENDGRID_API_KEY=your_sendgrid_keyOPENAI_API_KEY=your_openai_keyManual Deployment
Section titled “Manual Deployment”1. System Requirements
Section titled “1. System Requirements”- Ubuntu 20.04 LTS or CentOS 8+
- 4GB RAM minimum
- 20GB storage minimum
- PostgreSQL 14+
- Python 3.11+
- Nginx
2. Installation Steps
Section titled “2. Installation Steps”# Update systemsudo apt update && sudo apt upgrade -y
# Install dependenciessudo apt install -y python3.11 python3.11-venv postgresql nginx
# Create application directorysudo mkdir -p /opt/idrv5-myfr8sudo chown $USER:$USER /opt/idrv5-myfr8
# Clone repositorygit clone https://github.com/your-org/idrv5-myfr8.git /opt/idrv5-myfr8cd /opt/idrv5-myfr8
# Setup virtual environmentpython3.11 -m venv venvsource venv/bin/activatepip install -r requirements.txt
# Configure databasesudo -u postgres createdb idrv5_myfr8sudo -u postgres createuser myfr8_usersudo -u postgres psql -c "ALTER USER myfr8_user WITH PASSWORD 'secure_password';"sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE idrv5_myfr8 TO myfr8_user;"
# Import database schemapsql -U myfr8_user -d idrv5_myfr8 -f exports/database_export_20250710_010237.sql
# Create environment filecp .env.example .env# Edit .env with your settings
# Start applicationgunicorn --bind 0.0.0.0:5000 --workers 4 main:appCloud Platform Deployment
Section titled “Cloud Platform Deployment”AWS EC2 with RDS
Section titled “AWS EC2 with RDS”# Launch EC2 instance (t3.medium or larger)# Create RDS PostgreSQL instance# Update security groups for HTTP/HTTPS access
# Deploy applicationcurl -sSL https://raw.githubusercontent.com/your-org/idrv5-myfr8/main/deploy.sh | bash -s -- \ -d your-domain.com \ -e admin@your-domain.com \ -p SecurePassword123Google Cloud Platform
Section titled “Google Cloud Platform”# Create Compute Engine instance# Create Cloud SQL PostgreSQL instance# Configure firewall rules
# Deploy application using Dockerdocker-compose up -d# Create Azure VM# Create Azure Database for PostgreSQL# Configure Network Security Groups
# Deploy application./deploy.sh -d your-domain.com -e admin@your-domain.com -p SecurePassword123Verification
Section titled “Verification”After deployment, verify the application is working:
# Check health endpointcurl https://your-domain.com/health
# Check application logssudo journalctl -u idrv5-myfr8 -f
# Access the application# Open https://your-domain.com/operations in your browserPost-Deployment
Section titled “Post-Deployment”1. Configure External Services
Section titled “1. Configure External Services”Add API keys to your .env file:
# SMS notificationsTWILIO_ACCOUNT_SID=your_twilio_sidTWILIO_AUTH_TOKEN=your_twilio_token
# Email notificationsSENDGRID_API_KEY=your_sendgrid_key
# AI featuresOPENAI_API_KEY=your_openai_key2. Set Up Monitoring
Section titled “2. Set Up Monitoring”# Check application statussudo systemctl status idrv5-myfr8
# Monitor logssudo journalctl -u idrv5-myfr8 -f
# Set up log rotationsudo logrotate -f /etc/logrotate.d/idrv5-myfr83. Configure Backups
Section titled “3. Configure Backups”# Run backup manuallysudo /opt/scripts/backup.sh
# Check backup filesls -la /opt/backups/Troubleshooting
Section titled “Troubleshooting”Common Issues
Section titled “Common Issues”-
Application won’t start
Terminal window # Check logssudo journalctl -u idrv5-myfr8 --no-pager# Check environmentsudo -u www-data env# Test database connectionpsql -U myfr8_user -d idrv5_myfr8 -c "SELECT 1;" -
Database connection errors
Terminal window # Check PostgreSQL statussudo systemctl status postgresql# Check connection stringecho $DATABASE_URL# Test connectionpg_isready -U myfr8_user -d idrv5_myfr8 -
SSL certificate issues
Terminal window # Renew certificatesudo certbot renew# Check certificate statussudo certbot certificates# Test Nginx configurationsudo nginx -t
Support
Section titled “Support”For additional help:
- Check the full deployment guide:
docs/DEPLOYMENT.md - Review the deployment checklist:
docs/DEPLOYMENT_CHECKLIST.md - Contact support team
Last Updated: July 10, 2025