Plesk Git Setup

If your server is managed by Plesk, you can use Plesk's built-in Git deployment feature. EE Push triggers a Git pull via Plesk's REST API — no SSH configuration needed.

Prerequisites

  • Plesk with Git extension installed and enabled
  • A Git repository configured for your domain in Plesk
  • A Plesk API key with appropriate permissions
  • The curl PHP extension (usually installed by default)

Setting Up Plesk Git

  1. Log into your Plesk panel
  2. Go to your domain > Git
  3. Add your repository URL and configure the deployment path
  4. Set the branch to deploy
  5. Generate an API key under Tools & Settings > API

Configuration in EE Push

FieldDescription
Plesk API URLYour Plesk server URL including port (e.g., https://server.example.com:8443). Required.
API KeyPlesk REST API key. Stored encrypted in the database.
DomainThe domain name as configured in Plesk (e.g., example.com).
RepositoryThe Git repository URL configured in Plesk (for reference only).

How It Works

When you deploy, EE Push sends a POST request to the Plesk REST API:

API request
POST https://server.example.com:8443/api/v2/domains/example.com/git/pull
Headers:
  Content-Type: application/json
  X-API-Key: [your-api-key]
Body:
  {"branch": "main"}

Plesk handles the Git pull, file deployment, and any configured post-deployment actions (like running Composer or clearing caches) on its end.

Generating a Plesk API Key

  1. Go to Tools & Settings in Plesk
  2. Click API (under Security)
  3. Click Add Key
  4. Give it a descriptive name (e.g., "EE Push Deploy")
  5. Copy the key and paste it into the EE Push environment configuration

Security Notes

  • The API key is encrypted before being stored in the EE database
  • SSL certificate verification is handled by PHP's cURL
  • Consider restricting the API key's permissions to Git operations only