Ansible Role for Collabora Online

This guide explains how to install and set up Collabora Online CODE on your system.

GitHub	GitLab	Downloads	Version

Example Playbook

Here’s a simple example from the file molecule/default/converge.yml, which is tested regularly:

---
- name: Setup Collabora Online
  hosts: all
  become: true
  gather_facts: true

  roles:
    - role: robertdebock.collabora_online

Before running this, the machine needs to be set up as shown in molecule/default/prepare.yml:

---
- name: Prepare System
  hosts: all
  become: true
  gather_facts: false

  roles:
    - role: robertdebock.bootstrap
    - role: robertdebock.ca_certificates
    - role: robertdebock.users
      users_groups:
        - name: cool
      users:
        - name: cool
          group: cool
          home: /opt/cool
          shell: /usr/sbin/nologin
          system: true

For a more detailed guide, see this link.

Role Variables

You can adjust the default settings found in defaults/main.yml:

---
# Default settings for Collabora Online

# Type of installation; options: "code" or "licensed".
collabora_online_type: code

# Required version if "LICENSED" is chosen.
collabora_online_version: "6.4"

# Required if using "licensed" on RHEL; get this from the Collabora website.
# collabora_online_secret_key: "abc-def-ghi-jkl-mno"

# Allowed languages.
# collabora_online_allowed_languages: "de_DE en_GB en_US es_ES fr_FR it nl pt_BR pt_PT ru"

# Manage SSL settings: "false" or "true".
collabora_online_ssl_enabled: "false"

# SSL settings used if `collabora_online_ssl_enabled` is "true".
collabora_online_ssl_cert: /etc/coolwsd/coolwsd.crt
collabora_online_ssl_key: /etc/coolwsd/coolwsd.key
collabora_online_ssl_ca: /etc/coolwsd/coolwsd.keycrt
collabora_online_ciphers: "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH"

# Manage mounting feature: "false" or "true".
collabora_online_mount_jail_tree: "true"

# Set the log level; options: 0-8, or use "fatal", "critical", "error", "warning", "notice", "information", "debug", "trace".
collabora_online_log_level: warning

# Admin console username.
collabora_online_admin_username: "admin"

# Admin console password.
collabora_online_admin_password: "50m3-53cu23-p455w02d."

collabora_online_configuration_template: "coolwsd.xml.j2"

Requirements

Make sure to install the pip packages found in requirements.txt.

State of Used Roles

This role relies on some other roles for system preparation. You can set up your system differently if you wish.

Requirement	GitHub	GitLab
robertdebock.bootstrap
robertdebock.ca_certificates
robertdebock.users

Context

This role is part of many related roles. Check out the documentation for more information.

Here’s a visual overview of the related roles:

Compatibility

This role has been tested with the following container images:

You need at least Ansible version 2.12. Testing has been done with:

• The previous version.
• The current version.
• The development version.

If you encounter issues, please report them on GitHub.

License

This project is licensed under Apache-2.0.

Author Information

This role was created by robertdebock. If you’d like to support my work, please consider sponsoring me.