Configuring Helix Artifacts

Note

You must be an admin or super user to configure Helix Artifacts.

Tip

Helix Artifacts can also be configured using the config.properties file for ha-core, see Helix Artifacts Core configuration file.

Configure Helix Artifacts from the web UI.

To configure Helix Artifacts from the web UI:

  1. Open Settings from the side-navigation bar.

  2. Select Configure.

    The Helix Artifacts configuration page is displayed.

  3. Edit the Helix Artifacts configuration:

  4. Configurable Configurable name in config.properties file Default Description
    Product Name com.perforce.artifacts.core.product= ha-core The name that is shown in the Helix server log.
    Product version com.perforce.artifacts.core.version= 0.1 The product version that is shown in the Helix server log. Default value, the installed version of Helix Artifacts.
    Log Configuration File com.perforce.artifacts.core.log= log4j2.xml Set the log file name the Helix Artifacts log is saved as.
    Host Address com.perforce.artifacts.core.host= 0.0.0.0 The host IP address for the Helix Artifacts service.
    Service Port com.perforce.artifacts.core.port= 1600 The port number for the Helix Artifacts service.
    Protocol com.perforce.artifacts.core.protocol= http The protocol used for the Helix Artifacts service. Options are: http or https.
    Java Keystore Location com.perforce.artifacts.core.secure.keystore= empty Only if protocol is set to https. The location of the Java Keystore, see Configuring SSL for Helix Artifacts (Optional).
    Java Keystore Password com.perforce.artifacts.core.secure.keypass= empty Only if protocol is set to https. The location of the Java Keystore, see Configuring SSL for Helix Artifacts (Optional).
    Configuration Security com.perforce.artifacts.core.security.required= true Set to true to require log in with Helix server credentials to edit this configuration in the web UI.
    (CORS) Allowed Origin com.perforce.artifacts.core.access-control-allow-origin= empty Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access.
    Setup Retry Interval com.perforce.artifacts.core.setup.retry= 30000 The retry interval used by Helix Artifacts when locating ElasticSearch and Perforce Services (milliseconds).
    Perforce Port com.perforce.artifacts.core.p4port= localhost:1666 The Helix server RPC host and port. For example, perforce.com:1666 or ssl.perforce.com:1666 if protocol is set to https.
    P4TRUST com.perforce.artifacts.core.p4trust= empty The p4trust trusted fingerprint.
    Perforce Service User com.perforce.artifacts.core.service.p4user= empty The Helix server user account to authorize the proxy connection at security level 5 and higher.
    Perforce Service Ticket com.perforce.artifacts.core.service.p4ticket= empty The long lived ticket to authorize the Perforce Service User. To print out a long lived ticket for the Perforce service user that is valid for all hosts, run the following command : p4 -p <p4port> -u <p4user> login -a -p
    P4IGNORE File com.perforce.artifacts.core.p4ignore= ha.p4ignore The P4IGNORE file for Helix Artifacts.
    Config Auth Token com.perforce.artifacts.core.config.token= empty An X-Auth-Token to validate configuration requests
    Trusted Services com.perforce.artifacts.core.trusted.ips= empty A comma-separated list of trusted IP addresses for Proxy services. For example, the IP address for your Swarm instance.
    Permission Filter Required com.perforce.artifacts.core.permission.required= true Defines whether the 'protect-filter' plugin must be installed. This is used to filter user results based on Helix server permissions.
    Cache Root ../cache ../cache The path to the cache root folder.
    Important

    The cache root folder is shared by the Helix Artifacts micro-service and the protocol micro-services. You must set the cache root folder to the same folder path for all of the micro-services, so they have a common cache location. See Micro-service configuration files.

    P4Search Url com.perforce.artifacts.core.p4search.url= http://localhost:1601 The URL of the Helix Search service. For example, http://helix-search:1601
    Help URL com.perforce.artifacts.core.helpurl= https://www.perforce.com/manuals/helix-artifacts/Content/HelixArtifacts/Home-helixartifacts.html The URL of the Helix Artifacts help documentation. Enables you to change the URL of the help document. For example, if you are running an isolated system and need to host it on your own server.

  5. To update the configuration with your changes, select Apply.