source: trunk/config/dist/base.config @ 7548

# $Id: base.config 7548 2018-12-10 11:53:32Z nicklas $
#
# Copyright (C) 2006 Nicklas Nordborg
# Copyright (C) 2007 Nicklas Nordborg, Martin Svensson
#
# This file is part of BASE - BioArray Software Environment.
# Available at http://base.thep.lu.se/
#
# BASE is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# BASE is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with BASE. If not, see <http://www.gnu.org/licenses/>.
# ----------------------------------------

# =======================
# Database driver section
# =======================

# -----
# MySQL
# -----
db.dialect          = org.hibernate.dialect.MySQL5InnoDBDialect
db.url              = jdbc:mysql://localhost/base2?characterEncoding=UTF-8&useCursorFetch=true&defaultFetchSize=100&useServerPrepStmts=true
db.dynamic.catalog  = base2dynamic
db.queries          = /mysql-queries.xml
#export.max.items    = 20000

# --------
# Postgres
# --------
#db.dialect          = org.hibernate.dialect.PostgreSQL9Dialect
#db.url              = jdbc:postgresql:base2
#db.dynamic.schema   = dynamic
#db.queries          = /postgres-queries.xml

# -------------
# Common to all
# -------------
db.username            = base2user
db.password            = password
db.extended-properties = /extended-properties.xml
db.raw-data-types      = /raw-data-types.xml
db.batch-size          = 50
# Number of hours between cleanup of unused items in the database
# Set to 0 to disable (recommended for job agents)
db.cleanup.interval    = 24


# ======================
# Authentication section
# ======================

# If extra information such as address, email, phone, etc. should
# be synchronized or not from external authentication managers 
#auth.synchronize    = 0

# If passwords should be cached locally or not to allow
# fallback to internal authentication when external authentication
# system is not responding
#auth.cachepasswords = 0

# Number of days to cache passwords locally
#auth.daystocache    = 0


# ==========================
# Internal job queue section
# ==========================
# If the internal job queue should be enabled or not
jobqueue.internal.enabled            = true

# Signal receiver class for sending signals to running jobs (to abort them)
jobqueue.internal.signalreceiver.class = net.sf.basedb.core.signal.LocalSignalReceiver
jobqueue.internal.signalreceiver.init  = jobqueue:0

# If plugins with useInteralJobQueue = false should be executed or not
jobqueue.internal.runallplugins      = false

# The maximum thread priority for any thread executing a plug-in
#jobqueue.internal.maxthreadpriority  = 4

# Number of seconds between checks to the job queue
jobqueue.internal.checkinterval      = 30

# NOTE! A quick job may use threads from any of the "slower" pools
# if there is place for another thread
# Number of threads to reserved for jobs that takes < 1 minute to execute
jobqueue.internal.shortest.threads   = 1
#jobqueue.internal.shortest.threadpriority = 4

# Number of threads to reserved for jobs that takes < 10 minutes to execute
jobqueue.internal.short.threads      = 1
#jobqueue.internal.short.threadpriority = 4

# Number of threads to reserved for jobs that takes < 1 hour to execute
jobqueue.internal.medium.threads     = 2
#jobqueue.internal.medium.threadpriority = 3

# Number of threads to reserved for jobs that takes > 1 hour to execute
jobqueue.internal.long.threads       = 4
#jobqueue.internal.long.threadpriority = 3

# ==========================
# External job agent section
# ==========================

# Number of seconds to cache information from a job agent before it
# is reloaded. The default value is 60 seconds.
agent.maxage=60

# The timeout in milliseconds to use when connecting to job agents to
# get information. The default value is 1000 milliseconds.
agent.connection.timeout=1000


# =========================
# Secondary storage section
# =========================
#
# DEPRECTAED SINC BASE 3.14. IT WILL BE REMOVED IN A NEAR FUTURE.
#
# The classname of the driver; leave empty to disable secondary storage
# secondary.storage.driver   = net.sf.basedb.core.InternalStorageController

# Initialisation options to the seconday storage controller
# The internal implementation wants a path to the secondary directory
# secondary.storage.init     = /usr/local/base2/secondary

# The interval (in seconds) between checks for new files to move
# secondary.storage.interval = 3600

# Comma-separated list of time values (hours:minutes) when the controller 
# should be executed; overrides the interval setting if present
# secondary.storage.time = 18:15,07:30

# =========================
# Change history section
# =========================

# Change history for items can be logged with the help of extensions.
# BASE ships with a built-in extension that log changes to the database.
# This is disabled by default, but can be enabled through the web 
# interface: Adminstrate -> Plug-ins & extensions -> Overview

# If the "Change history" tab should be visible in the web interface 
# or not. It is hidden by default.
# changelog.show-in-web = true

# If DB logger should log detailed information about which properties
# that has been updated (default: false)
# changelog.dblogger.detailed-properties = true

# If the DB logger should log the old property values when they
# are modified (default: false; ingored unless 'detailed-properties'
# is enabled).
# changelog.dblogger.old-property-values = true


# ==========================
# SMTP server section
# ==========================

# SMTP server for outgoing mail. If not specified, 
# mail sending and 2-factor login will be disabled
# mail.server.host

