Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

1.3 Amazon Services Properties

"use.aws" should always be "true" for "AWS" templates and "false" for "STANDALONE" templates

The s3.url property is required for backups when Infinit.e is hosted on Amazon.

Code Block
#-------------------------------------------------------------------------------
# 1.3] Amazon services properties
#-------------------------------------------------------------------------------
# This is the root s3 bucket name to be used for backups (use.aws=1 only):
# (The following names are used: mongo.<s3.url>, elasticsearch.<s3.url> .. daily backups in the same region
#  backup.mongo.<s3.url>, backup.elasticsearch.<s3.url> ... monthly backups in a different region
#  Note these dirs need to be set up manually)
s3.url=
1.4 EMail Server Settings

The following properties need to be filled out in order for Infinit.e to be able to send messages via email (system errors, communications to/from users, etc).

Code Block

#-------------------------------------------------------------------------------
# 12.43] EMailAmazon Serverservices Settingsproperties
#-------------------------------------------------------------------------------
# The server to be used for mail transactions (eg smtp.google.com if Internet-enabled, contact your sysadmin if not):
mail.server=
# Base-64 encoded SHA-256 hash of username:
mail.username=
# Base-64 encoded SHA-256 hash of password:
mail.password=
# This URL is used as the base for links included in the 
# So should point to an accessible REST endpoint (eg the same as ui.end.point.url below)
# If this is left commented out, it defaults to the browser domain (ie location of GUI)
#url.root=http://MY_REST_ENDPOINT/api/
1.5 Email Addresses  for Log Files

Addresses to send log files from and to.

Values: 0=false, 1=true
# If deployed on an EC2 cluster set this to 1:
use.aws=0
1.4 EMail Server Settings

The following properties need to be filled out in order for Infinit.e to be able to send messages via email (system errors, communications to/from users, etc).

Code Block
#-------------------------------------------------------------------------------
# 1.54] EMail AddressesServer for log files etc.
#-Settings
#-------------------------------------------------------------------------------
# All emails come from this user:
log.files.mail.from=
# System alert emails come from this user:
log.files.mail.to=
1.6 API Search Test Terms and Expected Results
1.7 Amazon AWS Settings

AWS access and secret keys required for the Infinit.e platform to access AWS.

Code Block
#-------------------------------------------------------------------------------

# 1.7] Amazon AWS Settings
# The server to be used for mail transactions (eg smtp.google.com if Internet-enabled, contact your sysadmin if not):
mail.server=
# Base-64 encoded SHA-256 hash of username:
mail.username=
# Base-64 encoded SHA-256 hash of password:
mail.password=
# This URL is used as the base for links included in the 
# So should point to an accessible REST endpoint (eg the same as ui.end.point.url below)
# If this is left commented out, it defaults to the browser domain (ie location of GUI)
#url.root=http://MY_REST_ENDPOINT/api/
1.5 Email Addresses  for Log Files

Addresses to send log files from and to.

Code Block
#-------------------------------------------------------------------------------
# AWS keys (only needed if use.aws=1)
aws.access.key=
aws.secret.key=
1.8 MongoDB Properties

MongoDB configuration properties that need to be set on any non-EC2/AWS installation.

Code Block
1.5] EMail Addresses for log files etc.
#-------------------------------------------------------------------------------
# 1.8] MongoDB Properties
#------ All emails come from this user:
log.files.mail.from=
# System alert emails come from this user:
log.files.mail.to=
1.6 API Search Test Terms and Expected Results
1.7 Amazon AWS Settings

AWS access and secret keys required for the Infinit.e platform to access AWS.

Code Block
#-------------------------------------------------------------------------------

# MongoDB config server or servers (must be 1 or 3 comma separated IPs), non-EC2/AWS installations only
db.config.servers=
db.replica.sets=
#1.7] Amazon AWS Settings
#-------------------------------------------------------------------------------
# db.cluster.subnet - used for non-EC2/AWS only installations to help mongodb configurations
# identify proper host ip addresses, e.g. 127.0.0.
db.cluster.subnet=
1.9 UI settings

...

