Installing on macOS/Linux

When you have completed all preparations and pre-requisities, you can install the Perforce ALM integration.

This requires that you have file system access to a machine where the integration is hosted.
To encrypt all data stored on the P4 Plan Server, use an encrypted disk. If you do not use an encrypted disk, some data related to P4 Plan on the server will remain unencrypted. Only the user running the server should have access to the database, installation, and backup folders.

1. Download the Perforce ALM integration zip file and unzip it.

2. Run the install script ./install.sh

3. Create a copy of the file called config-example.env and rename the copy to just .env

4. Open .env and edit it to add the following information:

  • helixPlanHost - The name of the P4 Plan server.
  • helixPlanPort - The port for the P4 Plan server.
  • database The name of the P4 Plan database.
  • sdkUser The name of the SDK user.
  • sdkPassword - The password of the SDK user.
  • integrationUsername - The name of the P4 Plan integration user.
  • integrationToken - The login token for the integration user.
  • (Optional) verifyCertificate - Change to true.
  • The certificate must be from a certificate authority that is supported by NodeJS HTTPS Agent.

    Setting this to false constitutes a security liability if you do not have firewalls or other security measures in place, as these communications will otherwise not be secure while the default setting is used. Consult your IT department for more information.

5. Save the .env file.

6. Run the start script ./start.sh to activate the integration

Next: Connecting P4 Plan to Perforce ALM