Micro-service configuration files

The Helix Artifacts micro-services are setup with configuration files.

Helix Artifacts Core configuration file

Tip

Helix Artifacts can also be configured using the Helix Artifacts web UI, see Configuring Helix Artifacts.

The config.properties file for ha-core configures Helix Artifacts micro-service:

Configurable Default Description
com.perforce.artifacts.core.log log4j2.xml Set the log file name the Helix Artifacts log is saved as.
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).
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).
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.
com.perforce.artifacts.core.protocol http The protocol used for the Helix Artifacts service. Options are: http or https.
com.perforce.artifacts.core.product ha-core The name that is shown in the Helix server log.
com.perforce.artifacts.core.config.token empty An X-Auth-Token to validate configuration requests
com.perforce.artifacts.core.p4trust empty The p4trust trusted fingerprint.
com.perforce.artifacts.core.service.p4user empty A 'standard' Perforce user account to authorize the proxy connections up to security level 4.
com.perforce.artifacts.core.setup.retry 30000 The retry interval used by Helix Artifacts when locating ElasticSearch and Perforce Services (milliseconds).
     
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
com.perforce.artifacts.core.host 0.0.0.0 The host IP address for the Helix Artifacts service.
com.perforce.artifacts.core.access-control-allow-origin empty Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access.
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.
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.
com.perforce.artifacts.core.port 1600 The port number for the Helix Artifacts service.
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.
com.perforce.artifacts.core.p4ignore ha.p4ignore The P4IGNORE file for Helix Artifacts.
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.
     
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.

com.perforce.artifacts.core.p4search.url http://localhost:1601 The Url of the Helix Search service. For example, http://helix-search:1601
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.

Example config.properties file for ha-core:

# Helix Artifacts configuration
com.perforce.artifacts.core.product=ha-core
com.perforce.artifacts.core.version=0.1
com.perforce.artifacts.core.log=log4j2.xml
com.perforce.artifacts.core.host=0.0.0.0
com.perforce.artifacts.core.port=1600
com.perforce.artifacts.core.protocol=http
com.perforce.artifacts.core.secure.keystore=
com.perforce.artifacts.core.secure.keypass=
com.perforce.artifacts.core.security.required=false
com.perforce.artifacts.core.access-control-allow-origin=*
com.perforce.artifacts.core.setup.retry=30000 
			
# Perforce config
com.perforce.artifacts.core.p4port=localhost:1666
com.perforce.artifacts.core.p4trust=
com.perforce.artifacts.core.service.p4user=super
com.perforce.artifacts.core.service.p4ticket=AEEB1208CB06479B022D97C2784EEFDA
com.perforce.artifacts.core.p4ignore=ha.p4ignore
com.perforce.artifacts.core.config.token=00000000-0000-0000-0000-000000000000
com.perforce.artifacts.core.trusted.ips=
com.perforce.artifacts.core.permission.required=true 
			
# Core
com.perforce.artifacts.core.cache.root=cache
com.perforce.artifacts.core.p4search.url=http://localhost:1601
com.perforce.artifacts.core.help.url=https://www.perforce.com/manuals/helix-artifacts/Content/HelixArtifacts/Home-helixartifacts.html

Helix Artifacts Maven configuration file

The config.properties file for ha-maven configures the Maven micro-service:

Configurable Default Description
com.perforce.artifacts.maven.product ha-maven The name that is shown in the Helix server log.
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.
com.perforce.artifacts.core.log log4j2.xml Set the log file name the Helix Artifacts Maven log is saved as.
     
com.perforce.artifacts.maven.host 0.0.0.0 The host IP address for the ha-maven service.
com.perforce.artifacts.maven.port 1603 The ha-maven service port.
com.perforce.artifacts.maven.protocol http The protocol used for the ha-maven service. Options are: http or https.
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).
com.perforce.artifacts.maven.secure.keypass empty Only if protocol is set to https. The location of the Java Keystore, see Configuring SSL for Helix Artifacts (Optional).
com.perforce.artifacts.maven.access-control-allow-origin empty Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access.
com.perforce.artifacts.maven.config.token empty An X-Auth-Token to validate configuration requests
com.perforce.artifacts.maven.anonymous.p4user empty The Helix server anonymous user account to authorize the Helix server connection.
com.perforce.artifacts.maven.anonymous.p4ticket empty The long lived ticket to authorize the Perforce anonymous User. To print out a long lived ticket for the Perforce anonymous user that is valid for all hosts, run the following command : p4 -p <p4port> -u <p4user> login -a -p
com.perforce.artifacts.maven.setup.retry 30000 The retry interval used by ha-maven when locating services (milliseconds).
     
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.

com.perforce.artifacts.maven.hacore.url http://localhost:1600 The url and port number of the ha-core service.
com.perforce.artifacts.maven.external.url http://localhost:1603 The external url and port number of the ha-maven service.