# The port number the SMTP server is listening on. If not
# specified the default port is used (25 or 465 if ssl is enabled)
# mail.server.port = 25

# A flag to enable SSL encryption
# mail.server.ssl = 0

# A flag to enable TLS encryption
# mail.server.tls = 0

# Email to use in the "From" address. If not specified,
# mail sending will be disabled
# mail.from.email = noreply@mail.yourdomain

# Name to use in the "From" address. If not specified,
# a default value is created automatically using the
# host name of the BASE server.
# mail.from.name


# =======================
# Plug-ins and extensions
# =======================

# The path to the directory where external plugins are installed
plugins.dir=/usr/local/base2/plugins

# Set this flag to disable all external extensions
extensions.disabled = false


# ===============
# General section
# ===============

# Title that is displayed in the browser tab. Use $VERSION to include
# the current BASE version and $SERVER to include the server name.
app.title = BASE $VERSION @ $SERVER

# The path to the directory where uploaded files are stored
userfiles = /usr/local/base2/files

# Number of minutes to keep permission information for the logged
# in user in memory before it is reloaded from the database.
permission.timeout = 10

# Number of minutes to keep SessionControl object in the cache
# after the last use
cache.timeout = 20

# If the static cache should be disabled or enabled
# Disabling the static cache may reduce performance for
# certain operations
cache.static.disabled = false

# Timeout (in days) for items in the static cache
# Items that hasn't been accessed in the configured amount of
# of time will be removed from the cache
cache.static.max-age = 30

#Overwrite the existing help texts when updating the program
helptext.update = true

# Set to 1 to disable auto-compression of uploaded files
autocompress.disable = 0

# Locale settings are used to customize gui text and labels
# locale.language = 
# locale.country = 
# locacle.variant =

# The default character set that will be used to parse text files that
# hasn't specified a character set. The default value for this setting
# is ISO-8859-1.
#
# defaultCharset = ISO-8859-1

# A comma-separated list of the most commonly used character sets for text
# files. This list is used to order selection lists so that the common values
# are listed at the top of the list.
#
# commonCharsets = UTF-8,US-ASCII,ISO-8859-1

# A regular expression that used to filter character sets that are not used 
# in order to keep the selection list shorter. If no value is specified all
# character sets are included. The standard setting will filter out all 
# character sets starting with 'x-' or 'IBM'. Character sets that are specified
# in the commonCharsets setting are never filtered.
#
ignoreCharsets = ((x|X)\-|IBM).*

# ===================
# Geolocation section
# ===================

# URL to the 'ipstack' (previously 'freegeoip') server. Use {IP} as a
# placeholder for the IP address. The service should return a JSON 
# data object. Before it can be used you need to register and receive
# an API key. See https://ipstack.com/ for more information.
# Replace [API_KEY] in the URL below and uncomment the setting to 
# activate geolocation lookup.
# geolocation.freegeoip = http://api.ipstack.com/{IP}?access_key=[API_KEY]&output=json

# A template URL for displaying a map with a marker on a specified location
# Use {LAT} and {LONG} as placeholders for the latitude and longitude
# If no template is specified map links will not be created. The default
# configuration use OpenStreetMap, or you can switch to Google Maps or 
# some other map provide that supports a latitude/longitude location.
geolocation.maptemplate = https://www.openstreetmap.org/?mlat={LAT}&mlon={LONG}#map=11/{LAT}/{LONG}
# geolocation.maptemplate = https://www.google.com/maps/search/?api=1&query={LAT},{LONG}

# ===============
# SSL section
# ===============
# Configuration settings for supporting file access via https.
# Changes are only needed if authentication is needed or if, for example,
# files are stored on servers with self-signed certificates.

# ssl.context.protocol = TLS
# ssl.context.provider =
# ssl.keystore.file = 
# ssl.keystore.password = 
# ssl.keystore.type = JKS
# ssl.keystore.algorithm = SunX509
# ssl.keystore.provider = 
# ssl.truststore.file = <java-home>/jre/lib/security/cacerts
# ssl.truststore.password = changeit
# ssl.truststore.type = JKS
# ssl.truststore.algorithm = PKIX
# ssl.truststore.provider = 

# ===================
# Migration section
# ===================
# Configuration settings that are related to migrating a BASE
# installation on a MySQL database to a PostgreSQL database.
# See documentation for more information.

# Enable this flag to compress the exported data. This may increase
# performance if disks are slow.
# migrate.export.compress = 0 

# The number of rows that should be fetched at the same time from
# the database. Increasing this value may give better performance
# but requires more memory.
# migrate.export.fetch-size = 20000

# Enable this flag to issue an SQL statment for statistical
# analysis of the imported data before continuing with the next table.
# Disabling this may result in very poor performance.
# migrate.import.analyze = 1

# Enable this flag to drop the primary key of a table before importing
# data to it. This may increase the performance. The primary key is
# re-created after the data has been imported.
# migrate.import.drop-primary-key = 1

# Enable this flag to drop unique constraints and indexes before importing
# data. This may increase the performance. The constraints and indexes
# are re-created after the data has been imported. NOTE! Foreign key
# constraints are not affected by this flag, since they must always be dropped.
# migrate.import.drop-constraints = 1