Skip to main content

Install PHP agent

Using the Agent Wizard is the simplest way to deploy a new agent. Additional methods are also available, including manually, in a container, or in a pipeline.

Before you begin a PHP agent installation

Make sure you have everything you need before you start.

  • The agent will need to be able to reach your Contrast instance. It can be a local/on-premise instance or a hosted instance. A proxy can be configured if the environment has limited network access.

  • It must use supported technologies and system requirements

  • Understand the order of precedence

  • You will also need access to a command line interface (with a chosen directory for downloading the agent) and your organization's instance of Contrast.

Start the Agent Wizard

To open the Agent Wizard:

  • In Northstar: From the left navigation, select Administration > Agent management, then select Add agent at the top of the view.

  • In Contrast: Use one of the following options:

    • From the header, select Add New, and then select the Application card.

    • From the header, select Administration > Agent Management, and then select Add agent at the top of the view.

Select the PHP agent

To open the Agent Wizard:

  1. Under Select an installation method, select Language-specific.

  2. Under Select a language, select PHP.

Install and configure the agent

  1. Under Select application deployment method, select Install manually.

  2. Under the Installation method, select Debian, RPM, AL2023, or APK.

  3. Under Install PHP agent, install the agent package using the commands provided to register it into your system.

  4. Follow the instructions in the wizard to configure PHP and ensure necessary extensions are enabled.

    The agent requires a connection token or an API configuration to communicate with Contrast. You can use a connection token (recommended) or you can download the configuration as a YAML file.

  5. Configure the PHP agent.

Verify the agent deployment

Interact with your application as you normally would. For example, interact with your application's web interface or send API commands.

  1. In the Agent Wizard, select View agent activity to verify that your agent appears in the agents list.

  2. Verify that you see the name of your application in the applications list.

    • In Northstar, select Applications from the left navigation.

    • In Contrast, select Applications from the header.

  3. Verify that you see the name of your local server in the servers list.

    • In Northstar, select Servers from the left navigation.

    • In Contrast, select Servers from the header.