Environments

Environments are the core building blocks of EE Push. Each environment represents a deployment target — a server or service that receives your code changes.

What Are Environments?

  • Development — Your local or shared dev server where features are built and tested.
  • Staging — A pre-production environment that mirrors production for final QA.
  • Production — The live site. Deployments here should be carefully tested and optionally approved.

Creating an Environment

  1. Navigate to Add-Ons > EE Push > Environments
  2. Click Create Environment
  3. Fill in the fields and click Save

Environment Fields

FieldDescription
NameA descriptive label (e.g., "Production", "Staging").
TypeDeployment method: webhook, ssh, or plesk.
BranchGit branch to deploy (e.g., main, develop).
DB ModeHow the database is handled. See Database Modes.
Is StagingEnables Full DB Replace. Blocked for non-staging environments.
Health Check URLURL to verify after deployment (expects HTTP 200).
Exclude PatternsFiles/directories to exclude. One per line.
Sort OrderControls display order (lower = first).

Exclude Patterns Example

Example exclude patterns
cache/*
uploads/*
.env
system/user/config/config.php

Type-Specific Configuration

Each type shows additional fields. See the setup guides:

Editing & Deleting

Click an environment name to edit. Changes take effect immediately. To delete, click Delete — environments with active deployments cannot be deleted. Deployment history is retained in the logs.

Encrypted Credentials

All sensitive credentials are encrypted via EE's Encrypt service before storage. They are decrypted only during deployment execution and never shown after the initial save.