Configuring the micro-services

Note

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

Tip

Micro-services can also be configured using the config.properties file for the micro-service being configured. See Micro-service configuration files.

Configure Helix Artifacts from the web UI.

To configure Helix Artifacts from the web UI:

  1. Open Configure from the side-navigation bar.

  2. Select the micro-service to configure from the side-navigation bar and configuration page is displayed.

  3. Expand the configuration, and make your changes.

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

Helix Artifacts Core configuration

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.

Configuration file location

com.perforce.artifacts.core.location

empty

The location of the configuration file in the file system.

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 Java Keystore password, see Configuring SSL for Helix Artifacts (Optional).

(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

A Standard or Service user with admin or super access. Used to authorize the proxy connections. Must be a Service user at security level 5 and above. At security level 4 and below, this can be the same user as the Perforce Admin user. For instructions on creating the Perforce Service User and printing out the ticket, see Creating the Perforce Service User

Important
  • If a Service user is used, the long lived ticket must be a local ticket and not an all hosts ticket.

  • Security level 6 requires the Helix server to have a valid server spec with the AllowedAddresses field set. For information about Security level 6, see Server security levels in the Helix Core Server Administrator Guide.

Perforce Service Ticket

com.perforce.artifacts.core.service.p4ticket

empty

The long lived ticket to authorize the Perforce Service User.

Perforce Admin User

com.perforce.artifacts.core.admin.p4user

empty

A Standard user with a minimum of admin access, used for keys. For instructions on creating the Perforce Admin User and printing out the ticket, see Creating the Perforce Admin User .

Tip

A Perforce Admin User or Perforce Service User with super permissions is required if you want to use user-generated keys. These keys are accessed from the Keys view, see Viewing keys. Alternatively, the default behavior is to use the anonymous user, and then users can use their own keys.

Perforce Admin User Ticket

com.perforce.artifacts.core.admin.p4ticket

empty

The long lived ticket to authorize the Perforce Admin User.

Anonymous Search User

com.perforce.artifacts.core.anonymous.p4user

empty

An Anonymous user with read permissions for the areas of the depot you want to allow search result access to. The anonymous search user is used for the unsupported search web pages. For instructions on setting the Anonymous User and printing out the ticket, see Creating the anonymous user (optional). If the anonymous user is not defined, anonymous access is disabled.

Anonymous Search User Ticket

com.perforce.artifacts.core.anonymous.p4ticket

empty

The long lived ticket to authorize the anonymous search user.

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

com.perforce.artifacts.core.cache.root

../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.

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.

Helix Artifacts Maven configuration

Configurable Configurable name in config.properties file Default Description

Product name

com.perforce.artifacts.maven.product

ha-maven

The name that is shown in the Helix server log.

Product version

com.perforce.artifacts.maven.version

0.1

The product version that is shown in the Helix server log. Default value, the installed version of ha-maven.

Log configuration file

com.perforce.artifacts.maven.log

log4j2.xml

Set the log file name the Helix Artifacts Maven log is saved as.

Host address

com.perforce.artifacts.maven.host

0.0.0.0

The host IP address for the ha-maven service.

Service port

com.perforce.artifacts.maven.port

1603

The ha-maven service port.

Protocol

com.perforce.artifacts.maven.protocol

http

The protocol used for the ha-maven service. Options are: http or https.

Java keystore location

com.perforce.artifacts.maven.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.maven.secure.keypass

empty

Only if protocol is set to https. The Java Keystore password, see Configuring SSL for Helix Artifacts (Optional).

(CORS) Allowed Origin

com.perforce.artifacts.maven.access-control-allow-origin

empty

Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access.

Config Auth-Token

com.perforce.artifacts.maven.config.token

empty

An X-Auth-Token to validate configuration requests

Anonymous search user

com.perforce.artifacts.maven.anonymous.p4user

empty

The Helix server anonymous user account to authorize the Helix server connection. See Creating the anonymous user (optional)

Anonymous search ticket

com.perforce.artifacts.maven.anonymous.p4ticket

empty

The long lived ticket to authorize the Perforce anonymous User.

Setup retry interval

com.perforce.artifacts.maven.setup.retry

30000

The retry interval used by ha-maven when locating services (milliseconds).

Cache root

com.perforce.artifacts.maven.cache.root

../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.

HA-Core URL

com.perforce.artifacts.maven.hacore.url

http://localhost:1600

The url and port number of the ha-core service.

External URL

com.perforce.artifacts.maven.external.url

http://localhost:1603

The external url and port number of the ha-maven service.

Helix Artifacts Docker configuration

Configurable Configurable name in config.properties file Default Description

Product name

com.perforce.artifacts.docker.product

ha-docker

The name that is shown in the Helix server log.

Product version

com.perforce.artifacts.docker.version

0.1

The product version that is shown in the Helix server log. Default value, the installed version of ha-docker.

Log configuration file

com.perforce.artifacts.docker.log

log4j2.xml

Set the log file name the Helix Artifacts Docker log is saved as.

Host address

com.perforce.artifacts.docker.host

0.0.0.0

The host IP address for the ha-docker service.

Service port

com.perforce.artifacts.docker.port

1605

The ha-docker service port.

Protocol

com.perforce.artifacts.docker.protocol

http

The protocol used for the ha-docker service. Options are: http or https.

Java keystore location

com.perforce.artifacts.docker.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.docker.secure.keypass

empty

Only if protocol is set to https. The Java Keystore password, see Configuring SSL for Helix Artifacts (Optional).

(CORS) Allowed Origin

com.perforce.artifacts.docker.access-control-allow-origin

empty

Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access.

Config Auth-Token

com.perforce.artifacts.docker.config.token

empty

An X-Auth-Token to validate configuration requests

Anonymous search user

com.perforce.artifacts.docker.anonymous.p4user

empty

The Helix server anonymous user account to authorize the Helix server connection. See Creating the anonymous user (optional)

Anonymous search ticket

com.perforce.artifacts.docker.anonymous.p4ticket

empty

The long lived ticket to authorize the Perforce anonymous User.

Setup retry interval

com.perforce.artifacts.docker.setup.retry

30000

The retry interval used by ha-docker when locating services (milliseconds).

Cache root

com.perforce.artifacts.docker.cache.root

../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.

HA-Core URL

com.perforce.artifacts.docker.hacore.url

http://localhost:1600

The url and port number of the ha-core service.

External URL

com.perforce.artifacts.docker.external.url

http://localhost:1605

The external url and port number of the ha-docker service.

Helix Artifacts Generic configuration

Configurable Configurable name in config.properties file Default Description

Product name

com.perforce.artifacts.generic.product

ha-generic

The name that is shown in the Helix server log.

Product version

com.perforce.artifacts.generic.version

0.1

The product version that is shown in the Helix server log. Default value, the installed version of ha-generic.

Log configuration file

com.perforce.artifacts.generic.log

log4j2.xml

Set the log file name the Helix Artifacts Generic log is saved as.

Host address

com.perforce.artifacts.generic.host

0.0.0.0

The host IP address for the ha-generic service.

Service port

com.perforce.artifacts.generic.port

1602

The ha-generic service port.

Protocol

com.perforce.artifacts.generic.protocol

http

The protocol used for the ha-generic service. Options are: http or https.

Java keystore location

com.perforce.artifacts.generic.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.generic.secure.keypass

empty

Only if protocol is set to https. The Java Keystore password, see Configuring SSL for Helix Artifacts (Optional).

(CORS) Allowed Origin

com.perforce.artifacts.generic.access-control-allow-origin

empty

Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access.

Config Auth-Token

com.perforce.artifacts.generic.config.token

empty

An X-Auth-Token to validate configuration requests

Anonymous search user

com.perforce.artifacts.generic.anonymous.p4user

empty

The Helix server anonymous user account to authorize the Helix server connection. See Creating the anonymous user (optional)

Anonymous search ticket

com.perforce.artifacts.generic.anonymous.p4ticket

empty

The long lived ticket to authorize the Perforce anonymous User.

Setup retry interval

com.perforce.artifacts.generic.setup.retry

30000

The retry interval used by ha-generic when locating services (milliseconds).

Cache root

com.perforce.artifacts.generic.cache.root

../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.

HA-Core URL

com.perforce.artifacts.generic.hacore.url

http://localhost:1600

The url and port number of the ha-core service.

External URL

com.perforce.artifacts.generic.external.url

http://localhost:1602

The external url and port number of the ha-generic service.

Helix Artifacts PyPI configuration

Configurable Configurable name in config.properties file Default Description

Product name

com.perforce.artifacts.pypi.product

ha-pypi

The name that is shown in the Helix server log.

Product version

com.perforce.artifacts.pypi.version

0.1

The product version that is shown in the Helix server log. Default value, the installed version of ha-pypi.

Log configuration file

com.perforce.artifacts.pypi.log

log4j2.xml

Set the log file name the Helix Artifacts PyPI log is saved as.

Host address

com.perforce.artifacts.pypi.host

0.0.0.0

The host IP address for the ha-pypi service.

Service port

com.perforce.artifacts.pypi.port

1606

The ha-pypi service port.

Protocol

com.perforce.artifacts.pypi.protocol

http

The protocol used for the ha-pypi service. Options are: http or https.

Java keystore location

com.perforce.artifacts.pypi.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.pypi.secure.keypass

empty

Only if protocol is set to https. The Java Keystore password, see Configuring SSL for Helix Artifacts (Optional).

(CORS) Allowed Origin

com.perforce.artifacts.pypi.access-control-allow-origin

empty

Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access.

Config Auth-Token

com.perforce.artifacts.pypi.config.token

empty

An X-Auth-Token to validate configuration requests

Anonymous search user

com.perforce.artifacts.pypi.anonymous.p4user

empty

The Helix server anonymous user account to authorize the Helix server connection. See Creating the anonymous user (optional)

Anonymous search ticket

com.perforce.artifacts.pypi.anonymous.p4ticket

empty

The long lived ticket to authorize the Perforce anonymous User.

Setup retry interval

com.perforce.artifacts.pypi.setup.retry

30000

The retry interval used by ha-pypi when locating services (milliseconds).

Cache root

com.perforce.artifacts.pypi.cache.root

../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.

HA-Core URL

com.perforce.artifacts.pypi.hacore.url

http://localhost:1600

The url and port number of the ha-pypi service.

External URL

com.perforce.artifacts.pypi.external.url

http://localhost:1606

The external url and port number of the ha-pypi service.

Helix Artifacts NuGet configuration

Configurable Configurable name in config.properties file Default Description

Product name

com.perforce.artifacts.nuget.product

ha-nuget

The name that is shown in the Helix server log.

Product version

com.perforce.artifacts.nuget.version

0.1

The product version that is shown in the Helix server log. Default value, the installed version of ha-nuget.

Log configuration file

com.perforce.artifacts.nuget.log

log4j2.xml

Set the log file name the Helix Artifacts NuGet log is saved as.

Host address

com.perforce.artifacts.nuget.host

0.0.0.0

The host IP address for the ha-nuget service.

Service port

com.perforce.artifacts.nuget.port

1604

The ha-nuget service port.

Protocol

com.perforce.artifacts.nuget.protocol

http

The protocol used for the ha-nuget service. Options are: http or https.

Java keystore location

com.perforce.artifacts.nuget.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.nuget.secure.keypass

empty

Only if protocol is set to https. The Java Keystore password, see Configuring SSL for Helix Artifacts (Optional).

(CORS) Allowed Origin

com.perforce.artifacts.nuget.access-control-allow-origin

empty

Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access.

Config Auth-Token

com.perforce.artifacts.nuget.config.token

empty

An X-Auth-Token to validate configuration requests

Anonymous search user

com.perforce.artifacts.nuget.anonymous.p4user

empty

The Helix server anonymous user account to authorize the Helix server connection. See Creating the anonymous user (optional)

Anonymous search ticket

com.perforce.artifacts.nuget.anonymous.p4ticket

empty

The long lived ticket to authorize the Perforce anonymous User.

Setup retry interval

com.perforce.artifacts.nuget.setup.retry

30000

The retry interval used by ha-nuget when locating services (milliseconds).

Cache root

com.perforce.artifacts.nuget.cache.root

../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.

HA-Core URL

com.perforce.artifacts.nuget.hacore.url

http://localhost:1600

The url and port number of the ha-core service.

External URL

com.perforce.artifacts.nuget.external.url

http://localhost:1604

The external url and port number of the ha-nuget service.