Installation - Joomla

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

• Joomla 4, 5 or 6,
• PHP 8.2 or newer,
• outbound HTTPS connections allowed from the server.

DockRay for Joomla is a system plugin (plg_system_dockray). Joomla does not run Composer during installation, so the SDK ships inside the package.

Installing the package

1. Download dockray-joomla.zip from the Joomla integration page.
2. In the Joomla administrator go to System → Install → Extensions.
3. Choose Upload Package File and pick the archive.
4. Wait for the install confirmation.

The plugin manifest carries the address of our own update server, so later releases show up under System → Update → Extensions like any other extension update. Joomla checks the SHA-256 hash of the downloaded package and refuses to install it on a mismatch.

Enabling the plugin

1. Go to System → Plugins.
2. Find System - DockRay and enable it.

Enabling it without credentials is safe: with no token and no private key the plugin stays inert.

Configuring the connection

1. Open System - DockRay → Options.
2. Enter the project token and the private key.
3. Save the configuration.
4. Click Send a test event to check the connection without leaving the page.

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, request timing, logged-in user data and - optionally - collecting JavaScript errors from the site.