AWS keys (only needed if use.aws=1)
aws.access.key=
aws.secret.key=
1.8 MongoDB Properties

MongoDB configuration properties that need to be set on any non-EC2/AWS installation.

Code Block
#-------------------------------------------------------------------------------
# 1.98] UIMongoDB settingsProperties
#-------------------------------------------------------------------------------
# TheMongoDB passphraseconfig forserver theor SSLservers keystore (notmust neededbe unless1 HTTPSor is3 beingcomma used)
ssl.passphrase=
# This is a regex that, if specified, will allow only access to REST commands matching
# the pattern - only applied to remote clients. Connections from localhost always have access 
# to everything
# Eg the commented out example will allow only login/keepalive and querying.
#remote.access.allow=^/api/(knowledge/document/query|auth/login|auth/keepalive)
remote.access.allow=
# This parameter does the opposite, allows everything except specified commands
remote.access.deny=
1.10 Elasticsearch Properties

The elastic.cluster property is required by all installations. The elastic.search.nodes property is only used in non-EC2/AWS installations.

Code Block
#--separated IPs), non-EC2/AWS installations only
db.config.servers=
db.replica.sets=
#----------------------------------------------
# db.cluster.subnet - used for non-EC2/AWS only installations to help mongodb configurations
# identify proper host ip addresses, e.g. 127.0.0.
db.cluster.subnet=
1.9 UI settings

API access configuration.

Code Block
#-------------------------------------------------------------------------------
# 1.109] ElasticsearchUI Propertiessettings
#-------------------------------------------------------------------------------
# ClusterThe passphrase namefor the #SSL Anykeystore unique(not nameneeded withinunless theHTTPS EC2 cluster/subnet: 
elastic.cluster=
#----------------------------------------------
# ES nodes, e.g.: elastic.search.nodes='NODE1:9300','NODE2:9300','NODE3:9300':
# Needed if discovery.mode=zen (not EC2/AWS), a set of IPs to try (>= 1 must be running elasticsearch)
elastic.search.nodes=
# If any node sees less than this number of connections it will take itself down
# For a single node, should be 0 (default), for a 2-node system, should be 1, for large clusters
# ideally would be CLUSTER_SIZE - #REPLICAS (and >=2), but 2 is workable if the size is not fixed
# (if this is set too low then split brain situations may not be detected)
elastic.search.min_peers=0
1.11 Harvester properties
1.12 Hadoop properties
Code Block
is being used)
ssl.passphrase=
# This is a regex that, if specified, will allow only access to REST commands matching
# the pattern - only applied to remote clients. Connections from localhost always have access 
# to everything
# Eg the commented out example will allow only login/keepalive and querying.
#remote.access.allow=^/api/(knowledge/document/query|auth/login|auth/keepalive)
remote.access.allow=
# This parameter does the opposite, allows everything except specified commands
remote.access.deny=
1.10 Elasticsearch Properties

The elastic.cluster property is required by all installations. The elastic.search.nodes property is only used in non-EC2/AWS installations.

Code Block
#-------------------------------------------------------------------------------
# 1.10] Elasticsearch Properties
#-------------------------------------------------------------------------------
# Cluster name 
# Any unique name within the EC2 cluster/subnet: 
elastic.cluster=
#-------------------------------------------------------------------------------
# 1.12] Hadoop properties
#-------------------------------------------------------------------------------
# This limits the number of jobs that can be concurrently submitted to the Hadoop cluster
# by the custom processing engine (other jobs remain at pending until a slot is available)
# There is no default, 10 is recommended as a sensible value until the size of your cluster is known.
hadoop.max_concurrent=10
1.13 Entity Extractor Properties

The following properties are required to configure the use of AlchemyAPI, Open Calais, or boilerpipe.

