Installation Methods

Connect your WordPress site to the Wp Admin management platform. Choose the deployment method that best fits your workflow and technical environment.

Updated: v3.2.1 ~5 min read

Prerequisites

📋 Requirements

WordPress 5.8+
PHP 7.4 - 8.2
cURL & JSON enabled
FTP/SFTP or File Manager access
Wp Admin account & API key
⚠️
Ensure your site is not in maintenance mode and that you have an active backup before proceeding with any installation method.

Installation Methods

Method 1: Official Plugin

The fastest and most secure way to connect your site. Automatically handles updates, permissions, and configuration sync.

  1. Download the Agent

    Log in to your Wp Admin dashboard and navigate to Settings > Sites > Add New. Click "Generate Agent Download".

  2. Install via WordPress Admin

    Go to Plugins > Add New > Upload Plugin. Select the downloaded wp-admin-agent.zip file and click Install Now.

  3. Activate & Authenticate

    After installation, click Activate. The plugin will automatically detect your API key and establish a secure connection to our management servers.

  4. Verify Connection

    Visit Wp Admin > Dashboard within WordPress. You should see a green "Connected" status with your account details.

wp-content/plugins/ wp-admin-agent/ ├── wp-admin-agent.php ├── includes/ # Core logic & API handlers ├── assets/ # Scripts & styles └── vendor/ # Dependencies

Method 2: Manual Upload

Use this method if you prefer FTP/SFTP deployment or work in restricted hosting environments.

  1. Prepare Files

    Download the manual package from your Wp Admin dashboard. Extract the wp-admin-agent folder to your local machine.

  2. Upload via FTP/SFTP

    Navigate to your WordPress installation directory and upload the folder to: /wp-content/plugins/wp-admin-agent/

  3. Set Permissions

    Ensure the plugin directory has 755 permissions and files have 644. This is critical for secure autoloading.

  4. Activate & Configure

    Visit your WordPress admin panel, go to Plugins, find Wp Admin Agent, and click Activate. Enter your Site API Key in the settings page.

💡
After manual installation, you may need to flush your server cache or clear WordPress permalinks to ensure the plugin UI loads correctly.

Method 3: WP-CLI Deployment

Automate installation across multiple sites using WP-CLI. Ideal for developers and agencies.

Terminal wp plugin install wp-admin-agent --activate wp config set WP_ADMIN_API_KEY 'your-api-key-here' --raw wp wp-admin sync --now
  1. SSH into your server

    Ensure WP-CLI is installed and you have SSH access.

  2. Run installation command

    Execute the command above. Replace the API key with your site-specific key from the dashboard.

  3. Verify via CLI

    Run wp wp-admin status to confirm the agent is connected and reporting metrics.

Method 4: Staging & White-Label Setup

For agencies managing multiple client sites or testing in staging environments.

  1. Install on Staging

    Deploy the plugin using any method above on your staging environment.

  2. Isolate Environment

    Add the following to your wp-config.php to prevent staging data from mixing with production: define('WP_ADMIN_ENVIRONMENT', 'staging');

  3. Sync to Production

    When ready, duplicate the site or use your preferred migration tool. The agent will automatically re-authenticate using your production API key.

  4. White-Label Configuration

    Enterprise clients can customize the dashboard branding via Wp Admin > Settings > Appearance.

⚠️
Never use the same API key across staging and production. Each environment requires a unique key for security and accurate reporting.

Troubleshooting & FAQ

Issue Probable Cause Solution
"Connection Failed" error Invalid API key or firewall blocking outbound requests Verify key in dashboard. Whitelist *.wpadmin.io and *.cloudflare.com on your firewall.
Plugin deactivates randomly Memory limit exceeded or conflicting security plugin Increase WP_MEMORY_LIMIT to 256M. Temporarily disable aggressive security suites to isolate conflicts.
Dashboard shows "Pending Sync" Background tasks disabled or cron misconfigured Ensure wp-cron.php is not blocked. Use real server cron: */5 * * * * wp plugin run
White-label settings not applying Cache interference or enterprise plan restriction Clear object cache. White-label features require Professional or Enterprise tier.
💡
Still stuck? Run wp wp-admin debug --export to generate a diagnostic report and share it with our support team.

Need Help?

Our support team is available 24/7 to assist with installation, migration, or configuration issues. Submit a ticket or join our developer Discord for real-time help.