Installation - WordPress

Before you start, create a project in the DockRay panel. Its settings hold the project token - the public identifier that goes into the ingest URL - and the API keys tab is where you generate a private key. The key is shown once, when it is generated: DockRay stores only its hash. If you do not have a project yet, start with Getting Started.

Requirements

• WordPress 5.6 or newer,
• PHP 7.2 or newer,
• outbound HTTPS connections allowed from the site's server.

The plugin is published in the WordPress.org directory as DockRay (slug dockray). It needs no Composer - dependencies ship inside the package.

Installing from the plugin directory

1. In the WordPress admin go to Plugins → Add New.
2. Search for DockRay and click Install Now.
3. When the install finishes, click Activate.
4. Open Settings → DockRay.
5. Enter the project token and the private key, then save.
6. Click Send a test event. The result appears without reloading the page.

Activating without credentials is safe: the plugin loads, sends nothing and changes nothing about how the site behaves.

Installing from a ZIP archive

1. Download the current release from WordPress.org.
2. Go to Plugins → Add New → Upload Plugin.
3. Pick the archive, install it and activate the plugin.
4. Configure the connection in Settings → DockRay.

Credentials in wp-config.php

If you would rather keep the secret out of the WordPress database, define it as constants. The plugin picks them up automatically and the settings screen lists which constants are currently in effect.

define( 'DOCK_RAY_TOKEN', 'YOUR_PROJECT_TOKEN' );
define( 'DOCK_RAY_PRIVATE_KEY', 'YOUR_PRIVATE_KEY' );

Put the constants above the /* That's all, stop editing! */ comment that closes the editable part of the file.

After the install

Check that the token and the key come from the same project, then move on to configuration: that is where you set the environment name, the range of reported PHP errors and - if you want them - request timing and JavaScript error collection.