config/dist/base.config

Code
Comments
Other
Rev Date Author Line
5416 21 Sep 10 jari 1 #  $Id$
2959 27 Nov 06 nicklas 2 #
3675 16 Aug 07 jari 3 #  Copyright (C) 2006 Nicklas Nordborg
3675 16 Aug 07 jari 4 #  Copyright (C) 2007 Nicklas Nordborg, Martin Svensson
2959 27 Nov 06 nicklas 5 #
2959 27 Nov 06 nicklas 6 #  This file is part of BASE - BioArray Software Environment.
2959 27 Nov 06 nicklas 7 #  Available at http://base.thep.lu.se/
2959 27 Nov 06 nicklas 8 #
2959 27 Nov 06 nicklas 9 #  BASE is free software; you can redistribute it and/or
2959 27 Nov 06 nicklas 10 #  modify it under the terms of the GNU General Public License
4474 05 Sep 08 jari 11 #  as published by the Free Software Foundation; either version 3
2959 27 Nov 06 nicklas 12 #  of the License, or (at your option) any later version.
2959 27 Nov 06 nicklas 13 #
2959 27 Nov 06 nicklas 14 #  BASE is distributed in the hope that it will be useful,
2959 27 Nov 06 nicklas 15 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
2959 27 Nov 06 nicklas 16 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2959 27 Nov 06 nicklas 17 #  GNU General Public License for more details.
2959 27 Nov 06 nicklas 18 #
2959 27 Nov 06 nicklas 19 #  You should have received a copy of the GNU General Public License
4508 11 Sep 08 jari 20 #  along with BASE. If not, see <http://www.gnu.org/licenses/>.
2959 27 Nov 06 nicklas 21 # ----------------------------------------
2959 27 Nov 06 nicklas 22
2959 27 Nov 06 nicklas 23 # =======================
2959 27 Nov 06 nicklas 24 # Database driver section
2959 27 Nov 06 nicklas 25 # =======================
2959 27 Nov 06 nicklas 26
7614 01 Mar 19 nicklas 27 # ----------------------
7614 01 Mar 19 nicklas 28 # Postgres (recommended)
7614 01 Mar 19 nicklas 29 # ----------------------
7614 01 Mar 19 nicklas 30 db.dialect          = org.hibernate.dialect.PostgreSQL9Dialect
7614 01 Mar 19 nicklas 31 db.url              = jdbc:postgresql:base2
7614 01 Mar 19 nicklas 32 db.dynamic.schema   = dynamic
7614 01 Mar 19 nicklas 33 db.queries          = /postgres-queries.xml
7614 01 Mar 19 nicklas 34
7997 09 Aug 21 nicklas 35 # -------------------------------------
7997 09 Aug 21 nicklas 36 # MySQL (not supported since BASE 3.19)
7997 09 Aug 21 nicklas 37 # -------------------------------------
7822 08 Jun 20 nicklas 38 # db.dialect          = org.hibernate.dialect.MySQL8Dialect
7822 08 Jun 20 nicklas 39 # db.url              = jdbc:mysql://localhost/base2?characterEncoding=UTF-8&useCursorFetch=true&defaultFetchSize=100&useServerPrepStmts=true&sslMode=DISABLED
7614 01 Mar 19 nicklas 40 # db.dynamic.catalog  = base2dynamic
7614 01 Mar 19 nicklas 41 # db.queries          = /mysql-queries.xml
2959 27 Nov 06 nicklas 42
2959 27 Nov 06 nicklas 43
2959 27 Nov 06 nicklas 44 # -------------
2959 27 Nov 06 nicklas 45 # Common to all
2959 27 Nov 06 nicklas 46 # -------------
2959 27 Nov 06 nicklas 47 db.username            = base2user
2959 27 Nov 06 nicklas 48 db.password            = password
2959 27 Nov 06 nicklas 49 db.extended-properties = /extended-properties.xml
2959 27 Nov 06 nicklas 50 db.raw-data-types      = /raw-data-types.xml
2959 27 Nov 06 nicklas 51 db.batch-size          = 50
5023 27 Jul 09 nicklas 52 # Number of hours between cleanup of unused items in the database
5023 27 Jul 09 nicklas 53 # Set to 0 to disable (recommended for job agents)
5023 27 Jul 09 nicklas 54 db.cleanup.interval    = 24
2959 27 Nov 06 nicklas 55
2959 27 Nov 06 nicklas 56
2959 27 Nov 06 nicklas 57 # ======================
2959 27 Nov 06 nicklas 58 # Authentication section
2959 27 Nov 06 nicklas 59 # ======================
2959 27 Nov 06 nicklas 60
6424 25 Feb 14 nicklas 61 # If extra information such as address, email, phone, etc. should
6424 25 Feb 14 nicklas 62 # be synchronized or not from external authentication managers 
2959 27 Nov 06 nicklas 63 #auth.synchronize    = 0
6424 25 Feb 14 nicklas 64
6424 25 Feb 14 nicklas 65 # If passwords should be cached locally or not to allow
6424 25 Feb 14 nicklas 66 # fallback to internal authentication when external authentication
6424 25 Feb 14 nicklas 67 # system is not responding
2959 27 Nov 06 nicklas 68 #auth.cachepasswords = 0
6424 25 Feb 14 nicklas 69
6424 25 Feb 14 nicklas 70 # Number of days to cache passwords locally
2959 27 Nov 06 nicklas 71 #auth.daystocache    = 0
2959 27 Nov 06 nicklas 72
2959 27 Nov 06 nicklas 73
2959 27 Nov 06 nicklas 74 # ==========================
2959 27 Nov 06 nicklas 75 # Internal job queue section
2959 27 Nov 06 nicklas 76 # ==========================
2959 27 Nov 06 nicklas 77 # If the internal job queue should be enabled or not
2959 27 Nov 06 nicklas 78 jobqueue.internal.enabled            = true
3871 22 Oct 07 nicklas 79
4093 18 Jan 08 enell 80 # Signal receiver class for sending signals to running jobs (to abort them)
4093 18 Jan 08 enell 81 jobqueue.internal.signalreceiver.class = net.sf.basedb.core.signal.LocalSignalReceiver
4093 18 Jan 08 enell 82 jobqueue.internal.signalreceiver.init  = jobqueue:0
4093 18 Jan 08 enell 83
3871 22 Oct 07 nicklas 84 # If plugins with useInteralJobQueue = false should be executed or not
3871 22 Oct 07 nicklas 85 jobqueue.internal.runallplugins      = false
3871 22 Oct 07 nicklas 86
3871 22 Oct 07 nicklas 87 # The maximum thread priority for any thread executing a plug-in
2959 27 Nov 06 nicklas 88 #jobqueue.internal.maxthreadpriority  = 4
2959 27 Nov 06 nicklas 89
2959 27 Nov 06 nicklas 90 # Number of seconds between checks to the job queue
2959 27 Nov 06 nicklas 91 jobqueue.internal.checkinterval      = 30
2959 27 Nov 06 nicklas 92
2959 27 Nov 06 nicklas 93 # NOTE! A quick job may use threads from any of the "slower" pools
2959 27 Nov 06 nicklas 94 # if there is place for another thread
2959 27 Nov 06 nicklas 95 # Number of threads to reserved for jobs that takes < 1 minute to execute
2959 27 Nov 06 nicklas 96 jobqueue.internal.shortest.threads   = 1
2959 27 Nov 06 nicklas 97 #jobqueue.internal.shortest.threadpriority = 4
2959 27 Nov 06 nicklas 98
2959 27 Nov 06 nicklas 99 # Number of threads to reserved for jobs that takes < 10 minutes to execute
2959 27 Nov 06 nicklas 100 jobqueue.internal.short.threads      = 1
2959 27 Nov 06 nicklas 101 #jobqueue.internal.short.threadpriority = 4
2959 27 Nov 06 nicklas 102
2959 27 Nov 06 nicklas 103 # Number of threads to reserved for jobs that takes < 1 hour to execute
2959 27 Nov 06 nicklas 104 jobqueue.internal.medium.threads     = 2
2959 27 Nov 06 nicklas 105 #jobqueue.internal.medium.threadpriority = 3
2959 27 Nov 06 nicklas 106
2959 27 Nov 06 nicklas 107 # Number of threads to reserved for jobs that takes > 1 hour to execute
2959 27 Nov 06 nicklas 108 jobqueue.internal.long.threads       = 4
3338 15 May 07 nicklas 109 #jobqueue.internal.long.threadpriority = 3
2959 27 Nov 06 nicklas 110
2959 27 Nov 06 nicklas 111 # ==========================
2959 27 Nov 06 nicklas 112 # External job agent section
2959 27 Nov 06 nicklas 113 # ==========================
2959 27 Nov 06 nicklas 114
2959 27 Nov 06 nicklas 115 # Number of seconds to cache information from a job agent before it
2959 27 Nov 06 nicklas 116 # is reloaded. The default value is 60 seconds.
2959 27 Nov 06 nicklas 117 agent.maxage=60
2959 27 Nov 06 nicklas 118
2959 27 Nov 06 nicklas 119 # The timeout in milliseconds to use when connecting to job agents to
2959 27 Nov 06 nicklas 120 # get information. The default value is 1000 milliseconds.
2959 27 Nov 06 nicklas 121 agent.connection.timeout=1000
2959 27 Nov 06 nicklas 122
2959 27 Nov 06 nicklas 123
2959 27 Nov 06 nicklas 124 # =========================
5038 07 Aug 09 nicklas 125 # Change history section
5038 07 Aug 09 nicklas 126 # =========================
5038 07 Aug 09 nicklas 127
6081 08 Aug 12 nicklas 128 # Change history for items can be logged with the help of extensions.
6081 08 Aug 12 nicklas 129 # BASE ships with a built-in extension that log changes to the database.
6081 08 Aug 12 nicklas 130 # This is disabled by default, but can be enabled through the web 
6081 08 Aug 12 nicklas 131 # interface: Adminstrate -> Plug-ins & extensions -> Overview
5038 07 Aug 09 nicklas 132
5048 17 Aug 09 nicklas 133 # If the "Change history" tab should be visible in the web interface 
5048 17 Aug 09 nicklas 134 # or not. It is hidden by default.
5052 18 Aug 09 nicklas 135 # changelog.show-in-web = true
5048 17 Aug 09 nicklas 136
5052 18 Aug 09 nicklas 137 # If DB logger should log detailed information about which properties
5052 18 Aug 09 nicklas 138 # that has been updated (default: false)
5052 18 Aug 09 nicklas 139 # changelog.dblogger.detailed-properties = true
5052 18 Aug 09 nicklas 140
6351 25 Nov 13 nicklas 141 # If the DB logger should log the old property values when they
6351 25 Nov 13 nicklas 142 # are modified (default: false; ingored unless 'detailed-properties'
6351 25 Nov 13 nicklas 143 # is enabled).
6351 25 Nov 13 nicklas 144 # changelog.dblogger.old-property-values = true
6351 25 Nov 13 nicklas 145
6351 25 Nov 13 nicklas 146
5442 07 Oct 10 nicklas 147 # ==========================
5442 07 Oct 10 nicklas 148 # SMTP server section
5442 07 Oct 10 nicklas 149 # ==========================
5442 07 Oct 10 nicklas 150
5442 07 Oct 10 nicklas 151 # SMTP server for outgoing mail. If not specified, 
7412 11 Oct 17 nicklas 152 # mail sending and 2-factor login will be disabled
5442 07 Oct 10 nicklas 153 # mail.server.host
5442 07 Oct 10 nicklas 154
5442 07 Oct 10 nicklas 155 # The port number the SMTP server is listening on. If not
5442 07 Oct 10 nicklas 156 # specified the default port is used (25 or 465 if ssl is enabled)
5442 07 Oct 10 nicklas 157 # mail.server.port = 25
5442 07 Oct 10 nicklas 158
5442 07 Oct 10 nicklas 159 # A flag to enable SSL encryption
5442 07 Oct 10 nicklas 160 # mail.server.ssl = 0
5442 07 Oct 10 nicklas 161
5442 07 Oct 10 nicklas 162 # A flag to enable TLS encryption
5442 07 Oct 10 nicklas 163 # mail.server.tls = 0
5442 07 Oct 10 nicklas 164
5442 07 Oct 10 nicklas 165 # Email to use in the "From" address. If not specified,
5442 07 Oct 10 nicklas 166 # mail sending will be disabled
5442 07 Oct 10 nicklas 167 # mail.from.email = noreply@mail.yourdomain
5442 07 Oct 10 nicklas 168
5442 07 Oct 10 nicklas 169 # Name to use in the "From" address. If not specified,
5442 07 Oct 10 nicklas 170 # a default value is created automatically using the
5442 07 Oct 10 nicklas 171 # host name of the BASE server.
5442 07 Oct 10 nicklas 172 # mail.from.name
5442 07 Oct 10 nicklas 173
5442 07 Oct 10 nicklas 174
5608 15 Apr 11 nicklas 175 # =======================
5608 15 Apr 11 nicklas 176 # Plug-ins and extensions
5608 15 Apr 11 nicklas 177 # =======================
5608 15 Apr 11 nicklas 178
5608 15 Apr 11 nicklas 179 # The path to the directory where external plugins are installed
5608 15 Apr 11 nicklas 180 plugins.dir=/usr/local/base2/plugins
5608 15 Apr 11 nicklas 181
5608 15 Apr 11 nicklas 182 # Set this flag to disable all external extensions
5608 15 Apr 11 nicklas 183 extensions.disabled = false
5608 15 Apr 11 nicklas 184
5608 15 Apr 11 nicklas 185
2959 27 Nov 06 nicklas 186 # ===============
2959 27 Nov 06 nicklas 187 # General section
2959 27 Nov 06 nicklas 188 # ===============
2959 27 Nov 06 nicklas 189
7395 12 Jun 17 nicklas 190 # Title that is displayed in the browser tab. Use $VERSION to include
7395 12 Jun 17 nicklas 191 # the current BASE version and $SERVER to include the server name.
7395 12 Jun 17 nicklas 192 app.title = BASE $VERSION @ $SERVER
7395 12 Jun 17 nicklas 193
2959 27 Nov 06 nicklas 194 # The path to the directory where uploaded files are stored
2959 27 Nov 06 nicklas 195 userfiles = /usr/local/base2/files
2959 27 Nov 06 nicklas 196
2959 27 Nov 06 nicklas 197 # Number of minutes to keep permission information for the logged
2959 27 Nov 06 nicklas 198 # in user in memory before it is reloaded from the database.
2959 27 Nov 06 nicklas 199 permission.timeout = 10
2959 27 Nov 06 nicklas 200
2959 27 Nov 06 nicklas 201 # Number of minutes to keep SessionControl object in the cache
2959 27 Nov 06 nicklas 202 # after the last use
2959 27 Nov 06 nicklas 203 cache.timeout = 20
2959 27 Nov 06 nicklas 204
4827 23 Mar 09 nicklas 205 # If the static cache should be disabled or enabled
4827 23 Mar 09 nicklas 206 # Disabling the static cache may reduce performance for
4827 23 Mar 09 nicklas 207 # certain operations
4827 23 Mar 09 nicklas 208 cache.static.disabled = false
4827 23 Mar 09 nicklas 209
4827 23 Mar 09 nicklas 210 # Timeout (in days) for items in the static cache
4827 23 Mar 09 nicklas 211 # Items that hasn't been accessed in the configured amount of
4827 23 Mar 09 nicklas 212 # of time will be removed from the cache
4827 23 Mar 09 nicklas 213 cache.static.max-age = 30
4827 23 Mar 09 nicklas 214
3260 23 Apr 07 martin 215 #Overwrite the existing help texts when updating the program
3260 23 Apr 07 martin 216 helptext.update = true
3260 23 Apr 07 martin 217
3719 12 Sep 07 nicklas 218 # Set to 1 to disable auto-compression of uploaded files
3719 12 Sep 07 nicklas 219 autocompress.disable = 0
3719 12 Sep 07 nicklas 220
5409 16 Sep 10 nicklas 221 # Locale settings are used to customize gui text and labels
5409 16 Sep 10 nicklas 222 # locale.language = 
5409 16 Sep 10 nicklas 223 # locale.country = 
5409 16 Sep 10 nicklas 224 # locacle.variant =
5409 16 Sep 10 nicklas 225
5570 16 Feb 11 nicklas 226 # The default character set that will be used to parse text files that
5570 16 Feb 11 nicklas 227 # hasn't specified a character set. The default value for this setting
5570 16 Feb 11 nicklas 228 # is ISO-8859-1.
5570 16 Feb 11 nicklas 229 #
5570 16 Feb 11 nicklas 230 # defaultCharset = ISO-8859-1
5570 16 Feb 11 nicklas 231
5570 16 Feb 11 nicklas 232 # A comma-separated list of the most commonly used character sets for text
5570 16 Feb 11 nicklas 233 # files. This list is used to order selection lists so that the common values
5570 16 Feb 11 nicklas 234 # are listed at the top of the list.
5570 16 Feb 11 nicklas 235 #
5570 16 Feb 11 nicklas 236 # commonCharsets = UTF-8,US-ASCII,ISO-8859-1
5570 16 Feb 11 nicklas 237
5570 16 Feb 11 nicklas 238 # A regular expression that used to filter character sets that are not used 
5570 16 Feb 11 nicklas 239 # in order to keep the selection list shorter. If no value is specified all
5570 16 Feb 11 nicklas 240 # character sets are included. The standard setting will filter out all 
5570 16 Feb 11 nicklas 241 # character sets starting with 'x-' or 'IBM'. Character sets that are specified
5570 16 Feb 11 nicklas 242 # in the commonCharsets setting are never filtered.
5570 16 Feb 11 nicklas 243 #
5570 16 Feb 11 nicklas 244 ignoreCharsets = ((x|X)\-|IBM).*
5570 16 Feb 11 nicklas 245
7414 12 Oct 17 nicklas 246 # ===================
7414 12 Oct 17 nicklas 247 # Geolocation section
7414 12 Oct 17 nicklas 248 # ===================
5570 16 Feb 11 nicklas 249
7494 04 Jun 18 nicklas 250 # URL to the 'ipstack' (previously 'freegeoip') server. Use {IP} as a
7494 04 Jun 18 nicklas 251 # placeholder for the IP address. The service should return a JSON 
7494 04 Jun 18 nicklas 252 # data object. Before it can be used you need to register and receive
7494 04 Jun 18 nicklas 253 # an API key. See https://ipstack.com/ for more information.
7494 04 Jun 18 nicklas 254 # Replace [API_KEY] in the URL below and uncomment the setting to 
7494 04 Jun 18 nicklas 255 # activate geolocation lookup.
7494 04 Jun 18 nicklas 256 # geolocation.freegeoip = http://api.ipstack.com/{IP}?access_key=[API_KEY]&output=json
7414 12 Oct 17 nicklas 257
7414 12 Oct 17 nicklas 258 # A template URL for displaying a map with a marker on a specified location
7414 12 Oct 17 nicklas 259 # Use {LAT} and {LONG} as placeholders for the latitude and longitude
7414 12 Oct 17 nicklas 260 # If no template is specified map links will not be created. The default
7414 12 Oct 17 nicklas 261 # configuration use OpenStreetMap, or you can switch to Google Maps or 
7414 12 Oct 17 nicklas 262 # some other map provide that supports a latitude/longitude location.
7414 12 Oct 17 nicklas 263 geolocation.maptemplate = https://www.openstreetmap.org/?mlat={LAT}&mlon={LONG}#map=11/{LAT}/{LONG}
7414 12 Oct 17 nicklas 264 # geolocation.maptemplate = https://www.google.com/maps/search/?api=1&query={LAT},{LONG}
7414 12 Oct 17 nicklas 265
5336 04 May 10 nicklas 266 # ===============
5336 04 May 10 nicklas 267 # SSL section
5336 04 May 10 nicklas 268 # ===============
5336 04 May 10 nicklas 269 # Configuration settings for supporting file access via https.
5336 04 May 10 nicklas 270 # Changes are only needed if authentication is needed or if, for example,
5336 04 May 10 nicklas 271 # files are stored on servers with self-signed certificates.
3719 12 Sep 07 nicklas 272
5336 04 May 10 nicklas 273 # ssl.context.protocol = TLS
5336 04 May 10 nicklas 274 # ssl.context.provider =
5336 04 May 10 nicklas 275 # ssl.keystore.file = 
5336 04 May 10 nicklas 276 # ssl.keystore.password = 
5336 04 May 10 nicklas 277 # ssl.keystore.type = JKS
5336 04 May 10 nicklas 278 # ssl.keystore.algorithm = SunX509
5336 04 May 10 nicklas 279 # ssl.keystore.provider = 
5336 04 May 10 nicklas 280 # ssl.truststore.file = <java-home>/jre/lib/security/cacerts
5336 04 May 10 nicklas 281 # ssl.truststore.password = changeit
5336 04 May 10 nicklas 282 # ssl.truststore.type = JKS
5336 04 May 10 nicklas 283 # ssl.truststore.algorithm = PKIX
5336 04 May 10 nicklas 284 # ssl.truststore.provider = 
5336 04 May 10 nicklas 285
5895 30 Nov 11 nicklas 286 # ===================
5895 30 Nov 11 nicklas 287 # Migration section
5895 30 Nov 11 nicklas 288 # ===================
5895 30 Nov 11 nicklas 289 # Configuration settings that are related to migrating a BASE
5895 30 Nov 11 nicklas 290 # installation on a MySQL database to a PostgreSQL database.
5895 30 Nov 11 nicklas 291 # See documentation for more information.
5895 30 Nov 11 nicklas 292
5895 30 Nov 11 nicklas 293 # Enable this flag to compress the exported data. This may increase
5895 30 Nov 11 nicklas 294 # performance if disks are slow.
5895 30 Nov 11 nicklas 295 # migrate.export.compress = 0 
5895 30 Nov 11 nicklas 296
5895 30 Nov 11 nicklas 297 # The number of rows that should be fetched at the same time from
5895 30 Nov 11 nicklas 298 # the database. Increasing this value may give better performance
5895 30 Nov 11 nicklas 299 # but requires more memory.
5895 30 Nov 11 nicklas 300 # migrate.export.fetch-size = 20000
5895 30 Nov 11 nicklas 301
5895 30 Nov 11 nicklas 302 # Enable this flag to issue an SQL statment for statistical
5895 30 Nov 11 nicklas 303 # analysis of the imported data before continuing with the next table.
5895 30 Nov 11 nicklas 304 # Disabling this may result in very poor performance.
5895 30 Nov 11 nicklas 305 # migrate.import.analyze = 1
5895 30 Nov 11 nicklas 306
5895 30 Nov 11 nicklas 307 # Enable this flag to drop the primary key of a table before importing
5895 30 Nov 11 nicklas 308 # data to it. This may increase the performance. The primary key is
5895 30 Nov 11 nicklas 309 # re-created after the data has been imported.
5895 30 Nov 11 nicklas 310 # migrate.import.drop-primary-key = 1
5895 30 Nov 11 nicklas 311
5895 30 Nov 11 nicklas 312 # Enable this flag to drop unique constraints and indexes before importing
5895 30 Nov 11 nicklas 313 # data. This may increase the performance. The constraints and indexes
5895 30 Nov 11 nicklas 314 # are re-created after the data has been imported. NOTE! Foreign key
5895 30 Nov 11 nicklas 315 # constraints are not affected by this flag, since they must always be dropped.
5895 30 Nov 11 nicklas 316 # migrate.import.drop-constraints = 1
5895 30 Nov 11 nicklas 317
5895 30 Nov 11 nicklas 318