Code Block
#---
# ES nodes, e.g.: elastic.search.nodes='NODE1:9300','NODE2:9300','NODE3:9300':
# Needed if discovery.mode=zen (not EC2/AWS), a set of IPs to try (>= 1 must be running elasticsearch)
elastic.search.nodes=
# If any node sees less than this number of connections it will take itself down
# For a single node, should be 0 (default), for a 2-node system, should be 1, for large clusters
# ideally would be CLUSTER_SIZE - #REPLICAS (and >=2), but 2 is workable if the size is not fixed
# (if this is set too low then split brain situations may not be detected)
elastic.search.min_peers=0
1.11 Harvester properties
1.12 Hadoop properties
Code Block
#-------------------------------------------------------------------------------
# 1.1312] EntityHadoop Extractor Propertiesproperties
#-------------------------------------------------------------------------------
# AlchemyThis andlimits Openthe Calaisnumber Keys:of #jobs (Obtainthat fromcan alchemyapi.combe or opencalais.com)
extractor.key.alchemyapi=
extractor.key.opencalais=
#----------------------------------------------
# Entity extraction type selection: opencalais or alchemyapi or none
# ("opencalais" has a much higher limit than "alchemyapi" (1000/day) so is recommended for free use
#  "alchemyapi" extracts sentiment, "opencalais" extracts entity associations Note this can be overridden per source)
extractor.entity.default=
# Text extraction type selection: boilerplate or alchemyapi or none
# ("alchemyapi" is much better, but has the limit discussed above. Note this can be overridden per source)
extractor.text.default=
1.14 Interface Related Properties

The ui.end.point.url property is used to tell the UI where to connect to the Infinit.e API.

info
concurrently submitted to the Hadoop cluster
# by the custom processing engine (other jobs remain at pending until a slot is available)
# There is no default, 10 is recommended as a sensible value until the size of your cluster is known.
hadoop.max_concurrent=10
1.13 Entity Extractor Properties

The following properties are required to configure the use of AlchemyAPI, Open Calais, or boilerpipe.

code
Code Block
#-------------------------------------------------------------------------------


# 1.
14
13] 
Interface
Entity 
Related
Extractor Properties
for the AppConstants.js

file found in:
#
      /mnt/opt/infinite
-
tomcat/interface
-
engine/webapps/ROOT/
#
-----------------------------------------------------------------------------
--

# 
The
Alchemy 
REST
and 
end
Open 
point
Calais 
of the server
Keys:
# (
or
Obtain 
a DNS/AWS load balancer across multiple rest end points):
# (Will normally end "/api/") 
ui.end.point.url=http://MY_REST_ENDPOINT/api/

2. Properties that can normally be left at their default

2.2 Software as a Service Properties

Properties that are only modified if Infinit.e is deployed in SAAS mode (which is uncommon).

from alchemyapi.com or opencalais.com)
extractor.key.alchemyapi=
extractor.key.opencalais=
#----------------------------------------------
# Entity extraction type selection: opencalais or alchemyapi or none
# ("opencalais" has a much higher limit than "alchemyapi" (1000/day) so is recommended for free use
#  "alchemyapi" extracts sentiment, "opencalais" extracts entity associations Note this can be overridden per source)
extractor.entity.default=
# Text extraction type selection: boilerplate or alchemyapi or none
# ("alchemyapi" is much better, but has the limit discussed above. Note this can be overridden per source)
extractor.text.default=
1.14 Interface Related Properties

The ui.end.point.url property is used to tell the UI where to connect to the Infinit.e API.

Info
#-------------------------------------------------------------------------------

#
2
1.
2
14] Interface Related 
Software
Properties 
as
for 
a
the 
service (SAAS) settings #----
AppConstants.js file found in:
#       /mnt/opt/infinite-tomcat/interface-engine/webapps/ROOT/
#-------------------------------------------------------------------------------

#
If
The 
true,
REST 
allows
end 
admin
point 
requests
of 
that
the 
come
server 
from
(or 
trusted
a 
sources
DNS/AWS 
to
load 
have
balancer 
admin
across 
privileges:
multiple rest 
app.saas=false
end points):
#
A
(Will 
list
normally 
of trusted DNS/IP addresses (eg from CMS): app.saas.trusted.dns=
2.3 Amazon Services Properties

...

end "/api/") 
ui.end.point.url=http://MY_REST_ENDPOINT/api/
1.15 Maps API key

2. Properties that can normally be left at their default

