puppeteer-confluence-setup

⚠️ This is not mean to be used for production instances.

A puppeteer based script and Docker image to automate the initial setup of Confluence for testing purposes.

After many years spinning up standalone instances of Confluence for testing purposes as part of my work at Comalatech, I created the project docker-confluence-for-testing to do that automagically inside a Docker container with the chance to run any Confluence version, on different external DB engines (not H2) and optionally using an external LDAP. The problem is that each time you spin up a new instance you have to manually go through the initial setup as Atlassian is yet to provide an unsupervised mechanism to perform that setup 🤦🏻‍♂️

I don't know how many times I have repeated the same process manually, but those days are over thanks to this script 😊

How does it work?

This script uses puppeteer in order to automate the following setup steps:

1. Installation type selection
2. License set up
3. Deployment Type selection (DC only)
4. Configuring Database
5. User Configuration setup
6. Disable Confluence Onboarding module
7. Setting Confluence base url to use 'localhost' as hostname (if it is not 'localhost' already)
8. Configuring OpenLDAP user directory (optional)

There are two ways this script can be used:

As a script inside a Docker image

...along with the docker-confluence-for-testing script. It should be used from there. But if you want, you can get the Docker image from Docker Hub.

As a node.js script for any Confluence image

Just clone this repo, install the dependencies and run it providing environment variables if you want/need:

npm i
[ENV1=VALUE1 ENV2=VALUE2] npm start

Environment variables available

VAR NAME	DEFAULT VALUE
PPTR_CONFLUENCE_BASE_URL	http://localhost:8090/confluence
PPTR_CONFLUENCE_LICENSE	A 10 user 3 hour Confluence DC license
PPTR_DB_USER	postgres
PPTR_DB_PASSWORD	postgres
PPTR_JDBC_URL	jdbc:postgresql://postgres:5432/confluence
PPTR_HEADLESS	false
PPTR_LDAP_CONFIG	true (set to false if OpenLDAP Docker is NOT used)
PPTR_LDAP_PORT	389

Versions supported

For now the script supports any version from 7.9.0 to 7.20.x for both server and DC

How long does it take?

These are the benchmarks to complete the setup in different Confluence version:

Confluence DC Version	Time taken to complete setup
7.9.0	155.673 s
7.13.0 (LTS)	182.541 s
7.19.0 (LTS)	182.927 s
7.20.0	186.118 s

⚠️ Note how each newer version steadily requires more time to complete the same process.