Example of a docker-based development setup for Atlassian Confluence

This is an example project aimed at demonstrating how to use the official Atlassian Confluence docker container (https://hub.docker.com/r/atlassian/confluence) when developing P2 apps for Server/Data Center.

The code base includes an example app created using atlas-create-confluence-plugin.

Note

To run this on Apple Silicon, please refer to the AppleSilicon branch

Quick demo

If you want to take it for a quick spin, clone this repository and run docker-compose up. This will start Atlassian Confluence (without the app installed). Once the docker container has started Confluence will become available on http://localhost:8080

To see the actual app installed, run atlas-mvn package in the root directory. This will compile the app and place the JAR file in ./target/quickreload.

QuickReload will detect the changes and install the app in your Confluence instance.

If you want to see the Confluence application logs and track the QuickReload installation, run docker-compose exec confluence tail -f -n 5000 /var/atlassian/application-data/confluence/logs/atlassian-confluence.log from the root directory.

Using it for your own app

To use this for developing your own app, you will need to copy the docker-compose.yml file and .docker folder.

Afterwards run

docker-compose up -d

Wait 1-2 minute(s) and open http://localhost:8080. You will need to go through the Confluence set-up process and provide a valid license. Configure the application as desired. Once you've finished configuring Confluence, you can install the app (and any updates) by running

atlas-mvn package

This will create a new JAR file in ./target/quickreload which will be picked up by QuickReload and installed in your Confluence instance.

I want the latest & greatest version of QuickReload

You can download the latest copy of QuickReload JAR to be included in the Docker file from the Atlassian public maven repository: https://packages.atlassian.com/artifactory/maven-atlassian-external/com/atlassian/labs/plugins/quickreload/

Debugging your app

The Confluence instance is started with JVM debugging enabled. You can connect your IDE to remote debugging on port 5005

In addition, you can check the Atlassian Confluence application log by running

docker-compose exec confluence tail -f -n 5000 /var/atlassian/application-data/confluence/logs/atlassian-confluence.log