Deploy EverShop to AWS

This comprehensive guide walks you through the process of deploying EverShop to Amazon Web Services (AWS) using EC2 for application hosting and RDS for PostgreSQL database management. This approach provides a scalable, reliable production environment for your e-commerce platform.

Prerequisites

Before beginning, ensure you have:

An active AWS account (this guide uses free tier resources where possible)
Basic familiarity with AWS console navigation
SSH client for connecting to your EC2 instance

EC2 Instance Setup

Creating an EC2 Instance

First, we need to provision a virtual server to host the EverShop application:

info

If you're new to AWS, follow the official EC2 getting started guide for detailed instructions on creating your first instance.

For optimal compatibility with EverShop, we recommend:

Operating System: Ubuntu 20.04 LTS
Instance Type: t2.micro for testing (free tier eligible) or t3.small/medium for production use
Storage: At least 20GB of EBS storage
Security Group: Configure to allow HTTP (port 80), HTTPS (port 443), and SSH (port 22)

Installing Required Software

After creating and connecting to your EC2 instance via SSH, install the necessary software components:

1. Install Node.js and NPM

EverShop requires Node.js version 14 or higher and NPM version 8 or higher:

sudo apt update
sudo apt install -y curl
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt install -y nodejs

Verify the installation:

node -v  # Should show v18.x.x
npm -v   # Should show 8.x.x or higher

2. Install PM2 Process Manager

PM2 will ensure your EverShop application runs continuously and restarts automatically if the server reboots:

sudo npm install -g pm2

Verify the installation:

pm2 -v

Configure PM2 to start automatically on server boot:

pm2 startup systemd

Follow any additional instructions provided by the command.

3. Install and Configure Nginx

Nginx will act as a reverse proxy, directing traffic to your Node.js application:

sudo apt install -y nginx

Create a configuration file for your EverShop application:

sudo nano /etc/nginx/sites-available/evershop.conf

Add the following configuration, replacing yourdomain.com with your actual domain name (or use the EC2 public DNS temporarily):

