How to move the Bamboo Home location to a different place

Still need help?

The Atlassian Community is here for you.

Ask the community


Platform notice: Server and Data Center only. This article only applies to Atlassian products on the Server and Data Center platforms.

Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Except Fisheye and Crucible

Summary

This article explains how to move <bamboo-home> location to another place on your system.

Environment

Bamboo 7, 8

Diagnosis

In certain environments, extending the <bamboo-home> filesystem is not possible due to several factors. If growing it is not an option, you will need to instruct Bamboo to point it to a new location with more space.

It can also be the case that the current <bamboo-home> location does not satisfy certain design requirements or standards and needs to be modified.

Solution

Move your <bamboo-home>

To move your <old-bamboo-home> to another place you will need to take a few steps as follows:

  1. Stop Bamboo completely, including any Agents and the Database
  2. Have a Full Backup of your Bamboo, this is a safeguard in case something goes wrong
  3. Copy (don't move) the <old-bamboo-home> data to the <new-bamboo-home> location
  4. Confirm that the file permissions and ownership of the new <new-bamboo-home> location and their files are equivalent to the old one
  5. Modify <bamboo-install>\atlassian-bamboo\WEB-INF\classes\bamboo-init.properties and change the bamboo.home= entry to reflect the <new-bamboo-home>
  6. Start your Database, Bamboo Server and its Agents as usual
  7. Test, stress and validate if everything is working as required
  8. Cleanup the old area


Bamboo requires a filesystem that supports full file locking. Using Bamboo over remote shares running alternative filesystems such as VxFS, GlusterFS, GFS2, etc is not tested and may create unpredictable results. Please avoid using such filesystems.

For Bamboo Home folders originally created on versions earlier than 8.0, the following locations require strict filesystem permissions to work. Please use the Bamboo user account or an elevated user (root/Administrator) to copy the files from one location to another. Make sure to set the file and folders permissions and ACLs post-migration as Bamboo will refuse to start in case those locations have the wrong permissions.

  • Bamboo 7: <bamboo-home>\xml-data\configuration\cipher
  • Bamboo 8: <bamboo-home>\shared\configuration\cipher
  • Bamboo 8 clustered: <bamboo-shared-home>\configuration\cipher

On Windows, If you can't use the Bamboo user account to run the copy due to it being a Service account (e.g. Local Service), you will need to change the cipher folder ownership to a user you have control over before starting the copy. This is necessary as that folder has strict permissions that would forbid any other users from accessing its contents. Once the ownership is changed, copy the file to its final destination and restore the file ownership to its original settings. Bamboo will refuse to start if the file ownership doesn't belong to the user running the application. 

If you are migrating a Bamboo Home that was created on version 8 or later, you just need to provide enough ACL permissions on the new location.



Last modified on Apr 6, 2022

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.