Difference between revisions of "AMI Configuration Guide"

From 3forge Documentation
Jump to navigation Jump to search
Tag: visualeditor-switched
Tag: visualeditor-switched
Line 29: Line 29:
  
 
<span style="font-family: courier new; color: green;">users.access.file=/</span><span style="font-family: courier new; color: blue;">home/myname/access.txt</span>
 
<span style="font-family: courier new; color: green;">users.access.file=/</span><span style="font-family: courier new; color: blue;">home/myname/access.txt</span>
 +
 +
== Common Properties (AMI One, AMI Center, AMI Relay, AMI Web) ==
 +
 +
* <span style="font-family: courier new; color: blue;">f1.terminate.file</span>: if supplied, then a file at specified location will be created. If an external process moves / copies to a file of the same name, but with a ".kill" suffix the process will exit.
 +
* <span style="font-family: courier new; color: blue;">f1.threadpool.default.size</span>: property name associated with the number of threads in the default thread pools.
 +
* <span style="font-family: courier new; color: blue;">f1.threadpool.aggressive</span>: if true will use an "aggressive" thread pool. This pool will wake up faster, but uses more CPU while idle.
 +
* <span style="font-family: courier new; color: blue;">f1.conf.dir</span>: directory to where the configuration files are located, default is ''config''.
 +
* <span style="font-family: courier new; color: blue;">f1.conf.filename</span>: name of the configuration file loaded at start up, default is ''root.properties''.
 +
* <span style="font-family: courier new; color: blue;">f1.timezone</span>: default time zone.
 +
* <span style="font-family: courier new; color: blue;">f1.locale</span>: default locale.
 +
* <span style="font-family: courier new; color: blue;">f1.logs.dir</span>: the root directory for where log files will be deposited.
 +
* <span style="font-family: courier new; color: blue;">f1.plugins.dir</span>: directory of where plugins are located.
 +
* <span style="font-family: courier new; color: blue;">f1.resources.dir</span>: directory of where additional resources will be placed.
 +
* <span style="font-family: courier new; color: blue;">ami.components</span>: a comma delimited list of which components to load. The components include relay, center and web. The default for AmiOne is all three: relay,center,web.

Revision as of 13:58, 18 March 2021

IMPORTANT - TO OVERRIDE PROPERTIES

Overview

Create a config/local.properties file and place each property to override on its own line in the format property.name=value

Step By Step

For amione, browse to the 3forge > amione > config directory and create a new, empty local.properties file. For amicenter, amirelay and amiweb browse to the config directory.

Hint

You can copy the default.properties to local.properties to get started with good default values.

Why we do this

So that even if you download and update a new version of AMI One, this file will not be overwritten (we will never include a local.properties file in the zip)

Sample local.properties

#My local.properties located under config directory

#Note, lines starting with pounds are comments

#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

Common Properties (AMI One, AMI Center, AMI Relay, AMI Web)

  • f1.terminate.file: if supplied, then a file at specified location will be created. If an external process moves / copies to a file of the same name, but with a ".kill" suffix the process will exit.
  • f1.threadpool.default.size: property name associated with the number of threads in the default thread pools.
  • f1.threadpool.aggressive: if true will use an "aggressive" thread pool. This pool will wake up faster, but uses more CPU while idle.
  • f1.conf.dir: directory to where the configuration files are located, default is config.
  • f1.conf.filename: name of the configuration file loaded at start up, default is root.properties.
  • f1.timezone: default time zone.
  • f1.locale: default locale.
  • f1.logs.dir: the root directory for where log files will be deposited.
  • f1.plugins.dir: directory of where plugins are located.
  • f1.resources.dir: directory of where additional resources will be placed.
  • ami.components: a comma delimited list of which components to load. The components include relay, center and web. The default for AmiOne is all three: relay,center,web.