server {
    listen 80;
    server_name yourdomain.com www.yourdomain.com;

    location / {
        proxy_pass http://localhost:3000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }

    # Handle large file uploads
    client_max_body_size 50M;
}

Enable the configuration and disable the default site:

sudo ln -s /etc/nginx/sites-available/evershop.conf /etc/nginx/sites-enabled/
sudo unlink /etc/nginx/sites-enabled/default

Test the configuration and restart Nginx:

sudo nginx -t
sudo systemctl restart nginx

Database Setup

Creating an RDS PostgreSQL Instance

EverShop requires PostgreSQL 13 or higher. Let's create a managed database instance:

info

For detailed instructions on creating an RDS instance, refer to the AWS RDS documentation.

Navigate to the RDS dashboard in the AWS console
Click "Create database"
Select "Standard create" and choose PostgreSQL
Select version 13 or higher
Choose the appropriate instance size (db.t3.micro is free tier eligible)
Configure storage, connectivity, and security settings
Set your master username and password
Complete the creation process

Configuring Security Groups

For your EC2 instance to access the RDS database:

Identify the security group of your RDS instance
Edit its inbound rules to allow PostgreSQL traffic (port 5432) from your EC2 instance's security group or IP address

info

For detailed instructions on configuring security groups, see the AWS RDS VPC documentation.

Creating the Database and User

Connect to your RDS instance using a PostgreSQL client like pgAdmin or psql:

psql -h your-rds-endpoint.rds.amazonaws.com -U master_username -d postgres

Create a dedicated database and user for EverShop:

CREATE DATABASE evershop;
CREATE USER evershop WITH ENCRYPTED PASSWORD 'secure_password';
GRANT ALL PRIVILEGES ON DATABASE evershop TO evershop;

Source Code Deployment

Setting Up Your Repository

For streamlined deployment:

Fork the EverShop project template to your GitHub account
Add any custom themes or extensions to your forked repository

Creating a Deployment Script

Create a deployment script on your EC2 instance to automate the process:

sudo mkdir -p /var/www/evershop
cd /var/www/evershop
sudo nano deploy.sh

Add the following script, replacing the placeholder values with your actual GitHub information:

#!/bin/bash

# GitHub authentication and repository details
TOKEN="your_github_personal_access_token"
REPO_OWNER="your_github_username"
REPO_NAME="your_repository_name"
BRANCH="main"

# Check if tar is installed
echo "Checking if tar is installed..."
if ! command -v tar &> /dev/null
then
    echo "tar is not installed, installing now..."
    sudo apt-get install tar -y
fi

# Set deployment directories
CURRENT_BUILD="current"
TIMESTAMP=$(date +"%Y-%m-%d_%H-%M-%S")
NEW_BUILD="build_$TIMESTAMP"

# Download source from GitHub
echo "Downloading source from GitHub..."
wget --header="Authorization: token $TOKEN" -O $NEW_BUILD.tar.gz https://api.github.com/repos/${REPO_OWNER}/${REPO_NAME}/tarball/${BRANCH}

# Extract source code
echo "Extracting source to $NEW_BUILD..."
mkdir $NEW_BUILD
tar -xf $NEW_BUILD.tar.gz -C $NEW_BUILD --strip-components 1
rm $NEW_BUILD.tar.gz

# Install dependencies
echo "Installing npm dependencies..."
cd $NEW_BUILD && npm install --production

# Build the application
echo "Building the application..."
npm run build
cd ..

# Backup current build
if [ -d "$CURRENT_BUILD" ]; then
  echo "Backing up current build..."
  if [ -d "previous-build" ]; then
    rm -rf previous-build
  fi
  mv $CURRENT_BUILD previous-build
fi

# Deploy new build
echo "Deploying new build..."
mv $NEW_BUILD $CURRENT_BUILD

# Copy persistent data from previous build
if [ -d "previous-build" ]; then
  echo "Copying media and configuration files..."
  if [ -d "previous-build/media" ]; then
    cp -R previous-build/media $CURRENT_BUILD/
  else
    mkdir -p $CURRENT_BUILD/media
  fi

  if [ -d "previous-build/config" ]; then
    cp -R previous-build/config $CURRENT_BUILD/
  fi
fi

# Set permissions
echo "Setting permissions..."
chmod -R 755 $CURRENT_BUILD
chmod -R 777 $CURRENT_BUILD/media

# Restart application with PM2
echo "Restarting application..."
cd $CURRENT_BUILD
pm2 stop evershop 2>/dev/null || true
pm2 start npm --name "evershop" -- start

echo "Deployment completed successfully!"

Make the script executable:

sudo chmod +x deploy.sh

Creating Your Configuration File

Before running the first deployment, create your configuration file:

sudo mkdir -p /var/www/evershop/current/config
sudo nano /var/www/evershop/current/config/default.json

Add your database configuration:

{
  "system": {
    "database": {
      "host": "your-rds-endpoint.rds.amazonaws.com",
      "port": 5432,
      "database": "evershop",
      "user": "evershop",
      "password": "secure_password"
    }
  }
}

Running the Deployment

Execute the deployment script:

cd /var/www/evershop
sudo ./deploy.sh

After deployment completes, your EverShop application should be running. You can access it using your EC2 instance's public DNS or your custom domain (if configured).

The admin panel is available at https://yourdomain.com/admin or http://your-ec2-public-dns/admin.

Securing Your Deployment

Installing SSL Certificate with Let's Encrypt

For production environments, secure your site with HTTPS:

Install Certbot:

sudo apt install -y certbot python3-certbot-nginx

Obtain and install a certificate:

sudo certbot --nginx -d yourdomain.com -d www.yourdomain.com

Follow the interactive prompts to complete the process.

Certbot will automatically modify your Nginx configuration to redirect HTTP traffic to HTTPS.

Setting Up Automatic Certificate Renewal

Let's Encrypt certificates expire after 90 days. Set up automatic renewal:

sudo systemctl status certbot.timer

This command should show that the automatic renewal service is active.

Maintenance and Monitoring

Setting Up Log Rotation

Configure log rotation to manage your application logs:

sudo nano /etc/logrotate.d/pm2

Add the following configuration:

/var/www/evershop/.pm2/logs/*.log {
  daily
  rotate 7
  compress
  delaycompress
  missingok
  notifempty
  create 0640 ubuntu ubuntu
}

Monitoring Your Application

Use PM2 to monitor your application:

pm2 monit

For more advanced monitoring, consider integrating with AWS CloudWatch.

Conclusion

You've successfully deployed EverShop to AWS using EC2 for hosting the application and RDS for managing the PostgreSQL database. This setup provides a robust, scalable foundation for your e-commerce platform.

For production environments, consider implementing additional best practices:

Setting up automatic backups for your RDS instance
Implementing AWS CloudWatch for comprehensive monitoring
Configuring a CDN like CloudFront for improved content delivery
Setting up an auto-scaling group for handling variable traffic loads

By following this guide, you've created a deployment that balances performance, security, and maintainability for your EverShop store.

Prerequisites​

EC2 Instance Setup​

Creating an EC2 Instance​

Installing Required Software​

1. Install Node.js and NPM​

2. Install PM2 Process Manager​

3. Install and Configure Nginx​

Database Setup​

Creating an RDS PostgreSQL Instance​

Configuring Security Groups​

Creating the Database and User​

Source Code Deployment​

Setting Up Your Repository​

Creating a Deployment Script​

Creating Your Configuration File​

Running the Deployment​

Securing Your Deployment​

Installing SSL Certificate with Let's Encrypt​

Setting Up Automatic Certificate Renewal​

Maintenance and Monitoring​

Setting Up Log Rotation​

Monitoring Your Application​

Conclusion​

Prerequisites

EC2 Instance Setup

Creating an EC2 Instance

Installing Required Software

1. Install Node.js and NPM

2. Install PM2 Process Manager

3. Install and Configure Nginx

Database Setup

Creating an RDS PostgreSQL Instance

Configuring Security Groups

Creating the Database and User

Source Code Deployment

Setting Up Your Repository

Creating a Deployment Script

Creating Your Configuration File

Running the Deployment

Securing Your Deployment

Installing SSL Certificate with Let's Encrypt

Setting Up Automatic Certificate Renewal

Maintenance and Monitoring

Setting Up Log Rotation

Monitoring Your Application

Conclusion