Skip to main content

🚀 AWSUP - Lightning-fast AWS static website deployment

Project description

🚀 AWSUP - Lightning-Fast AWS Website Deployment

Production-grade CLI tool for deploying static websites to AWS using S3, CloudFront, Route53, and ACM. Zero configuration, maximum automation.

⚡ Quick Start

# Install globally
pip install awsup

# Deploy your website instantly
cd /path/to/your/website
awsup deploy yourdomain.com --website-path .

# Or deploy with default "Coming Soon" page
awsup deploy yourdomain.com

That's it! AWSUP handles all AWS infrastructure automatically.

✨ Features

  • 🎯 Zero Config - Works out of the box
  • 🔒 Secure by Default - SSL, OAC, encryption enabled
  • Lightning Fast - Global CloudFront CDN
  • 🛡️ Production Ready - Comprehensive validation & error handling
  • 🎨 Beautiful CLI - Rich terminal UI with progress bars
  • 🔄 Smart State - Resumes interrupted deployments
  • 🌍 Global - Works with any domain registrar

🎯 Common Workflows

React/Next.js:

npm run build
awsup deploy myapp.com --website-path ./build

Vue/Nuxt:

npm run generate  
awsup deploy myapp.com --website-path ./dist

Static HTML:

awsup deploy myapp.com --website-path ./public

Jekyll/Hugo:

awsup deploy myapp.com --website-path ./_site

📋 All Commands

# Deploy website
awsup deploy yourdomain.com --website-path ./build

# Deploy subdomain (requires parent domain already deployed)
awsup deploy api.yourdomain.com --website-path ./api-docs

# Check status
awsup status yourdomain.com

# Clear CDN cache
awsup invalidate yourdomain.com

# Remove all AWS resources
awsup cleanup yourdomain.com

# Advanced: Deploy in phases
awsup phase1 yourdomain.com    # DNS setup
awsup phase2 yourdomain.com    # Full deployment

🌐 Subdomain Deployment

AWSUP automatically detects subdomains and reuses the parent domain's Route53 hosted zone.

Requirements:

  • Parent domain (e.g., example.com) must be deployed first
  • Parent domain's Route53 hosted zone must exist in your AWS account

Example:

# First, deploy the parent domain
awsup deploy example.com --website-path ./main-site

# Then deploy subdomains (no NS configuration needed!)
awsup deploy api.example.com --website-path ./api-docs
awsup deploy blog.example.com --website-path ./blog
awsup deploy app.example.com --website-path ./app/build

Key Differences for Subdomains:

  • ✅ Uses parent domain's hosted zone (no separate NS records)
  • ✅ SSL certificate for subdomain only (no www subdomain)
  • ✅ CloudFront distribution serves only the subdomain
  • ✅ Faster deployment (no NS propagation wait)
  • ✅ Cost-effective (single hosted zone for all subdomains)

Multiple Subdomains:

# Deploy as many subdomains as needed
awsup deploy staging.example.com --website-path ./staging
awsup deploy dev.example.com --website-path ./dev
awsup deploy docs.example.com --website-path ./docs

🔄 How It Works

  1. Route53 - Creates hosted zone and DNS records
  2. ACM - Requests and validates SSL certificate
  3. S3 - Creates secure bucket and uploads files
  4. CloudFront - Sets up global CDN with SSL
  5. DNS - Configures domain routing

📋 Prerequisites

  1. AWS Account with appropriate permissions
  2. Python 3.8+ installed
  3. AWS CLI configured with credentials
  4. Domain name (registered with any registrar)

Required AWS Permissions

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "route53:*",
        "s3:*", 
        "cloudfront:*",
        "acm:*",
        "sts:GetCallerIdentity"
      ],
      "Resource": "*"
    }
  ]
}

🔧 Domain Configuration

After running awsup deploy, configure nameservers at your domain registrar:

Configure these nameservers at your registrar:
  NS1: ns-123.awsdns-12.com
  NS2: ns-456.awsdns-34.net
  NS3: ns-789.awsdns-56.org
  NS4: ns-012.awsdns-78.co.uk

Steps:

  1. Log into your domain registrar (GoDaddy, Namecheap, etc.)
  2. Go to DNS settings for your domain
  3. Change nameservers from default to custom
  4. Enter the NS records shown above
  5. Wait 5-30 minutes for DNS propagation

🛡️ Security Features

  • S3 buckets are private (no public access)
  • CloudFront Origin Access Control (OAC)
  • TLS 1.2+ enforced with automatic SSL certificates
  • Input validation for domains and files
  • Security scanning of uploaded content

🚨 Troubleshooting

DNS Not Resolving

  • Verify NS records at your registrar
  • Wait up to 48 hours for propagation
  • Test: dig yourdomain.com NS

CloudFront Not Updating

  • Clear cache: awsup invalidate yourdomain.com
  • Wait 15-20 minutes for changes

Certificate Issues

  • Ensure NS records are configured
  • Wait up to 30 minutes for validation

💰 Cost Estimates

For a small website (<1GB, <100GB transfer/month): ~$5-10/month

  • Route53: $0.50 per hosted zone
  • S3: ~$0.023 per GB stored
  • CloudFront: ~$0.085 per GB transferred
  • ACM: Free with CloudFront

🎛️ Advanced Usage

Multiple environments:

awsup deploy staging.myapp.com --website-path ./dist-staging
awsup deploy myapp.com --website-path ./dist-production

Custom configuration:

awsup init yourdomain.com --region us-west-2 --environment prod

📊 Monitoring

AWSUP automatically sets up:

  • CloudWatch dashboards
  • Resource tagging for cost tracking
  • Structured logging
  • State management

🤝 Support

For issues or feature requests:

📄 License

MIT License - Feel free to use and modify.


Made with ❤️ for developers who want simple AWS deployments

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

awsup-2.1.1.tar.gz (49.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

awsup-2.1.1-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

Details for the file awsup-2.1.1.tar.gz.

File metadata

  • Download URL: awsup-2.1.1.tar.gz
  • Upload date:
  • Size: 49.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for awsup-2.1.1.tar.gz
Algorithm Hash digest
SHA256 a8207ca0ca3826b49b67906ca77788ea11fd0bd65bdb3a3800420472ed0c52ff
MD5 3d0c644a3955166d1ada44e9ca650164
BLAKE2b-256 d4f72518dc2fcc106d093c483a66544e85cef1ccc9ae9db6be437118f5384daf

See more details on using hashes here.

File details

Details for the file awsup-2.1.1-py3-none-any.whl.

File metadata

  • Download URL: awsup-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 39.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for awsup-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b7092a632b3a312439c97f749b93b375878d5dec40251ec3670917d67a060d47
MD5 86d4c233cfc9ecb916e0e1f3fd8fce9c
BLAKE2b-256 3f0b28e57fb71207215d88429553e2a40563018d6eb126caa9aed5cd99004a77

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page