Architecture > Configuration Guide

How Do You Configure 3forge?

Overview

By default, 3forge ships with a defaults.properties file located in the amione/config folder of the root directory of your installation. This contains the base configuration required for a default 3forge installation.

This is helpful for initial setup, but for any additional functionality including additional plugins, you will need to configure your own properties by creating a local.properties file.

Warning

We do not recommend changing the defaults.properties file as it gets overwritten on update.

Please configure your 3forge instance in a local.properties file.

Properties List

There are 5 categories of 3forge properties responsible for customizing different aspects of a 3forge instance:

1. Common

   • Properties that are common across all AMI components

2. Center

   • Properties specific to the Center

3. Web

   • Properties specific to the Web

4. Relay

   • Properties specific to the Relay

5. WebBalancer

   • Properties for configuring deployments with multiple Web servers

See each page for a comprehensive list of properties for each category.

Note

You may not need to configure every property listed in the pages above. We have specific guides for configuring 3forge for additional functionality hosted throughout our documentation.

If you want more information or help with properties, please contact us at support@3forge.com

Setup

In the root directory of your installation, navigate to the amione/config directory and create a new, empty local.properties file.

You can then populate the file line-by-line with your desired properties where each property follows the format: property.name=value.

Note

For instructions on how to encrypt properties, see the encryption section.

Example

Below is a sample local.properties file:

#My local.properties located under config directory
#Lines beginning with # are comments (except for #INCLUDE)

#Override the http port to standard port
http.port=80

#Override the location of the access.txt file
users.access.file=/home/myname/access.txt

#Process and include properties from a custom properties file
#INCLUDE home/env_specific.properties

#Define my own custom value
my.custom.value=5

#Reference my custom value
ami.frames.per.second=${my.custom.value}

#Append to an existing variable
ami.datasource.plugins=$${ami.datasource.plugins},com.my.Plugin

#Remove a specific property in any of 3forge's prepackaged configuration (root.properties, speedlogger.properties, defaults.properties). 

#UNDEFINE  speedlogger.sink.FILE_SINK.maxFiles=10

Multiple .properties Files

While we recommend just using local.properties for your 3forge environments, you can specify multiple .properties files.

If you have multiple configuration files and environments, e.g: my_env.properties, you can configure a 3forge instance by doing the following:

1. Ensure my_env.properties is in the amione/config directory of the 3forge instance's installation
2. Create a local.properties file if it does not exist

3. Add the following line to your local.properties file:

   #INCLUDE my_env.properties