Help

Upgrading from Mingle 2.1

Before you get started

  • Please ensure that no-one, other than Mingle administrators completing the upgrade, has access to Mingle during the upgrade process. We expect that the upgrade of Mingle is completed by Mingle administrators only.
  • The upgrade to 2.3 involves migration of your existing data which is a very sensitive process. We strongly recommend that you make a backup of the Mingle data directory and your database before starting the upgrade process. DO NOT SHUT DOWN THE SERVER IN THE MIDDLE OF THE UPGRADE PROCESS AT ANY COST.
  • ANY TEMPLATES THAT WERE INSTALLED WITH THE PREVIOUS RELEASES WILL BE REPLACED. This has no impact on any of your existing projects or any templates that you have created yourself. If you have modified the pre-installed templates and wish to keep them you must export them and then import them using a different name before the upgrade.
  • The Mingle database will be upgraded and any projects in your 2.1 database will be upgraded and fully usable as soon as you start a newly installed 2.3 Mingle server.
  • Any old project export files (.mingle files) can be directly imported into the 2.3 version of the application. They will be automatically upgraded upon import.

These instructions are for upgrading from Mingle 2.1 to Mingle 2.3. Look here to see how to upgrade from Mingle 2.2, here to see how to upgrade from Mingle 2.0.1 and here to see how to upgrade from Mingle 2.0. Upgrades from earlier versions such as 1.0 & 1.1 and specifically, the 1.0 Early Access & 2.0 Early Access versions are not supported.

Installing the software

If you have an existing Mingle configuration that you would like preserved copy your existing mingle.properties file, which can be found in the previous installation directory of Mingle, into your Mingle data directory before you start Mingle 2.3. Please refer to the mingle.properties.example file in your Mingle 2.3 installation folder as an example of the latest mingle.properties format.

Windows

  1. Note the location of the Mingle data directory and the port on which Mingle is currently running. Typically, the Mingle data directory is in your home directory (C:\Documents and Settings\[username]\Mingle) and the port is 8080.
  2. Run the Mingle uninstaller to remove your current installation. The uninstaller will stop the Mingle service if it is currently running.
  3. Run the new installer, specifying the same data directory and port as the previous installer. The installer will automatically start the new Mingle service when it completes.
  4. Open your browser to any Mingle page. You will be walked through the upgrade steps. All existing project data will be upgraded for continued use.

If you do not uninstall Mingle manually and try to install a newer version at the same location as an existing installation, Mingle will automatically uninstall the existing installation of Mingle before installing the new version.

OS X

  1. Note the location of the Mingle data directory and the port on which Mingle is currently running. These are both visible from the Mingle launcher application window.
  2. Stop Mingle and quit the Mingle launcher application.
  3. Drag the new copy of the Mingle application (Mingle_2_3_xxxxx.app) into your Applications directory (overwriting the old Mingle).
  4. Start Mingle, specifying the same data directory and port as before.
  5. Open your browser to any Mingle page. You will be walked through the upgrade steps. All existing project data will be upgraded for continued use.

Linux/Unix (except Solaris)

  1. Note the location of the Mingle data directory on which Mingle is currently running. This is contained in the mingle.properties file in the 'mingle' application directory.
  2. Copy the mingle.properties file that is in the 'mingle' application directory.
  3. If the Mingle server is currently running, stop it using the './MingleServer stop' command inside the 'mingle' application directory.
  4. Untar the newly downloaded archive.
  5. Using the mingle.properties.example file in your Mingle installation folder as an example of the latest mingle.properties format, reformat your existing mingle.properties file and move this into your data directory.
  6. Start Mingle, using './MingleServer --mingle.dataDir=/path/to/your/data start' where /path/to/your/data is the location of your data directory.
  7. Open your browser to any Mingle page. You will be walked through the upgrade steps. All existing project data will be upgraded for continued use.

Solaris

The steps to install on Solaris are very similar to that on any other UNIX except

  • You would use the UNIX zip installer rather than the tar.gz installer due to the fact that the default Solaris tar command is incompatible with the format with GNU tar.
  • You will have to ensure that the MingleServer script in the application directory has execute permissions.

After installation is complete...

Using LDAP for authentication

The authentication settings for Mingle are controlled through the [mingle_data_directory]/config/auth_config.yml file. This file is created by default on all brand new installations. These settings mostly pertain to LDAP integration. For a detailed explanation of what the various properties of this file represent, you can read the LDAP authentication README file included with this distribution. The location of this file varies by distribution.

On OSX
  1. Right click the Mingle application bundle and select 'Show package contents'
  2. Once the Finder window opens, navigate to Contents/Resources/app/plugins/ldap_auth
  3. The README file here contains details of how to configure the LDAP authentication plugin
On Unix
  1. Navigate to the unizipped/untarred folder that contains the MingleServer script.
  2. Under this directory, locate the plugins/ldap_auth directory
  3. The README file here contains details of how to configure the LDAP authentication plugin
On Windows
  1. Navigate to the directory where you installed the application (typically C:\Program Files\Mingle_2_2)
  2. Under this directory, locate the plugins/ldap_auth directory
  3. The README file here contains details of how to configure the LDAP authentication plugin

Setting password format restrictions

If you would like the password format for all your users to be a combination of numbers, letters and punctuation, and enforced strictly, set:

                  password_format: :strict

The default, which is empty, places no restrictions on formats of the password.