Documentation · Set up
The plugin's settings page
Settings → Operanse in wp-admin is the plugin's only screen. It shows what the plugin is doing, lets you pair or unpair, and holds the few settings that are decided on the site rather than in the dashboard.
Status
| Row | What it tells you |
|---|---|
| Agent version | The installed version, and whether a newer release is available. |
| Paired | Whether the site has credentials, with the site and key ids. If the site's AUTH_KEY changed after pairing, the stored secret cannot be read and this row says so: pair again with a new token. |
| Connection mode | How read jobs reach the site. See connection modes. |
| Spool tier and location | Where events are buffered, and whether the recommended private directory is in use. See server setup. |
| Spool size | Bytes and files waiting to upload, and anything dropped because the buffer was full. |
| Last flush, heartbeat, discovery | When each last ran and whether it succeeded. The heartbeat runs every five minutes. |
| Last error and backoff | The last failure talking to Operanse, and, after repeated failures, how long the plugin is waiting before trying again. |
| WP-Cron and spawn check | Whether the built-in trigger is disabled, and whether WordPress can reach its own cron endpoint. |
| Last collect ran | When the collector last ran and how often it is expected to. |
Each host-resource family (load, memory, disk, database, PHP cache, the error log) is listed after every run with the scope it was read at, or the reason it could not be read.
Settings
Connection mode. Outbound only is the default and the recommendation: the plugin polls for read jobs on cron and there is no inbound endpoint. Direct inbound lets Operanse send signed read-only requests to the site for faster investigations. Persistent stream holds an outbound connection open from a process you run on the host. The mode is set here and mirrored in the dashboard; it is never changed remotely. Details on connection modes.
Inbound source IP allow-list. For direct inbound only: one address range per line. A request from anywhere else is refused before its signature is checked.
Read host resources on each collect. Load, CPU, memory, disk, database status counters, the PHP cache and the error log's counts, read from inside PHP as the web user. Read-only, nothing installed. Off here or off in the dashboard is off.
Custom code analysis. Structural reads the structure of your active plugins and theme (hook names, REST routes, scheduled hooks, table names, the external domains they call) so a failure can be tied to the plugin involved. No source code leaves the site. Metadata only sends plugin names and versions and nothing else.
Actions
Once paired, the page has a button for each scheduled job so you can run it now rather than wait for cron: collect, flush (upload), discover (the inventory), poll (read jobs), cron check and host. Check for plugin update asks whether a newer release exists, whatever the cached answer says. Unpair removes the credentials from the site; the site stays in the dashboard until you delete it there.
Constants
Set in wp-config.php.
| Constant | Purpose |
|---|---|
OPERANSE_DATA_DIR | A private directory outside the web root for the event buffer. See server setup. |
OPERANSE_TRUSTED_PROXIES | A comma-separated list of proxy addresses. When the site is behind a reverse proxy or load balancer, the inbound allow-list is checked against the address the proxy forwards rather than the proxy's own. |
OPERANSE_API_URL | Where the plugin sends everything. Leave it unset; it exists for development and self-hosted testing. |
Settings that live in the dashboard
The dashboard's site settings hold the rest: the connection mode's mirror, the uptime rule (a site is marked down after three failed checks in a row and up again after two good ones), the public status page, the host-resources switch, the code-analysis level, and Delete this site. Only owners and admins can change them.