Upgrading from previous versions
Upgrading from Mingle 1.1
Before you get started
- The upgrade to 2.0 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 1.1 database will be upgraded and fully usable as soon as you start a newly installed 2.0 Mingle server.
- Any old project export files (.mingle files) can be directly imported into the 2.0 version of the application. They will be automatically upgraded upon import.
These instructions are for upgrading from Mingle 1.1 to Mingle 2.0. Look here to see how to upgrade from Mingle 1.0. Upgrades from older versions, specifically, the 2.0 Early Access release and 1.0 Early Access release, are not supported.
Installing the software
Windows
- 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.
- Run the Mingle uninstaller to remove your current installation. The uninstaller will stop the Mingle service if it is currently running.
- 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.
- 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.
OS X
- 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.
- Stop Mingle and quit the Mingle launcher application.
- Drag the new copy of the Mingle application (Mingle.app) into your Applications directory (overwriting the old Mingle).
- Start Mingle, specifying the same data directory and port as before.
- 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)
- Note the location of the Mingle data directory and the port on which Mingle is currently running. These are contained in the mingle.properties file in the 'mingle' application directory.
- If the Mingle server is currently running, stop it using the './MingleServer stop' command inside the 'mingle' application directory.
- Untar the newly downloaded archive.
- Update the mingle.properties file in the new 'mingle' application directory to point to the previous data directory and port. (If you've backed up the old 'mingle' application directory, you can simply copy the file.)
- Start Mingle, using './MingleServer start' inside the new 'mingle' application directory.
- 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...
Numeric properties and precision
Mingle 2.0 introduces numeric property types. Some Mingle charts and tables will now only work with numeric properties. In order that your 1.1 charts and tables do not break the installation process converted any existing properties that contain all numbers to this new numeric property type.
Each project will have a numeric precision that can be managed on the project's main administration. After installation this precision will be set to 10. You may likely wish to lower this value to 2 or 3.
Transition and wiki page names
Mingle 2.0 fixes a couple of issues with the names of transitions and wiki pages. Prior to 2.0 it was possible to create transitions with names that only differed in case. That same was true with wiki pages. This is no longer possible in Mingle 2.0. If you had transitions or pages with such names, one of them will keep the original name, and all subsequence will be given unique suffixes. E.g., If you had 'dev_setup' and 'Dev_Setup' pages they would become 'dev_setup' and 'Dev_Setup_1'
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
- Right click the Mingle application bundle and select 'Show package contents'
- Once the Finder window opens, navigate to Contents/Resources/app/plugins/ldap_auth
- The README file here contains details of how to configure the LDAP authentication plugin
On Unix
- Navigate to the unizipped/untarred folder that contains the MingleServer script.
- Under this directory, locate the plugins/ldap_auth directory
- The README file here contains details of how to configure the LDAP authentication plugin
On Windows
- Navigate to the directory where you installed the application (typically C:\Program Files\Mingle-2_0)
- Under this directory, locate the plugins/ldap_auth directory
- 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: :strictThe default, which is empty, places no restrictions on formats of the password.
Upgrading from Mingle 1.0
Before you get started
- The upgrade to 2.0 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 1.0 database will be upgraded and fully usable as soon as you start a newly installed 2.0 Mingle server.
- Any old project export files (.mingle files) can be directly imported into the 2.0 version of the application. They will be automatically upgraded upon import.
These instructions are for upgrading from Mingle 1.0 to Mingle 2.0. Upgrades from older versions, specifically, the 1.0 Early Access release, are not supported. Look here to see how to upgrade from Mingle 1.1.
Installing the software
Windows
- 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.
- Run the Mingle uninstaller to remove your current installation. The uninstaller will stop the Mingle service if it is currently running.
- 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.
- 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.
OS X
- 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.
- Stop Mingle and quit the Mingle launcher application.
- Drag the new copy of the Mingle application (Mingle.app) into your Applications directory (overwriting the old Mingle).
- Start Mingle, specifying the same data directory and port as before.
- 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)
- Note the location of the Mingle data directory and the port on which Mingle is currently running. These are contained in the mingle.properties file in the 'mingle' application directory.
- If the Mingle server is currently running, stop it using the './MingleServer stop' command inside the 'mingle' application directory.
- Untar the newly downloaded archive.
- Update the mingle.properties file in the new 'mingle' application directory to point to the previous data directory and port. (If you've backed up the old 'mingle' application directory, you can simply copy the file.)
- Start Mingle, using './MingleServer start' inside the new 'mingle' application directory.
- 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...
Managing card types
Mingle 1.1 introduced the concept of card types, which you can read all about over here. Due to this, the name 'Type' is no longer a valid property name. When you install Mingle 2.0,
- If you had a property called "Type" for any of your existing projects, the upgrade process will rename it to "Type (1.0)". None of your data will be lost.
- A new card type named "Card" will be created.
Once you have installed Mingle 2.0, if you want to use your values for the property "Type (1.0)", or indeed any other property, as card types, you can follow the sequence of steps below. If, for example, you had a property called 'Type' which had two values "Bug" and "Story"; and the installer changed the name of this property to 'Type (1.0)'w
- Setup new card types with the same names as the old property values. E.g., create two card types called Bug and Story.
- We would recommend at this point to have all your properties available to all card types. You can change this once you have completed this upgrade.
- Repeat the steps below for each value of the 'Type (1.0)' property.
- Use the filter (described here) to filter all your cards. E.g., filter your card list using the condition "Type (1.0) is Bug".
- Verify that you would like to set the card type for all these cards to the newly created card type with the same name.
- Click the 'All' link that selects all the check boxes.
- Use the bulk editor (described here) to set the card type for all the selected cards to the newly created card type.
- Once you are done updating all cards which had values set for the old property, filter the cards by the condition "Type (1.0) is (not set)". These cards would have been assigned the default card type, which is 'Card'.
- Use the bulk-edit feature to set the card type for these as appropriate.
- Once you are satisfied that all cards have been assigned card types, you can start changing the relationship between card types and properties. Read more about card type management here.
Numeric properties and precision
Mingle 2.0 introduces numeric property types. Some Mingle charts and tables will now only work with numeric properties. In order that your 1.1 charts and tables do not break the installation process converted any existing properties that contain all numbers to this new numeric property type.
Each project will have a numeric precision that can be managed on the project's main administration. After installation this precision will be set to 10. You may likely wish to lower this value to 2 or 3.
Transition and wiki page names
Mingle 2.0 fixes a couple of issues with the names of transitions and wiki pages. Prior to 2.0 it was possible to create transitions with names that only differed in case. That same was true with wiki pages. This is no longer possible in Mingle 2.0. If you had transitions or pages with such names, one of them will keep the original name, and all subsequence will be given unique suffixes. E.g., If you had 'dev_setup' and 'Dev_Setup' pages they would become 'dev_setup' and 'Dev_Setup_1'
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
- Right click the Mingle application bundle and select 'Show package contents'
- Once the Finder window opens, navigate to Contents/Resources/app/plugins/ldap_auth
- The README file here contains details of how to configure the LDAP authentication plugin
On Unix
- Navigate to the unizipped/untarred folder that contains the MingleServer script.
- Under this directory, locate the plugins/ldap_auth directory
- The README file here contains details of how to configure the LDAP authentication plugin
On Windows
- Navigate to the directory where you installed the application (typically C:\Program Files\Mingle-2_0)
- Under this directory, locate the plugins/ldap_auth directory
- 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: :strictThe default, which is empty, places no restrictions on formats of the password.