docker-jira

Dockerized Atlassian JIRA

About
How-to guides

About

This repo uses Docker and Docker Compose to automate the deployment of Atlassian JIRA.

This is more than just a JIRA image. Included in this repo is everything you need to get JIRA up and running as quickly as possible and a pre-configured backup and restoration solution that is compliant with Atlassian's production backup recommendations.

The JIRA image in this repo uses AdoptOpenJDK, which is a supported platform.

How-to guides

Note: some of the commands in these guides may require root access to your system. If that is the case, either run the commands while logged in to the root account, or simulate a login to the root account using sudo -i. Due to the way environment variables are passed on some systems, typing sudo before each command is not a supported method of running the commands in these guides with root access.

Installing

Ensure the following are installed on your system:
- Docker
- Docker Compose Warning: installing as a container is not supported.
- git
- tar
Clone this repo to a location on your system. Note: in all of the guides on this page, it is assumed the repo is cloned to /srv/docker/jira.
```
git clone https://github.com/ianharrier/docker-jira.git /srv/docker/jira
```
Set the working directory to the root of the repo.
```
cd /srv/docker/jira
```
Create the .env file using .env.template as a template.
```
cp .env.template .env
```
Using a text editor, read the comments in the .env file, and make modifications to suit your environment.
```
vi .env
```
Start JIRA in the background.
```
docker-compose up -d
```
In a web browser, start the JIRA setup process by navigating to http://<Docker-host-IP>:8080 (or whatever port you specified in the .env file).
Choose to setup JIRA using a PostgreSQL database, and use db as the database hostname. Use the database name, username, and password specified in the .env file.
After the initial JIRA setup is complete, delete the Backup Service service (the com.atlassian.jira.service.services.export.ExportService class) at http://<Docker-host-IP>:8080/secure/admin/ViewServices!default.jspa to avoid creating unnecessary backups. Note that if you do not delete the Backup Service service and the backup solution in this repo is enabled, the backup solution will automatically delete all XML backups created by JIRA.

Upgrading

Warning: the upgrade process will immediately stop and upgrade the current production environment. The application stack will be unavailable while it is being upgraded.

Set the working directory to the root of the repo.
```
cd /srv/docker/jira
```
Run the upgrade script.
```
./scripts/app-upgrade.sh
```

Running a one-time manual backup

Set the working directory to the root of the repo.
```
cd /srv/docker/jira
```
Run the backup script.
```
docker-compose exec cron app-backup
```

Restoring from a backup

Warning: the restoration process will immediately stop and delete the current production environment. You will not be asked to save any data before the restoration process starts.

Set the working directory to the root of the repo.
```
cd /srv/docker/jira
```
List the available files in the backups directory.
```
ls -l backups
```

Specify a file to restore in the following format:

./scripts/app-restore.sh <backup-file-name>

For example:

./scripts/app-restore.sh 20170501T031500+0000.tar.gz

Uninstalling

Set the working directory to the root of the repo.
```
cd /srv/docker/jira
```
Remove the application stack.
```
docker-compose down
```
Delete the repo. Warning: this step is optional. If you delete the repo, all of your JIRA data, including backups, will be lost.
```
rm -rf /srv/docker/jira
```

ianharrier/docker-jira