Example config.properties file for ha-maven:

# Helix Artifacts configuration
com.perforce.artifacts.maven.product=ha-maven
com.perforce.artifacts.maven.version=0.1
com.perforce.artifacts.maven.log=log4j2.xml
 
com.perforce.artifacts.maven.host=127.0.0.1
com.perforce.artifacts.maven.port=1603
com.perforce.artifacts.maven.protocol=http
com.perforce.artifacts.maven.secure.keystore=
com.perforce.artifacts.maven.secure.keypass=
com.perforce.artifacts.maven.access-control-allow-origin=
com.perforce.artifacts.maven.config.token=00000000-0000-0000-0000-000000000000
com.perforce.artifacts.maven.anonymous.p4user=super
com.perforce.artifacts.maven.anonymous.p4ticket=AEEB1208CB06479B022D97C2784EEFDA
com.perforce.artifacts.maven.setup.retry=30000
 
# Artifact
com.perforce.artifacts.maven.cache.root=../cache
com.perforce.artifacts.maven.hacore.url=http://localhost:1600
com.perforce.artifacts.maven.external.url=http://localhost:1603

Helix Artifacts Docker configuration file

The config.properties file for ha-docker configures the Docker micro-service:

Configurable Default Description
com.perforce.artifacts.docker.product ha-docker The name that is shown in the Helix server log.
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.
com.perforce.artifacts.core.log log4j2.xml Set the log file name the Helix Artifacts Maven log is saved as.
     
com.perforce.artifacts.docker.host 0.0.0.0 The host IP address for the ha-docker service.
com.perforce.artifacts.docker.port 1605 The ha-docker service port.
com.perforce.artifacts.docker.protocol http The protocol used for the ha-docker service. Options are: http or https.
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).
com.perforce.artifacts.docker.secure.keypass empty Only if protocol is set to https. The location of the Java Keystore, see Configuring SSL for Helix Artifacts (Optional).
com.perforce.artifacts.docker.access-control-allow-origin empty Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access.
com.perforce.artifacts.docker.config.token empty An X-Auth-Token to validate configuration requests
com.perforce.artifacts.docker.anonymous.p4user empty The Helix server anonymous user account to authorize the Helix server connection.
com.perforce.artifacts.docker.anonymous.p4ticket empty The long lived ticket to authorize the Perforce anonymous User. To print out a long lived ticket for the Perforce anonymous user that is valid for all hosts, run the following command : p4 -p <p4port> -u <p4user> login -a -p
com.perforce.artifacts.docker.setup.retry 30000 The retry interval used by ha-docker when locating services (milliseconds).
     
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.

com.perforce.artifacts.docker.hacore.url http://localhost:1600 The url and port number of the ha-core service.
com.perforce.artifacts.docker.external.url http://localhost:1605 The external url and port number of the ha-docker service.

Example config.properties file for ha-docker:

# Helix Artifacts configuration
com.perforce.artifacts.docker.product=ha-docker
com.perforce.artifacts.docker.version=0.1
com.perforce.artifacts.docker.log=log4j2.xml

com.perforce.artifacts.docker.host=127.0.0.1
com.perforce.artifacts.docker.port=1605
com.perforce.artifacts.docker.protocol=http
com.perforce.artifacts.docker.secure.keystore=
com.perforce.artifacts.docker.secure.keypass=
com.perforce.artifacts.docker.access-control-allow-origin=
com.perforce.artifacts.docker.config.token=00000000-0000-0000-0000-000000000000
com.perforce.artifacts.docker.anonymous.p4user=super
com.perforce.artifacts.docker.anonymous.p4ticket=AEEB1208CB06479B022D97C2784EEFDA
com.perforce.artifacts.docker.setup.retry=30000

# Artifact
com.perforce.artifacts.docker.cache.root=../cache
com.perforce.artifacts.docker.hacore.url=http://localhost:1600
com.perforce.artifacts.docker.external.url=http://localhost:1605

Helix Artifacts generic configuration file

The config.properties file for ha-generic configures the Generic micro-service:

Configurable Default Description
com.perforce.artifacts.generic.product ha-generic The name that is shown in the Helix server log.
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.
com.perforce.artifacts.generic.log log4j2.xml Set the log file name the Helix Artifacts Generic log is saved as.
     
com.perforce.artifacts.generic.host 0.0.0.0 The host IP address for the ha-generic service.
com.perforce.artifacts.generic.port 1602 The ha-generic service port.
com.perforce.artifacts.generic.protocol http The protocol used for the ha-generic service. Options are: http or https.
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).
com.perforce.artifacts.generic.secure.keypass empty Only if protocol is set to https. The location of the Java Keystore, see Configuring SSL for Helix Artifacts (Optional).
com.perforce.artifacts.generic.access-control-allow-origin empty Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access.
com.perforce.artifacts.generic.config.token empty An X-Auth-Token to validate configuration requests
com.perforce.artifacts.generic.anonymous.p4user empty The Helix server anonymous user account to authorize the Helix server connection.
com.perforce.artifacts.generic.anonymous.p4ticket empty The long lived ticket to authorize the Perforce anonymous User. To print out a long lived ticket for the Perforce anonymous user that is valid for all hosts, run the following command : p4 -p <p4port> -u <p4user> login -a -p
com.perforce.artifacts.generic.setup.retry 30000 The retry interval used by ha-generic when locating services (milliseconds).
     
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.

