Skip to main content

Introduction

This guide explains how to update Backlog Enterprise using Docker.

System requirements

Refer to the system requirements in the Backlog Enterprise Installation Guide.

Service usage requirements

Refer to the service usage requirements in the Backlog Enterprise Installation Guide.

Process

We’ll walk through an update using Linux as an example. If needed, back up your database and file data storage directory before starting.

  1. Stop Backlog
  2. Run the configuration tool
  3. Start Backlog

Stop Backlog

Stop running Backlog with the following command:

cd <Installation directory>
docker-compose down

Run the configuration tool

Set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY as environment variables copied from the Enterprise Account page.

export AWS_ACCESS_KEY_ID="XXXX"
export AWS_SECRET_ACCESS_KEY="XXXX"

Log in to Docker.

aws ecr get-login-password --region ap-northeast-1 | docker login --username AWS --password-stdin 019623933850.dkr.ecr.ap-northeast-1.amazonaws.com

Then, run the configuration tool under a directory where Backlog is installed.

cd <Installation directory>
docker run --rm -it -v $PWD:/work 019623933850.dkr.ecr.ap-northeast-1.amazonaws.com/enterprise-bootstrap:2.2.1

The configuration is interactive. There are six items to complete, and they should be done according to the environment in which Backlog will function. The existing settings are displayed except the password for connecting to the database. Press “Enter” if you don’t need to make any changes.

Start Backlog

Start Backlog with the following command. The database migration also runs at the same time.

docker-compose up -d

Your update is now complete.

After updating

About the trademark

  • MySQL and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
  • Docker is a trademark or a registered trademark of Docker, Inc. in the United States and/or other countries.
  • Amazon Web Services, AWS, and AWS CLI (Command Line Interface) are trademarks of Amazon.com, Inc. or its affiliates.
  • Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.
  • Red Hat Enterprise Linux is a trademark or a registered trademark of Red Hat Inc. in the United States and other countries.
  • Other company and product names in this document may be trademarks or registered trademarks of their respective owners.

Author: Backlog Support <support@backlog.com>