Files
ASF_tools/asf-cloud-server/testarena_1/QUICK_START.md
2025-11-28 11:22:07 +01:00

2.1 KiB

Quick Start Guide

🚀 Get Started in 2 Steps

Step 1: Deploy the Application

Windows (PowerShell):

.\deploy.ps1

Windows (CMD):

start.bat

Linux/Mac:

chmod +x deploy.sh
./deploy.sh

The script will automatically:

  • Check Docker is running
  • Create Caddy network if needed
  • Build and start containers
  • Verify deployment

Step 2: Login

⚠️ IMPORTANT: Change the admin password immediately!

📋 What's Included

Login system with authentication Modern gradient theme with your logo Admin dashboard (create/delete users, reset passwords) User dashboard (view jobs, job details) Submit page (5-step wizard) Docker Compose with PostgreSQL Caddy proxy ready

🎯 User Workflows

Admin Workflow

  1. Login → Admin Dashboard
  2. Create users with roles
  3. View all jobs from all users
  4. Manage user accounts

User Workflow

  1. Login → Dashboard
  2. Click "Submit Job"
  3. Enter branch name → Select scenarios → Choose environment → Select test mode
  4. Monitor job status in dashboard
  5. View results when complete

🛠️ Useful Commands

# Start
docker-compose up -d

# Stop
docker-compose down

# View logs
docker-compose logs -f

# Restart
docker-compose restart

# Rebuild
docker-compose up -d --build

📁 Key Files

  • docker-compose.yml - Container configuration
  • app/__init__.py - Flask app setup
  • app/models.py - Database models
  • app/static/css/style.css - Theme styles
  • app/templates/ - HTML templates

🔐 Security Checklist

  • Change default admin password
  • Update SECRET_KEY in docker-compose.yml
  • Update database password
  • Configure HTTPS via Caddy
  • Review user permissions

📞 Next Phase

Phase 2 will implement:

  • Git branch checkout and scenario detection
  • Background test execution
  • HTML results generation
  • Automatic cleanup
  • Real-time status updates

Share the Caddy network name when ready to proceed!