Confluence Cookbook

Installs and configures Atlassian Confluence using custom resources.

Maintainers

This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you'd like to know more please visit sous-chefs.org or come chat with us on the Chef Community Slack in #sous-chefs.

Requirements

Platforms

• AlmaLinux 8, 9
• Amazon Linux 2023
• CentOS Stream 9
• Debian 12
• Fedora (latest)
• Oracle Linux 8, 9
• Red Hat Enterprise Linux 8, 9
• Rocky Linux 8, 9
• Ubuntu 22.04, 24.04

Chef

• Chef 16+

Cookbooks

None - this cookbook has no external cookbook dependencies.

Resources

• confluence_install - Downloads and installs Confluence
• confluence_config - Configures JVM and Tomcat settings
• confluence_service - Manages the systemd service

Quick Start

# Install Confluence
confluence_install 'confluence' do
  version '8.5.4'
end

# Configure Confluence
confluence_config 'confluence' do
  jvm_minimum_memory '1g'
  jvm_maximum_memory '4g'
end

# Create and start the service
confluence_service 'confluence' do
  action [:create, :enable, :start]
end

Usage Examples

Basic Installation

confluence_install 'confluence' do
  version '8.5.4'
end

confluence_config 'confluence' do
  jvm_minimum_memory '512m'
  jvm_maximum_memory '2g'
  tomcat_port '8090'
end

confluence_service 'confluence' do
  action [:create, :enable]
end

Behind a Reverse Proxy (HTTPS)

When running Confluence behind nginx, Apache, or HAProxy:

confluence_install 'confluence' do
  version '8.5.4'
end

confluence_config 'confluence' do
  jvm_minimum_memory '1g'
  jvm_maximum_memory '4g'
  tomcat_port '8090'
  tomcat_proxy_name 'confluence.example.com'
  tomcat_proxy_port '443'
  tomcat_scheme 'https'
  tomcat_secure true
end

confluence_service 'confluence' do
  action [:create, :enable, :start]
end

Custom Paths

confluence_install 'confluence' do
  version '8.5.4'
  install_path '/opt/confluence'
  home_path '/data/confluence'
  user 'atlassian'
  group 'atlassian'
end

confluence_config 'confluence' do
  install_path '/opt/confluence'
  home_path '/data/confluence'
  user 'atlassian'
  group 'atlassian'
  jvm_maximum_memory '4g'
end

confluence_service 'confluence' do
  install_path '/opt/confluence'
  home_path '/data/confluence'
  user 'atlassian'
  group 'atlassian'
  action [:create, :enable, :start]
end

Database Configuration

This cookbook does not manage database installation or configuration. You must set up your database separately using your preferred method:

• postgresql cookbook
• mysql cookbook
• External managed database (RDS, Cloud SQL, etc.)

Configure the database connection through Confluence's web-based setup wizard after installation.

Reverse Proxy Configuration

This cookbook does not manage reverse proxy configuration. Set up your reverse proxy separately using:

• nginx cookbook
• apache2 cookbook
• haproxy cookbook

Use the tomcat_proxy_name, tomcat_proxy_port, tomcat_scheme, and tomcat_secure properties on confluence_config to configure Confluence for reverse proxy operation.

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers!

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.