perforce/helix-plan-web repository overview

⁠IMPORTANT:

‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾

Docker installation guides: https://docs.docker.com/engine/install/⁠

P4 Plan Server required: https://www.perforce.com/downloads/helix-plan-server⁠

Connectivity to the P4 Plan server requires a license equipped with the SDK module

⁠INSTALLATION:

⁠‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾

1. Create the SDK user (with "Sync all Project" enabled) that will be used for connectivity between the web service and the P4 Plan server.
2. Setup a file named .env and store it locally.

Copy this template below and update the required information for the server and the SDK user and save it as .env

# P4 Plan server connection
p4PlanHost=p4plan.server
p4PlanPort=50256
database=Company Projects

# SDK user that will connect to P4 Plan
sdkUser=sdk_user
sdkPassword=password

# The API log level
logLevel=info

# Set to true to run the SDK in debug mode
sdkDebug=false

# The environment the P4 Plan API is running at, can be set to development for extra logging mechanisms
NODE_ENV=production

# The http port to use for the P4 Plan API server
port=4000

# Changelist description text automatically added to the description entered by the user when adding a changelist to a P4 Plan item, valid values: "markdown" "none" "url" "databaseID" "itemDescription"
helixCoreCommentType=markdown

# Auth token validity time in seconds
tokenValidityDurationInSeconds=3600

# OPTIONAL: The data directory where the SDK stores its working data. The default is p4-plan-api-data in the application directory
#dataPath=/path-to-data-dir

# OPTIONAL: The local path where P4 Plan documents should be stored. This directory will be used to store temporary files as well as the files in the repository. The default is p4-plan-api-document in the application directory
#documentPath=/path-to-document-dir'

# Set to true for webhooks execution, !!!IMPORTANT: If you have more than one API service running make sure that only one service has this flag set to true, to avoid duplicate webhook triggers
webhooksEnabled=true

💡 Tip: if you are running the P4 Plan server on the same host you can use host.docker.internal on windows and Mac, or 172.17.0.1 in Linux as the p4PlanHost environment variable.

Verify Docker image connectivity with the P4 Plan server instance before continuing.

1. Run the command below from the same location as the stored .env file that was just create above. (local ports are optional to edit)

docker run -d --restart unless-stopped --name p4planweb -p 80:80 -p 443:443 --env-file .env perforce/helix-plan-web:latest

⁠NEXT STEPS

⁠‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾

⁠After installation is complete, users should now be able to access the web client.

The URL includes the domain name or IP address to the host. For example, p4planweb.mycompany.com. If you launched Docker with -p 443:443 which maps the host's TCP port to the docker image's port, the address to use is https://p4planweb.mycompany.com:443/⁠ (where the port number is optional).

Tip: If you are on the host itself you can run this as a connection test: curl -k https://localhost:443/⁠

⁠Certificates (optional)

⁠‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾

Optional: If you want to provide your own certificate to be used for the ssl port you can

Stop the container: docker stop p4planweb

Copy your certificates:

docker cp web.pem p4planweb:/usr/share/nginx/certificates/web.pem

docker cp web.key p4planweb:/usr/share/nginx/certificates/web.key

Restart the container: docker start p4planweb

⁠Container management

⁠‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾

You can check the logs to ensure that the container is up and running: docker logs p4planweb

You can shutdown and remove the container by running

docker stop p4planweb

docker rm p4planweb

⁠LICENSE

⁠‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾

https://www.perforce.com/sites/default/files/pdfs/Helix-Plan-Software-License-Agreement-Click-Thru-February-18-2024.pdf⁠

P4 Plan Web (Previously Helix Plan Web) is officially supported by Perforce. All issues should be recorded via Perforce's standard support process https://www.perforce.com/support/request-support⁠