Locked History Actions

UninstallingRepositoriesFromGalaxy

Galaxy Main Tool Shed

Deactivating and uninstalling tool shed repositories installed into a local Galaxy instance

Those hosting their own Galaxy instances may find it useful to use tools contained in an installed tool shed repository for a period of time, and then remove them from the tool panel either temporarily or permanently. To enable this, Galaxy provides the ability to deactivate or uninstall an installed tool shed repository.

Deactivating an installed tool shed repository results in the following.

  • The repository and all of it's contents will remain on disk.
  • Any contained tools will not be loaded into the Galaxy tool panel.
  • Any contained proprietary datatypes, datatype converters and display applications will be eliminated from the datatypes registry.
  • The repository record's deleted column in the tool_shed_repository database table will be set to True.

Uninstalling this repository will result in the following.

  • The repository and all of it's contents will be removed from disk.
  • If the repository contains tools, their tag sets will be removed from the tool config file in which they are defined.
  • Any contained proprietary datatypes, datatype converters and display applications will be eliminated from the datatypes registry.
  • The repository record's deleted column in the tool_shed_repository database table will be set to True.
  • The repository record's uninstalled column in the tool_shed_repository database table will be set to True.
  • If the repository was installed via the Galaxy install manager (this occurs when the repository contains tools that used to be available in the Galaxy distribution, but are now contained in a tool shed repository hosted on the main Galaxy tool shed), all records associated with the repository will be eliminated from the tool_id_guid_map database table.

Let's take a look at how this works. Assume you are the administrator of a local Galaxy instance that includes the following tools and tool sections in the tool panel. The Get Data section includes the upload tool included in the Galaxy distribution. You manually installed the Add column tool from a local Galaxy tool shed, placing it outside of any sections in the tool panel. The Mothur tool section contains the Mothur tool suite and the two repos tool section contains tools from two repositories that you manually installed from a local Galaxy tool shed (the Grinder and Blast2GO tools). The EMBOSS tool section contains the Emboss version 5.0.0 tools that used to be included in the Galaxy distribution, but are now hosted on the main Galaxy tool shed. You configured your Galaxy instance to automatically install the repository containing these tools and the repository containing the Emboss datatypes using Galaxy's new install manager.

local_galaxy_example.png

Since your Galaxy instance includes several installed tool shed repositories, the Administration menu wil include a link labeled Manage installed tool shed repositories in the menu's Server section. Clicking on that link will display a page like the following.

manage_installed_repositories.png

Each of the installed tool shed links includes a pop-up menu just right of the repository name (the downward pointing triangle). The pop-up menu includes an option labeled Deactivate or uninstall.

deactivate_or_uninstall.png

Clicking the Deactivate or uninstall option for the installed repository named add_value will display the following page. Notice the check box allowing you to deactivate the repository if its left blank or uninstall the repository if its checked.

deactivate_add_value.png

Since the add_value repository includes only tools and no proprietary datatypes, deactivating the repository will set the repository record's deleted column in the tool_shed_repository database table to True, and keep the tool from being displayed in the tool panel. Clicking the Deactivate or uninstall button will display the following page. Notice that the add_value repository is no longer displayed in the list of installed repositories.

deactivated_add_value.png

And the Add column tool is no longer displayed in the Galaxy tool panel.

add_value_not_displayed.png

Let's try uninstalling the blast2go repository - notice we've checked the check box here.

uninstall_blast2go.png

After uninstalling the repository, the following page is displayed. The repository files have been removed from disk, and the XML tag set for the Blast2GO tool has been removed from the tool config file.

uninstalled_blast2go.png

Inspecting the tool panel shows us that the Blast2GO tool is no longer included in the two repos tool section.

blast2go_not_displayed.png

How can we reinstall a repository that we've uninstalled? From the Administration Manage installed tool shed repositories page, click the deleted option within the Advanced search feature...

advanced_search.png

...and the list of repositories that you have deactivated or uninstalled will be displayed.

inactive_repositories.png

The pop-up menus on this page allow you to activate or reinstall the repositories.

activate_or_reinstall.png