Install the P4 Plugin Filter

After you have installed Elasticsearch, you can install the P4 Plugin Filter. The P4 Plugin Filter (also known as the p4search-filter plugin for Elasticsearch) limits search results based on the protections table in P4 Server. To learn more, see Access Authorization in the P4 Server Administration Documentation.

To learn more about Elasticsearch plugin installation and testing, see the Elasticsearch plugin documentation.

Configure the hosting server

  1. Import the Perforce package signing key on the server hosting the P4 Plugin Filter or P4 Search.

    Follow the instructions for your OS distribution:

    wget -qO - https://package.perforce.com/perforce.pubkey | sudo apt-key add -
    sudo apt-get update

    rpm --import https://package.perforce.com/perforce.pubkey

    To learn more about how to verify the authenticity of the signing key, see Perforce packages on the Perforce website.

  2. Configure the Perforce package repository on the server hosting the P4 Plugin Filter or P4 Search.

    As root, follow the instructions for your OS distribution:

    Create the file /etc/apt/sources.list.d/perforce.list with the following content:

    deb https://package.perforce.com/apt/ubuntu/ focal release

    Create the file /etc/apt/sources.list.d/perforce.list with the following content:

    deb https://package.perforce.com/apt/ubuntu/ jammy release

    Create the file /etc/apt/sources.list.d/perforce.list with the following content:

    deb https://package.perforce.com/apt/ubuntu/ noble release

    Create the file /etc/yum.repos.d/perforce.repo with the following content:

    [Perforce]
    name=Perforce
    baseurl=https://package.perforce.com/yum/rhel/8/x86_64/
    enabled=1
    gpgcheck=1

    Create the file /etc/yum.repos.d/perforce.repo with the following content:

    [Perforce]
    name=Perforce
    baseurl=https://package.perforce.com/yum/rhel/9/x86_64/
    enabled=1
    gpgcheck=1

    Create the file /etc/yum.repos.d/perforce.repo with the following content:

    [Perforce]
    name=Perforce
    baseurl=https://package.perforce.com/yum/rhel/10/x86_64/
    enabled=1
    gpgcheck=1

Install the P4 Plugin Filter on Linux

  1. Import the Perforce package signing key and configure the Perforce package repository on the server hosting P4Plugin Filter. See Install the P4 Plugin Filter.

  2. Install the P4Plugin Filter package on the server hosting Elasticsearch.

    Follow the instructions for your OS distribution:

    sudo apt-get install helix-plugin-filter

    yum install helix-plugin-filter

Install the P4 Plugin Filter on Windows

  1. Remotely log in to the Elasticsearch host.
  2. Change directory so you are in the Elasticsearch installation directory, typically %ES_HOME%\bin.
  3. To install the plugin, look in the <p4search-installation>/lib directory for the exact file name. For example, p4search-filter-8.19.14-2026.2.1234567.zip,

    4. where:

    • 8.19.14 is the Elasticsearch version supported
    • 2026.2 is the P4 Search version supported
    • 1234567 is the changelist number of the file

  4. Install the plugin, either:
    • from a local file, for example:

      • elasticsearch-plugin install file:///path/to/plugin/p4search-filter-8.19.14-2026.2.1234567.zip

    • using the P4 Search endpoint, for example:

      • elasticsearch-plugin install http://<p4search host>:<p4search port>/api/v1.2/plugin/p4search-8.19.14-2026.2.1234567.zip

  5. Restart Elasticsearch after installing the plugin.

Next steps

Related topics