Stash Latest : Stash upgrade guide

The instructions on this page describe how to upgrade Stash from a previous version. For the latest and greatest Stash release, see Releases. For details of the latest Stash 1.3.x release, see the Stash 1.3 changelog. Please read the Supported platforms page for the full list of supported platforms for Stash. Upgrading to Stash 1.3 This section provides specific notes for upgrading to Stash 1.3. See also the Upgrade steps section below. Email server An email server must be configured in Stash so that email notifications for pull request events can be sent. Please see Setting up your mail server for details. Upgrading from Stash 1.3 beta Click to see information about upgrading from the beta... Stash 1.3 uses improved commenting compared to the 1.3 beta. This means that when you upgrade from the beta to Stash 1.3: Pull request comments made in the beta against the diff will only appear in the activity, and not in the diff, in Stash 1.3. Future comments made on the same pull request in Stash 1.3 will behave as expected. Reviewers, participants and watchers were added after the beta was released. After you upgrade, existing pull requests will not have participants or watchers. You can add reviewers by editing the pull requests and any future commenters will be added as a participant and watcher to the pull request as you would expect.

On this page: Upgrading to Stash 1.3 Upgrade steps Upgrading from Stash 1.0.x to 1.1 or higher Developing for Stash Checking for known issues and troubleshooting the Stash upgrade Related pages: Releases Getting started Administering Stash

Upgrade steps

This section provides general instructions for upgrading Stash. See also the specific notes on this page for the version of Stash you are upgrading to. We strongly recommend that you upgrade Stash by following these steps:

1. Stop Stash!

To stop Stash, change directory in a terminal or command prompt to the <Stash installation directory> and run:

• Windows:

  bin\stop-stash.bat

• Linux and Mac:

  bin/stop-stash.sh

2. Back up your Stash data!

• Back up the Stash home directory. This is where your Stash data is stored. The home directory location is defined:
  • On Windows: by the STASH_HOME environment variable, or by the STASH_HOME line of <Stash installation directory>/bin/setenv.bat.
    
  • On Linux and Mac: by the STASH_HOME line of <Stash installation directory>/bin/setenv.sh.
• If you are using an external database, back up this database. Follow the directions provided by the database vendor to do this.

3. Download and install Stash as usual

In particular, you must redefine the Stash home directory. See the following for more information:

• Installing Stash on Windows
• Installing Stash on Linux and Mac

If you made custom changes to the configuration of your existing Stash installation, for example for the port or context path, you will have to make these changes for the new installation as well.

If you are using MySQL Stash does not ship with the MySQL database driver. You will need to reinstall the driver in the new installation, or copy the previous driver from the old <Stash installation directory>/lib to the new <Stash installation directory>/lib.

4. Start Stash

To start Stash, change directory in a terminal or command prompt to the <Stash installation directory> and run:

• Windows:

  bin\start-stash.bat

• Linux and Mac:

  bin/start-stash.sh

Upgrading from Stash 1.0.x to 1.1 or higher

SSH

When you restart Stash after upgrading to 1.1, Stash will automatically enable SSH access to your repositories, on the default port of 7999.

If you want to change the port, or are hosted behind a proxy or firewall, you may also need to change the SSH base URL so the clone URL's in Stash are correct. See the SSH admin instructions.

Developing for Stash

If you are a Stash plugin developer, please refer to our Stash developer documentation.

Checking for known issues and troubleshooting the Stash upgrade

If something is not working correctly after you have completed the steps above to upgrade your Stash installation, please check for known Stash issues and try troubleshooting your upgrade as described below:

• Check for known issues. Sometimes we find out about a problem with the latest version of Stash after we have released the software. In such cases we publish information about the known issues in the Stash Knowledge Base.

• If you encounter a problem during the upgrade and cannot solve it, please create a support ticket and one of our support engineers will help you.