WP OctoDocs

Installation

Installing the worker plugin on a site and pairing it with a workspace.

Get the plugin

The current release of the worker is offered from the dashboard: open the site under Websites, choose Connect Website, and use Download Plugin. The same page lists the steps below.

The zip contains the plugin only. It holds no credential, no storage key and nothing that is specific to a site; the pairing happens after activation.

Install and activate

In the site's WordPress admin: Plugins → Add New → Upload Plugin, choose the zip, install, activate. The plugin adds an Octo Tools menu with its screens.

Nothing is sent anywhere yet. Until the site holds a workspace token it answers every platform call with a refusal, which is the correct state for a site that is not paired.

Pair the site

The site pairs with a workspace through the workspace token, and it gets there in one of two ways:

When
The platform installs itThe site was added to the dashboard and the platform can reach it. The platform places the token on the site and checks that the site accepts it — and that it refuses a wrong one — before it is trusted.
You paste itOpen Octo Tools → Settings → General on the site and paste the workspace token from Workspace settings in the dashboard. This is the route for a site set up on its own, or for a host whose firewall keeps the platform from reaching the site.

Either way the site ends up holding one credential, checked on every call.

Confirm

In the dashboard, open the site's Health page and run a health check. A paired site answers with its worker version and its status becomes active. Within a few minutes the site's plugins, themes, users and core version appear on their pages, and the site makes its first call to the platform.

If the health check names a cause instead — a firewall answering for the site, a plugin that took the credential before the worker saw it, a certificate problem — Troubleshooting lists what each means and what to change.

Updating the plugin later

You do not upload a new zip for a new version. The platform tells each site which release is available for it, in stages across the fleet, and the worker installs it with a rollback copy. Plugin updates describes it. Uploading a newer zip by hand still works and is sometimes the only way onto a site the platform cannot reach; the site reports the version it runs on its next contact.

On this page