Configurations

ICCR reads configuration settings from the file /opt/iccr/conf/iccr.properties.

In addition, ICCR will also read language specific settings (i.e. language localization translation strings) from a file whose name starts with "MessagesBundle" (see Language Localization below).

The iccr.properties file follows the Java properties file format, i.e. key=value.

The following properties are available in the /opt/iccr/conf/iccr.properties:

• iccrLanguageLocale See the Language Localization section.

• iccrCountryLocale See the Language Localization section.

iccrApiKey This specifies the value of ICCR API access key. If this exact value is not in each client request HTTP header, then that client request will be refused. Each client request should have a header with this name: ICCR-API-KEY with its value being the value specified by this iccrApiKey property.

iccrDir This specifies the base ICCR installation directory. By default it is set to /opt/iccr.

iccrPortNumber This property specifies the port number that ICCR will listen for incoming client API requests. It can be changed by a client application through the ICCR API. The default value is 14266 iccrPortNumber=14266.

iotaDownloadLink This property specifies the URL (hostname and path) to the location and path that the IOTA IRI jar file will be downloaded from. It can be changed by a client application through the ICCR API. The value of this property is used when a client application uses the ICCR API to download IOTA. The current default value is iotaDownloadLink=http://85.93.93.110/iri-1.1.2.3.jar.

iotaDir This property specifies the location on the ICCR machine where the IOTA IRI is located. When IOTA IRI is downloaded, the IRI file will be copied into this directory. When the IRI process is started, its logging output will be written to the file /opt/iota/console.log. The default value is /opt/iota or iotaDir=/opt/iota.

iotaStartCmd This property specifies the command string that will be used to execute the IOTA IRI. It can be changed by a client application through the ICCR API. The current default value is "java -jar IRI.jar -p" iotaStartCmd=java -jar IRI.jar -p.

iotaPortNumber This property specifies the port number that the IOTA IRI process will listen on. It can be changed by a client application through the ICCR API. When ICCR starts the IOTA IRI process (using the iotaStartCmd property), the value of the iotaPortNumber property will be added to the end of the start command. The default value is 14265 or iotaPortNumber=14265.

iotaNeighborRefreshTime This property specifies an interval of time in minutes at which the ICCR will refresh the list of neighbors being used by the running IOTA IRI process. It can be changed by a client application through the ICCR API. Every interval of time specified by this property, the ICCR will remove and then re-add the currently configured list of neighbors. The default is 10 (minutes) iotaNeighborRefreshTime=10

iotaNeighbors This property specifies set of neighbor nodes that will be added to the IOTA IRI process. Individual neighbor nodes can be added or removed by a client application through the ICCR API. When a client application adds a neighbor while IOTA is running, that new neighbor will be immediately added. If a client application removes a neighbor while IOTA is running, that new neighbor will be immediately removed from IOTA.

• The value of the iotaNeighbors property is just a comma separated list of neighbor ID values. Each of these neighbor ID values are only used to generate second individual neighbor property names that specify the actual neighbor configuration.

• Each neighbor ID value in the iotaNeighbors property list is a unique identifier of that neighbor. The ID is used to specify a block of configuration properties for that neighbor. There will be one block of configuration properties for each neighbor. Each neighbor configuration block has five properties: key, name, descr, active, and uri. Each neighbor configuration property block specifies those five properties using a mechanism that embeds the neighbor ID in the property name. The pattern for the individual neighbor property name is iotaNeighbor..=

• Example:

iotaNeighbors=david,johan The block of properties for neighbor "david": iotaNeighbor.key.david=david iotaNeighbor.uri.david=udp://192.0.0.1:14265 iotaNeighbor.name.david=David iotaNeighbor.descr.david=David node iotaNeighbor.active.david=true

The block of properties for neighbor "johan":

iotaNeighbor.key.johan=johan iotaNeighbor.uri.johan=udp://192.0.0.2:14265 iotaNeighbor.name.johan=Johan iotaNeighbor.descr.johan=Johan Node iotaNeighbor.active.johan=true