Installs/Configures an instance of Atlassian Confluence.
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.
- RHEL/CentOS 6, 7
- Ubuntu 14.04, 16.04
The Atlassian Confluence Linux installer will automatically configure a bundled JRE.
If you prefer Confluence standalone installation, then you have to manage JDK/JRE 8
(Supported Platforms)
on this node. It can be done with java cookbook and appropricate attributes:
node.default['java']['jdk_version'] = "8"
include_recipe 'java'These attributes are under the node['confluence'] namespace.
| Attribute | Description | Type | Default |
|---|---|---|---|
| checksum | SHA256 checksum for Confluence install | String | auto-detected by library method |
| home_path | home directory for Confluence user | String | /var/atlassian/application-data/confluence |
| install_path | location to install Confluence | String | /opt/atlassian/confluence |
| install_type | Confluence install type - "installer", "standalone" | String | installer |
| url | URL for Confluence install | String | auto-detected by library method |
| user | user running Confluence | String | confluence |
| version | Confluence version to install | String | 6.1.2 |
--Notice:-- If ['confluence']['install_type'] is set to installer, then the installer will try to upgrade your Confluence instance located in ['confluence']['install_path'] (if it exists) to the ['confluence']['version'].
If you want to avoid an unexpected upgrade, just set or override ['confluence']['version'] attribute value to that of your current confluence version.
These attributes are under the node['confluence']['database'] namespace.
| Attribute | Description | Type | Default |
|---|---|---|---|
| host | FQDN or IP of database server ("127.0.0.1" automatically installs ['database']['type'] server) |
String | "127.0.0.1" |
| name | Confluence database name | String | confluence |
| password | Confluence database user password | String | changeit |
| port | Confluence database port | Fixnum | 3306 for MySQL, 5432 for PostgreSQL |
| type | Confluence database type - "mysql", "postgresql", or "hsqldb" | String | mysql |
| user | Confluence database user | String | confluence |
These attributes are under the node['confluence']['jvm'] namespace.
| Attribute | Description | Type | Default |
|---|---|---|---|
| minimum_memory | JVM minimum memory | String | 512m |
| maximum_memory | JVM maximum memory | String | 768m |
| maximum_permgen | JVM maximum PermGen memory | String | 256m |
| java_opts | additional JAVA_OPTS to be passed to Confluence JVM during startup | String | "" |
| bundled_jre | prefer JRE bundled with linux installer | Boolean | true |
These attributes are under the node['confluence']['autotune'] namespace. Autotune automatically determines appropriate settings for certain
attributes. This feature is inspired by the autotune recipe in the https://github.com/afklm/jira cookbook. This
initial version only supports JVM min and max memory size tuning.
There are several tuning types that can be set:
- 'mixed' - Confluence and DB run on the same system
- 'dedicated' - Confluence has the system all to itself
- 'shared' - Confluence shares the system with the DB and other applications
Total available memory is auto discovered using Ohai but can be overridden by setting your own value in kB.
| Attribute | Description | Type | Default |
|---|---|---|---|
| enabled | Whether or not to autotune settings. | Boolean | false |
| type | Type of tuning to apply. One of 'mixed', 'dedicated' and 'shared'. | String | mixed |
| total_memory | Total system memory to use for autotune calculations. | String | Ohai value |
These attributes are under the node['confluence']['tomcat'] namespace.
| Attribute | Description | Type | Default |
|---|---|---|---|
| port | Tomcat HTTP port | Fixnum | 8090 |
recipe[confluence]Installs/configures Atlassian Confluencerecipe[confluence::apache2]Installs/configures Apache 2 as proxy (ports 80/443)recipe[confluence::database]Installs/configures MySQL/Postgres server, database, and user for Confluencerecipe[confluence::linux_installer]Installs/configures Confluence via Linux installer"recipe[confluence::linux_standalone]Installs/configures Confluence via Linux standalone archive"recipe[confluence::tomcat_configuration]Configures Confluence's built-in Tomcatrecipe[confluence::crowd_sso]Configures user authentication with Crowd single sign-on
For security purposes it is recommended to use data bag for storing secrets like passwords and database credentials.
You can override any attributes from the ['confluence'] namespace using the
confluence/confluence data bag. It could be either encrypted or not
encrypted by your choice.
Example:
{
"id": "confluence",
"confluence": {
"database": {
"type": "postgresql",
"name": "confluence_db",
"user": "confluence_user",
"password": "confluence_db_password"
}
}
}Note - "confluence" nesting level is required!
These credentials will be used for your Confluence installation instead of appropriate attribute values.
Data bag's and item's names are optional and can be changed by overriding
attributes ['confluence']['data_bag_name'] and ['confluence']['data_bag_item']
The simplest method is via the default recipe, which uses node['confluence']['install_type'] to determine best method.
- Optionally (un)encrypted data bag or set attributes
knife data bag create confluenceknife data bag edit confluence confluence --secret-file=path/to/secret
- Add
recipe[confluence]to your node's run list.
Using individual recipes, you can use this cookbook to configure Confluence to fit your environment.
- Optionally (un)encrypted data bag or set attributes
knife data bag create confluenceknife data bag edit confluence confluence --secret-file=path/to/secret
- Add individual recipes to your node's run list.
This project exists thanks to all the people who contribute.
Thank you to all our backers!
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent
