How to Automate VPS Deployments with GitHub Actions and SSH Keys (Zero Downtime)

The Shift from Manual Deployments to Automated CI/CD

Manually connecting to your cloud VPS via SSH, running git pull, rebuilding assets, and restarting PM2 or Docker is slow and error-prone. With GitHub Actions, you can automate your entire deployment workflow: every push to the main branch triggers automated linting, test suites, and remote production deployments with zero human intervention.

Step 1: Generating a Dedicated Deployment SSH Key

On your local computer, create a keypair specifically for GitHub Actions:

ssh-keygen -t ed25519 -C "github-actions-deploy" -f ~/.ssh/github_deploy_key

Copy the public key to your remote VPS user's ~/.ssh/authorized_keys:

ssh-copy-id -i ~/.ssh/github_deploy_key.pub deployer@YOUR_VPS_IP

Step 2: Storing Secrets in Your GitHub Repository

1. Navigate to your GitHub repository -> Settings -> Secrets and variables -> Actions.
2. Click New repository secret and add the following:

• HOST: Your server public IP address.
• USERNAME: Your non-root sudo username (e.g. deployer).
• SSH_KEY: The private key contents of ~/.ssh/github_deploy_key.
• PORT: Your SSH port (e.g. 22 or custom port).

Step 3: Creating the GitHub Actions Workflow File

In your local codebase, create .github/workflows/deploy.yml:

name: Production Deployment

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

      - name: Deploy to VPS via SSH
        uses: appleboy/ssh-action@v1.0.3
        with:
          host: ${{ secrets.HOST }}
          username: ${{ secrets.USERNAME }}
          key: ${{ secrets.SSH_KEY }}
          port: ${{ secrets.PORT }}
          script: |
            cd /var/www/my-production-app
            git pull origin main
            npm ci --omit=dev
            npm run build
            pm2 reload ecosystem.config.js --update-env

Step 4: Committing and Testing the Automation

Commit your workflow file and push to GitHub:

git add .github/workflows/deploy.yml
git commit -m "ci: add automated production deployment workflow"
git push origin main

Navigate to the Actions tab on GitHub to watch your deployment run and verify your live website updates seamlessly.