com.perforce.artifacts.generic.hacore.url http://localhost:1600 The url and port number of the ha-core service.
com.perforce.artifacts.generic.external.url http://localhost:1602 The external url and port number of the ha-generic service.

Example config.properties file for ha-generic:

# Helix Artifacts configuration
com.perforce.artifacts.generic.product=ha-generic
com.perforce.artifacts.generic.version=0.1
com.perforce.artifacts.generic.log=log4j2.xml

com.perforce.artifacts.generic.host=127.0.0.1
com.perforce.artifacts.generic.port=1602
com.perforce.artifacts.generic.protocol=http
com.perforce.artifacts.generic.secure.keystore=
com.perforce.artifacts.generic.secure.keypass=
com.perforce.artifacts.generic.access-control-allow-origin=
com.perforce.artifacts.generic.config.token=00000000-0000-0000-0000-000000000000
com.perforce.artifacts.generic.anonymous.p4user=super
com.perforce.artifacts.generic.anonymous.p4ticket=AEEB1208CB06479B022D97C2784EEFDA
com.perforce.artifacts.generic.setup.retry=30000

# Artifact
com.perforce.artifacts.generic.cache.root=../cache
com.perforce.artifacts.generic.hacore.url=http://localhost:1600
com.perforce.artifacts.generic.external.url=http://localhost:1602

Helix Artifacts NuGet configuration file

The config.properties file for ha-nuget configures the NuGet micro-service:

Configurable Default Description
com.perforce.artifacts.nuget.product ha-nuget The name that is shown in the Helix server log.
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.
com.perforce.artifacts.nuget.log log4j2.xml Set the log file name the Helix Artifacts NuGet log is saved as.
     
com.perforce.artifacts.nuget.host 0.0.0.0 The host IP address for the ha-nuget service.
com.perforce.artifacts.nuget.port 1604 The ha-nuget service port.
com.perforce.artifacts.nuget.protocol http The protocol used for the ha-nuget service. Options are: http or https.
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).
com.perforce.artifacts.nuget.secure.keypass empty Only if protocol is set to https. The location of the Java Keystore, see Configuring SSL for Helix Artifacts (Optional).
com.perforce.artifacts.nuget.access-control-allow-origin empty Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access.
com.perforce.artifacts.nuget.config.token empty An X-Auth-Token to validate configuration requests
com.perforce.artifacts.nuget.anonymous.p4user empty The Helix server anonymous user account to authorize the Helix server connection.
com.perforce.artifacts.nuget.anonymous.p4ticket empty The long lived ticket to authorize the Perforce anonymous User. To print out a long lived ticket for the Perforce anonymous user that is valid for all hosts, run the following command : p4 -p <p4port> -u <p4user> login -a -p
com.perforce.artifacts.nuget.setup.retry 30000 The retry interval used by ha-nuget when locating services (milliseconds).
     
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.

com.perforce.artifacts.nuget.hacore.url http://localhost:1600 The url and port number of the ha-core service.
com.perforce.artifacts.nuget.external.url http://localhost:1604 The external url and port number of the ha-nuget service.

Example config.properties file for ha-nuget:

# Helix Artifacts configuration
com.perforce.artifacts.nuget.product=ha-nuget
com.perforce.artifacts.nuget.version=0.1
com.perforce.artifacts.nuget.log=log4j2.xml
			 
com.perforce.artifacts.nuget.host=127.0.0.1
com.perforce.artifacts.nuget.port=1604
com.perforce.artifacts.nuget.protocol=http
com.perforce.artifacts.nuget.secure.keystore=
com.perforce.artifacts.nuget.secure.keypass=
com.perforce.artifacts.nuget.access-control-allow-origin=
com.perforce.artifacts.nuget.config.token=00000000-0000-0000-0000-000000000000
com.perforce.artifacts.nuget.anonymous.p4user=super
com.perforce.artifacts.nuget.anonymous.p4ticket=AEEB1208CB06479B022D97C2784EEFDA
com.perforce.artifacts.nuget.setup.retry=30000
			 
# Artifact
com.perforce.artifacts.nuget.cache.root=../cache
com.perforce.artifacts.nuget.hacore.url=http://localhost:1600
com.perforce.artifacts.nuget.external.url=http://localhost:1604 

Helix Search and Elasticsearch

For instructions on configuring Helix Search and Elasticsearch, see the Helix Core Search Developer Guide.