onlyoffice / ansible-role-documentserver

Ansible Role Document Server

Ansible Role: ONLYOFFICE Document Server

Installs and configures ONLYOFFICE Document Server on RHEL/CentOS or Debian/Ubuntu servers.

Requirements

Installation requires PostgreSQL, RabbitMQ and Redis server in the system or network. Also this role requires root access, so either run it in a playbook with a global become: yes, or invoke the role in your playbook like:

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

Role Variables

Available variables are listed below, along with default values (see defaults/main.yml):

ds_port: ""

The port where documentserver is running, if you do not set this variable, documentserver is will be runned by default on port 80.

db_server_host: localhost

The IP address or the name of the host where the PostgreSQL server is running.

db_server_name: onlyoffice

The name of a PostgreSQL database to be created on the image startup.

db_server_user: onlyoffice

The new user name with superuser permissions for the PostgreSQL account.

db_server_pass: onlyoffice

The password set for the PostgreSQL account.

package_name: onlyoffice-documentserver

The package name of the ONLYOFFICE Document Server.

package_state: latest | present

The package state of the ONLYOFFICE Document Server. If set to latest (default), a upgrade will be performed!

redis_server_host: localhost

The IP address or the name of the host where the Redis server is running.

redis_server_port: 6379

The Redis server port number.

rabbitmq_server_host: localhost

The IP address or the name of the host where the RabbitMQ server is running.

rabbitmq_server_user: guest

The new user name for the RabbitMQ account.

rabbitmq_server_pass: guest

The password set for the RabbitMQ account.

rabbitmq_server_vpath: /

The virtual path for the RabbitMQ server.

proto: http

The option to add ssl configuration or not.

jwt_enabled: true

The option for enable or disable JWT token. Enabled by default

jwt_secret: ""

The custom secret set for jwt option. Random value by default

jwt_header: ""

The custom header set for jwt option.

key_file: "~/certs/tls.key"

The path to the key file.

cert_file: "~/certs/tls.crt"

The path to the certificate file.

cluster_mode: false

The option to enable or disable cluster mode.

start_example: false

The option for starting example service after install.

package_url: "" 

The option for being able to install the package by URL.

Dependencies

None.

Overwriting config values

The values in the local.json file can be redefined. To do this, you need to override the necessary values in the vars/main.yml file in the onlyoffice_local_json: {} field.

Example Playbook

- hosts: all
  become: true
  vars:
    postgresql_global_config_options:
      - option: listen_addresses
        value: "*"
      - option: unix_socket_directories
        value: '{{ postgresql_unix_socket_directories | join(",") }}'
      - option: log_directory
        value: 'log'

    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:
      - user: "{{ 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:
    - geerlingguy.postgresql
    - ONLYOFFICE.rabbitmq
    - geerlingguy.redis
    - ONLYOFFICE.documentserver

License

GNU AGPL v3.0

Author Information

This role was created by ONLYOFFICE.

ansible-role-documentserver's Issues

onlyoffice-documentserver switched from supervisord to systemd

The Debian packages of onlyoffice-documentserver use systemd to manage the documentserver processes these days. The handlers in handlers/main.yml have to be adjusted accordingly.

Move to Ansible Molecule testing

Use Molecule for testing the role.

Add SSL configure

JWT settings not honored by Debian package

Thanks for adding support to configure JWT settings in the role (in #38). Unfortunately, the tasks that configure the debconf values don't have any effect at the moment, as they're run (in line 136-166) after the Debian package is run (in line 93).

Install documentserver task fails on Ubuntu 18.04

The --force-yes apt flag is no longer supported in Ubuntu 18.04 which results in the failing of the "Install documentserver" task. In fact this is probably a general Ansible problem, but should this role be changed in order to address this problem?

no `json` found in $PATH

The Debian tasks depend on a binary called json (provided by the NPM json module) in your $PATH. Running the playbook on Debian results in the Set up ... tasks failing du to json not being available.

I were able to fix this locally by running the following commands:

npm install -g json
ln -s /usr/local/lib/npm/bin/json /usr/local/bin/json

Add ubuntu 18.04 test

Wrong supervisor group name `onlyoffice-documentserver` in `handlers/main.yml`

Hello,

the used supervisorctl group name onlyoffice-documentserver in handlers/main.yml is wrong. The correct group name would be ds. There's already an open pull request (#10) to fix this. We tested it locally and indeed it works as expected. Would be nice if you could merge the PR.

Escape configure Redis and RabbitMQ connection directley

Use debconf params here to setup Redis and RabbitMQ connection:
https://github.com/ONLYOFFICE/ansible-role-documentserver/blob/master/tasks/Debian.yml#L82
https://github.com/ONLYOFFICE/ansible-role-documentserver/blob/master/tasks/Debian.yml#L87
https://github.com/ONLYOFFICE/ansible-role-documentserver/blob/master/tasks/Debian.yml#L92

Increase gpg key lenght

Add DocumentServer licensing description

Add support ds v5.2

Update test/example

1. Add 'nodejs_install_npm_user: root' to your vars section. Otherwise node tried to install on the remote box as the same user that is running the script. As this should be a server, this make the install happen.

2. Rabbit is not starting on reboot. again, to your vars section add the following line to correct: 'rabbitmq_enabled: yes'

Increase "Quality Score" on Ansible Galaxy

Remove yamllint and ansible-lint warnings. See details here