Installing ONLYOFFICE Docs Community Edition using Ansible

• OS: The ONLYOFFICE.documentserver Ansible role is used to install and configure ONLYOFFICE Docs on RHEL/CentOS or Debian/Ubuntu servers. This instruction is written for Ubuntu 18.04, 20.04
• At least two hosts:
  • Ansible control node with Ansible installed and configured.
  • One or more managed hosts (the machines where you want to install ONLYOFFICE Docs).

  To easily start working with Ansible, perform three easy steps on the Ansible control node:

  1. Install Ansible. You can refer to the official Ansible documentation
  2. Create an SSH key pair:

     ssh-keygen

  3. Add a public key to the managed hosts so that the control node can access them via SSH:

     ssh-copy-id username@managed_host1
     ssh-copy-id username@managed_host2
     

• Other requirements:
  • ONLYOFFICE Docs requires PostgreSQL, RabbitMQ and Redis server. They will be installed automatically after launching the playbook.
  • This role requires root access, so either run it in a playbook with a global become: yes, or invoke the role in your playbook:

    - hosts: documentserver
      roles:
        - role: ONLYOFFICE.documentserver
          become: yes
    

    The playbook example provided in Step1 contains become: yes for the ONLYOFFICE.documentserver role.

The actions below are performed on the Ansible control node. You will need to create a playbook, create a new inventory file or edit the existing one, install all roles specified in the playbook and then launch the playbook.

Step 1. Create a playbook

Create a new directory, if necessary:

mkdir ~/playbooks

Go to the directory:

cd ~/playbooks

Create a new playbook and open it for editing:

nano playbook.yml

Add the following contents:

- hosts: documentserver
  vars:
    postgresql_global_config_options:
    - option: listen_addresses
      value: "*"
    - option: unix_socket_directories
      value: '{{ postgresql_unix_socket_directories | join(",") }}'
    postgresql_hba_entries:
    - type: local
      database: all
      user: postgres
      auth_method: peer
    - type: local
      database: all
      user: all
      auth_method: peer 
    - type: host
      database: all
      user: all
      address: 127.0.0.1/32
      auth_method: md5
    - type: host
      database: all
      user: all
      address: ::1/128
      auth_method: md5
    - type: host
      database: all
      user: all
      address: 0.0.0.0/0
      auth_method: md5
    postgresql_databases:
    - name: "{{ db_server_name }}"
    postgresql_users:
    - name: "{{ db_server_user }}"
      password: "{{ db_server_pass }}"
    rabbitmq_users:
    - name: "{{ rabbitmq_server_user }}"
      password: "{{ rabbitmq_server_pass }}"
      vhost: "{{ rabbitmq_server_vpath }}"
      configure_priv: .*
      read_priv: .*
      write_priv: .*
      tags: administrator
    rabbitmq_users_remove: []
    redis_bind_interface: 0.0.0.0
  roles:
  - role: geerlingguy.postgresql
  - role: onlyoffice.rabbitmq
  - role: geerlingguy.redis
  - role: onlyoffice.documentserver
    become: yes

Save the file.

Step 2. Create an inventory file

Create a new inventory file and open it for editing:

nano inventory

Add the following content:

[documentserver]
managed_host1 ansible_user=root
managed_host2 ansible_user=root
managed_host3 ansible_user=root

Replace managed_host1, managed_host2, managed_host3, etc. with actual IP addresses or domain names of managed nodes where you want to install ONLYOFFICE Docs.

Save the file.

Alternatively, you can add this list of hosts to your default /etc/ansible/hosts file.

Step 3. Install the Ansible Roles for ONLYOFFICE Docs

Install all roles specified in the playbook using the following commands:

ansible-galaxy install onlyoffice.documentserver

ansible-galaxy install geerlingguy.postgresql

ansible-galaxy install onlyoffice.rabbitmq

ansible-galaxy install geerlingguy.redis

Step 4. Run the playbook

In the directory with the created playbook, run the following command:

ansible-playbook playbook.yml -i inventory

If your inventory file is located in a different directory, you need to specify the full path to the inventory file using the -i parameter. For example, if you add the [documentserver] list to the default hosts file, use the following command: ansible-playbook playbook.yml -i /etc/ansible/hosts

- hosts: documentserver
  become: true
  become_user: root
  tasks:
    - name: Update apt repo
      apt: update_cache=yes

After executing the playbook.yml, ONLYOFFICE Docs with all dependencies will be installed on all managed hosts specified in your inventory file.