2.1 Basic Infinit.e Settings
2.2 Software as a Service Properties

Properties that are only modified if Infinit.e is deployed in SAAS mode (which is uncommon).

Code Block
#-------------------------------------------------------------------------------
# 2.32] Software Amazonas servicesa properties
#service (SAAS) settings
#-------------------------------------------------------------------------------
# Values: 0=false, 1=true
# If deployed on an EC2 cluster set this to 1:
use.aws=0
2.6 API Search Test

...

 If true, allows admin requests that come from trusted sources to have admin privileges: 
app.saas=false
# A list of trusted DNS/IP addresses (eg from CMS):
app.saas.trusted.dns=
2.3 Amazon Services Properties
2.4 EMail Server Settings
2.5 Email Addresses  for Log Files
2.6 API Search Test

Default search test terms and expected results values used to monitor the Infinit.e service.

...

2.11 Harvester Properties
Code Block
#-------------------------------------------------------------------------------

...


# 2.11] Harvester Properties

...


#-------------------------------------------------------------------------------

...


# Comma-separated-list from File,Database,

...

Feed (note Database and Feed need jars not bundled with the RPM)
harvester.types=File,Database,Feed
# Web crawling etiquette: the time to way between consecutive accesses to the same time (10s is standard)
harvest.feed.wait=10000
# The minimum time between consecutive harvests (avoids thrashing FS/DB/RSS when there's nothing to get)
harvest.mintime.ms=300000
# The minimum time between consecutive source harvests (set if needs to be longer than harvest.mintime.ms,
# eg if you want to pick up a source quickly the first time but then not update so frequently)
harvest.source.mintime.ms=
# Restricts the number of docs that can be harvested per cycle for memory reasons:
harvest.maxdocs_persource=5000
# Threading configuration type:num_threads (type from above):
# (eg for RSS heavy increase the "feed", for DB heavy increase the "file" etc. Beyond 20 there is limited benefit). 
harvest.threads=file:5,database:5,feed:20
# This controls the batch size of sources picked up by a thread, this does not normally need to be changed (its default is shown)
# (It can be reduced in cases where a small number of very long-running sources need to be harvested).
#harvest.distribution.batch.harvest=20
# This disables entity and association aggregation. For almost all applications you will not want to set this.
#harvest.disable_aggregation=false
2.12 Hadoop Properties

The Hadoop config path is a local folder where Infinit.e stores map reduce jobs if Hadoop is used.

...

2.13 Entity Extractor Properties
Code Block
 

 

...

 #-------------------------------------------------------------------------------

...


# 2.13] Entity Extractor Properties

...


#-------------------------------------------------------------------------------

...


# Alchemy extraction level

...


# 1==people postproc, 2==geo postproc, 3==both

...


# (This uses some hard-coded heuristics to work around known AlchemyAPI errors)

...


app.alchemy.postproc=3
2.14 UI Related Properties
Code Block
#-------------------------------------------------------------------------------

...


# 2.14] Interface Related Properties for the AppConstants.js file found in:

...


#    

...

 

...

 

...

 /mnt/opt/infinite-tomcat/interface-engine/webapps/ROOT/

...


#-------------------------------------------------------------------------------

...


# For SaaS applications, the URL of the web page (eg containing CMS links for forgot password/logout etc):

...


# (Can be left blank otherwise)

...


ui.domain.url=

...


# Forgot password URL: (SaaS only, ie integrated with a CMS)

...


# (relative to ui.domain.url):

...


ui.forgot.password=forgot-password/

...


# Logout URL: (SaaS only, ie integrated with a CMS)

...


# (relative to ui.domain.url):

...


ui.logout=?action=logout
2.15 Map API Key

Obsolete: Google has ceased support for this API and is not generating any new keys. However the MapQuest map widget requires the key be set to a non-zero string (the commercial version which is not used in this tool but could be requires a key).

Code Block
#-------------------------------------------------------------------------------

...


# 2.15] Maps API key:

...


#-------------------------------------------------------------------------------

...


# Can be any non-zero string for MapQuest open API

...


google.maps.api.key=NULL_KEY

...