veo3-report/QUICKSTART.md
Dave Porter d969cc384d Initial commit: VEO3 Usage Report System
- PHP web interface with interactive dashboard
- Python automated email reports with SMTP
- systemd service for 7pm EST daily reports
- Cost tracking at $3.20 per video
- Top 25 users per period (24h, 7d, 30d)
- Complete deployment automation
2026-01-06 17:07:46 -05:00

2.3 KiB

VEO3 Report - Quick Start Guide

Deploy to Server in 3 Steps

Step 1: Prepare Files

# On your local machine, ensure .env is configured
cp .env.example .env
nano .env  # Add your SMTP credentials

Step 2: Upload to Server

scp veo3_report.py veo3_scheduler.py requirements.txt .env \
    veo3-report.service deploy.sh \
    user@your-server.com:/tmp/veo3-deploy/

Step 3: Deploy

# SSH into server
ssh user@your-server.com

# Run deployment
cd /tmp/veo3-deploy
chmod +x deploy.sh
sudo ./deploy.sh

Done! The service is now running and will send reports daily at 7:00 PM EST.


Common Commands

# Check if service is running
sudo systemctl status veo3-report

# View live logs
sudo journalctl -u veo3-report -f

# Restart service
sudo systemctl restart veo3-report

# Test immediately (without waiting for 7pm)
sudo systemctl stop veo3-report
cd /var/www/veo3-report
sudo -u www-data ./venv/bin/python veo3_report.py
sudo systemctl start veo3-report

Configuration Files

File Location Purpose
.env /var/www/veo3-report/.env SMTP credentials & recipients
veo3_scheduler.py /var/www/veo3-report/ Schedule time & timezone
veo3_report.py /var/www/veo3-report/ Cost per video setting

Changing Settings

Change Email Recipients

sudo nano /var/www/veo3-report/.env
# Edit REPORT_RECIPIENTS line
sudo systemctl restart veo3-report

Change Schedule Time

sudo nano /var/www/veo3-report/veo3_scheduler.py
# Find: CronTrigger(hour=19, minute=0, ...)
# Change hour (24-hour format: 19 = 7pm)
sudo systemctl restart veo3-report

Change Cost Per Video

sudo nano /var/www/veo3-report/veo3_report.py
# Find: COST_PER_VIDEO = 3.20
# Change value
sudo systemctl restart veo3-report

Troubleshooting

Service won't start?

sudo journalctl -u veo3-report -n 50

Emails not sending?

# Test manually
cd /var/www/veo3-report
sudo -u www-data ./venv/bin/python veo3_report.py
# Check output for SMTP errors

Wrong time?

# Service uses EST timezone explicitly in code
# Check: sudo journalctl -u veo3-report | grep "Next scheduled run"

For detailed information, see DEPLOYMENT.md