Due to a security vulnerability, administrators are strongly encouraged to upgrade to the April 8, 2013 Security Release, which is was not included in the original April 1, 2013 distribution.
# Get Galaxy
Please note new upgrade syntax
$ hg clone https://bitbucket.org/galaxy/galaxy-dist#stable
$ hg pull
$ hg update release_2013.04.01
Key Upgrades This Release
This distribution has four key upgrades that must be considered by local administrators.
These are listed first. Each is important. Please review carefully.
Improvements to Distribution Release Process
As announced in the February 8, 2013 distribution, we have made some improvements to our release process. Because of these changes, you must include the new distribution release tag in your
hg update command to upgrade to this distribution release and all future releases.
As a reminder, or if this is your first upgrade using the new process, this is how to upgrade:
% hg pull
% hg update release_2013.04.01
If you do not include the
release_2013.04.01 tag, your repository will update to the
default branch, which includes unstable code. After updating, you can verify that you are on the
stable branch with:
% hg branch
Once you're on the
hg pull -u without a specific revision or branch will cause you to remain on the
The new release process works as such:
The Galaxy source repository now contains two branches:
stableis committed to regularly and contains important bugfixes.
defaultis committed to regularly and contains new features as well as fixes merged from
- Every two months,
stablewill be updated with new features from default and a specific distribution release version will be tagged.
- The two weeks prior to the release will be focused on fixing bugs found in the targeted upcoming release. New features will not be considered for inclusion in the upcoming release during this time.
This process will not only allow us to deploy important bug fixes on to the
stable branch rapidly and in between releases, it will improve the quality of our tagged releases. The documentation at our wiki reflects these changes: getgalaxy.org.
Job Running Configuration Changes
This Galaxy release contains considerable changes to the way that the job running configuration is defined and implemented. It also includes a refactoring of all job runner plugins that are provided with the Galaxy source. We have made every attempt to make upgrading to this release possible while jobs are running and without any configuration changes.
That said, job running is a complex component that relies on many outside components and an infinite array of site-specific environments, so we cannot guarantee that Galaxy will correctly convert jobs to the new job definition language in all scenarios.
It is strongly advised that you do upgrade testing against a non-production instance with running jobs before upgrading any production instances if you do not want to risk having to restart any jobs running at the time that Galaxy is upgraded to this release.
If you only use the default/local job running configuration, you can ignore the following process, as local jobs running at the time of restart can never be recovered (as has been the case in all prior releases).
The process for upgrading to this release should be:
- Pull and update to the release as documented (above), but do not restart any Galaxy server processes.
- Stop and permanently disable the
managerprocess, as there is no longer a dedicated process for assigning job handlers (it is done at the time of job creation).
- Create a
( most easily done by starting with the provided
- When defining
attribute must match the URL scheme for any jobs currently running which you want to recover. For example, jobs running via
will be recovered by the plugin with id
. Likewise for
- Restart handler(s) (preferably one at a time) and watch the logs. Warnings about using the deprecated
set_runner()function can be ignored as this is part of the process of converting jobs from URLs to destinations upon first startup.
As explained above, it is not strictly required that you switch to the new-style configuration. All old-style URL options should continue to work, however, it is strongly encouraged that you update to the new-style configuration for the advanced features (and future flexibility) it provides.
Full documentation on the new job running configuration is available at:
# Required Metadata Reset
*** It is critical that you reset the metadata on your installed tool shed repositories when you upgrade your Galaxy instance to this revision! ***
When a tool shed repository is installed into your local Galaxy instance, metadata is generated for the repository as a part of the installation process and stored in the tool_shed_repository.metadatatable column in the Galaxy database. This automatic process inspects the contents of the specific revision of the installed repository and generates and stores important information about it. This metadata information is used by certain Galaxy features. As new features are added to Galaxy or the tool shed, the process that generates this installed tool shed repository metadata within the Galaxy instance may be enhanced to accommodate information about the new features. Read more…
# Local Tool Shed File Changes
Changes required to your environment if you are hosting a local Tool Shed
The tool shed used to be named the * "Galaxy Community Space" *, so there are several files that used to be named something "community" related (e.g.,
community_wsgi.ini, run_community.sh, etc). In addition, many code files were named with the "community" string. These various references to "community" have now been changed to "tool_shed". So, if you are hosting your own local tool shed, be aware that the following file names have changed:
- community_wsgi.ini => tool_shed_wsgi.ini
- run_community.sh => run_tool_shed.sh
- community_webapp.log => tool_shed_webapp.log
community_wsgi.ini file had this entry:
# Specifies the factory for the universe WSGI application
paste.app_factory = galaxy.webapps.community.buildapp:app_factory
The above entry should be changed to the following in your local renamed
tool_shed_wsgi.ini file (notice that "community" has been changed to be "tool_shed"):
# Specifies the factory for the universe WSGI application
paste.app_factory = galaxy.webapps.tool_shed.buildapp:app_factory
# Python 2.5 Support Ending Soon
This is last Galaxy distribution that will support Python 2.5. Follow the ticket: http://trello.com/c/OQT8Iun8
- The Galaxy Main Rsync server hosts download of the same
.locfiles and genome data used by the Galaxy team. This service now also hosts all pre-cashed datasets, such as MAF, blastdb, etc. Our updated wiki lists the available directories: Get the data
- Basic Data Manager Functionality is now present for locally defined and Tool Shed installed data managers (Admin/Tools/DataManagers).
An abstracted interface has been created for the data manager to download, generate, or otherwise procure locally cached data for use in analyses. For details about implementation, please see the following Trello tickets.
Integration with the Tool Shed:
# Tool Shed
New Tool Shed Features
- The following scripts are available for inspecting and maintaining the repositories contained within a local tool shed that you are hosting. You can configure
cronto execute these scripts on a regular schedule or execute them manually against your local tool shed whenever you choose. Each of these scripts is configured to execute regularly against both of the public tool sheds supported by the core Galaxy development team. Read more...
RESTful APIframework has been added to the tool shed. Read more...
- Add the ability to view lists of tool shed repositories that are ready for review or have tools with invalid functional tests. These lists are available only to members of the Intergalactic Utilities Commission.
- New lists of Valid Galaxy Utilities are now available in the tool shed allowing you to inspect more granular contents of repositories. Lists of tools, custom datatypes, repository dependency definitions and tool dependency definitions are currently available. The framework supporting this feature will be used to enhance searching the tool shed in a future Galaxy release where you will be able to search the tool shed for any of these galaxy utilities (currently you can only search for tools and workflows).
Enhancements to existing Tool Shed features
- In addition to repository owners, users with write permission on a repository can now browse reviews of that repository. See the details...
- The sharable link for repositories has been enhanced to include a specific
changeset revisionif the link is not for the repository tip.
- Sharable links have been added to email alerts messages for new or updated repositories in the tool shed.
- Many additional tests have been added to the tool shed functional test framework. The Tool Shed's functional test framework defined.
- Handle all Galaxy utility types (custom datatypes, data manager tools, tools, tool dependency definitions, repository dependency definitions, workflows) when reinstalling an uninstalled tool shed repository. The shed-related tool panel configuration file can now be selected when reinstalling repositories with any contents so that a different "tool_path" location can be selected for the location of the reinstalled repository.
- Enhance the hours_between_check config setting to handle float values in addition to int values. This allows for functional tests to test the Galaxy update manager.
- Enhance tool shed repository metadata generation process for custom datatypes to include information for datatypes converters and display applications. Correctly handle setting the "add_too_tool_panel" attribute for datatype converter tools so that they will not be displayed in the Galaxy tool panel when they are contained in installed tool shed repositories.
- Handle tool shed repositories that contain only tools that should not be displayed in the Galaxy tool panel from those that contain tools that should be displayed in the Galaxy tool panel appropriately. Selecting a tool panel section is no longer allowed for repositories that do not contain any tools that should be displayed there. This behavior now exists when installing or reinstalling repositories into Galaxy.
- Enhancements and fixes for sharable URLs for repositories in the tool shed - the following URLs are now all available:
Tool Shed Fixes
- Fix for handling custom datatype definitions in repositories being installed from the tool shed when only datatypes that subclass from those in the Galaxy framework are defined (i.e., there are no custom datatype class files for the datatypes). In addition, this changeset now properly handles installing a tool shed repository that included custom datatype definitions (they were failing due to a bug in this same method).
- Fix for installing a repository from the tool shed that includes a repository dependency definition where the required repository is owned by a user other than the dependent repository.
- Fix for installing a repository that only contains a workflow, then importing that workflow to Galaxy.
- Fix for deleting and undeleting repositories in the tool shed: if deleting, all installable revisions are marked as not installable, and if undeleting, all revisions are inspected and those determined to be installable are marked accordingly.
- Handle exceptions when attempting to parse a datatypes_conf.xml file in a tool shed repository. Also handle exceptions when attempting to parse certain other xml definition files contained in tool shed repositories.
- Require and pass-through authentication for the 'pushkey' mercurial command when pushing changes to a tool shed repository.
- Display an error message when cookies are blocked between the tool shed and Galaxy.
- Tool configs included in repositories in the tool shed that display images in the tool's help section will need to use the new reserved word
$PATH_TO_IMAGESwhen defining the location of the image files as follows:
.. image:: $PATH_TO_IMAGES/count_modes.png
This reserved word will route correctly in the tool shed when the tool is displayed inside of it's containing repository, and it will also route correctly when the tool is loaded from it's repository after it has been installed into Galaxy. All the details...
- Performance enhancements https://trello.com/c/JYGO5hqM
- Collapsed composite tracks now retain the composite group name https://trello.com/c/roHlElAW
- Condor will allow federation of clusters, at first with manual configuration.
- Expose function that creates SVG images from workflows to UI https://trello.com/c/PGz7JNzO
- Genetrack retired (view link in datasets removed) https://trello.com/c/LQr88MTz
- UI Refactoring of links to display at UCSC https://trello.com/c/ugHUBEk2
- Use "Chunked Tabular Dataset View" to display public datasets https://trello.com/c/p6lyDBNK
- "Select all" jobs in admin menu https://trello.com/c/Sc975x1l
Allow old-style external display applications to be disabled https://trello.com/c/9dgk1VSl
- related improvements pending: https://trello.com/c/uIctksud
Pull Requests Merged
- Refactoring Task Splitting Toward Per-Job Definitions, pull request #87. Thanks to John Chilton. https://trello.com/c/04FGD1Fv
- Adding variable 'host_url' to provide qualified URL of host to tool help section, pull request #119. Thanks to Kyle Ellrott. https://trello.com/c[/RuO0tJ7r](/archive/dev-news-briefs/2013-04-01/RuO0tJ7r/)
- Display the toolshed tools in the workflow search, pull request #120. Thanks to Björn Grüning. https://trello.com/c/ebePONBa
Although there are no specific known security fixes in this distribution, all Galaxy instance maintainers are strongly encouraged to run the latest release to take advantage of other improvements and fixes.
# Bug Fixes and related Enhancements
- Assign proper job state to uploaded, deleted, files https://trello.com/c[/IdS6](/archive/dev-news-briefs/2013-04-01/IdS6/)EYwE
- UI Refactoring: more graceful handling of individual hda errors https://trello.com/c/qIPH1bJP
- Screencast display window size corrected (was too small) https://trello.com/c/QTZLmi70
- Restored header/"no peek" window content for datasets without UI display https://trello.com/c/zlEnYNjY
- Markupsafe reimport for both local and cloud instances https://trello.com/c/IIInOBNr
- File name issues with Torque and DRMAA fixed https://trello.com/c/4F2VXZBw
- Left panel in admin view not scrollable https://trello.com/c/lK4YHKV3
- Bowtie2 wrapper usage with samtools fixed https://trello.com/c/v9G7v5DV
- Fix "File Upload -> File Format" list to reflect settings in datatypes_conf.xml https://trello.com/c/5ageaGBd
- Fix drillDown fields and parameters display https://trello.com/c/JN8495Up
- Scatter plot tool treats empty/absent values as NULL values instead of errors https://trello.com/c[/BmoMa](/archive/dev-news-briefs/2013-04-01/BmoMa/)PXc
# About Galaxy
Have a suggestion? Please see Using the Galaxy Issue Board.