Loading
Back to previous page

Advanced configuration

Introduction

In Mingle 2.3 many configuration options have been moved to the Mingle data directory and can be specified in mingle.properties. Having the ability to manage these outside the installation folder means that upgrading your Mingle instance and keeping your existing configuration is now much easier.

Do not alter your Mingle configuration unless you completely understand the impact of the change. We recommend discussing any configuration changes you are unsure of with the Mingle support team before they are made.

mingle.properties configuration options

Please refer to the mingle.properties.example file in your Mingle installation folder as an example of the latest mingle.properties format.

Configuring a swap directory

The swap directory (swapDir) will act as a tmp space in which to store intermediate data such as project exports (.mingle files) while they are being created, project import files that are being imported, excel import content that is being processed for preview and excel import content that is being processed for import.

This directory should not be within the Mingle installation folder. To avoid problems with future upgrades, please keep this directory separate from the Mingle installation.

As well as being able to set a swap directory during installation on Mac OSX and Windows, you can also specify a property in mingle.properties to set the swap directory as follows:

-Dmingle.swapDir=/path/to/your/data/tmp

If unspecified, a default context path of /dataDir/tmp will be used.

Configuring a config directory

The config directory (configDir) is where Mingle will store project configuration files such as database.yml.

This directory should not be within the Mingle installation folder. To avoid problems with future upgrades, please keep this directory separate from the Mingle installation.

As well as being able to set a config directory during installation on Mac OSX and Windows, you can also specify this as follows:

-Dmingle.configDir=/path/to/your/data/tmp

If unspecified, a default context path of /dataDir/config will be used.

Configuring a port

As well as being able to set a port during installation on Mac OSX and Windows, you can also specify a property in mingle.properties to set the network port from which to run Mingle as follows:

-Dmingle.port=1234

If unspecified, a default of '8080' will be used.

Configuring an alternate app context

You can specify a property in mingle.properties to set an alternate app context as follows:

-Dmingle.appContext=/mingle

If specified, this will configure an app context of /mingle respectively. If unspecified, a default context path of / will be used.

Configuring the log directory

You can specify a property which is the directory you would like to have your logs written to, such as /var/log, as follows: 

-Dmingle.logDir=/path/to/log/dir

If unspecified, a default value of "log", under the installation folder, is used.

Configuring an AJP connector

You can specify a property in mingle.properties to set an AJP connector as follows:

-Dmingle.ajp13port=xxxx

If specified, this will configure an AJP13 connector listening on port xxxx. If unspecified, no AJP connector will be configured.

Configuring the memcached host and port

You can specify two properties in mingle.properties to set a memcache host and port as follows:

-Dmingle.memcachedHost=mingle.mingle.com 
-Dmingle.memcachedPort=11311

This will connect to a memcached server at mingle.mingle.com:11311. If not specified, the default values are localhost & 11211 respectively.

Setting JVM flags

You can set JVM flags in mingle.properties as follows:

-Xmx1512m
-Xms256m

Local help

Mingle help is located on the ThoughtWorks Studios website. The Mingle help files are also packaged with your local Mingle instance. In cases where network access is limited, you may want Mingle to link to your local help rather than the online help.

Online help has several advantages to local help. Consider the following before you switch to local help:

  • Online help has a search feature (added in Mingle 3.2); local help cannot be searched.
  • Online help may be more up to date than local help. As we make updates to help, we are able to post the latest help online.

Linking to local Mingle help

  1. Open [mingle_root]/config/initializers/document.rb

    mingle_root is the directory where you installed Mingle.

  2. Change HELP_DOC_DOMAIN from

    HELP_DOC_DOMAIN = ONLINE_HELP_DOC_DOMAIN

    to

    HELP_DOC_DOMAIN = ""

Also see...