Installing ONLYOFFICE Docs for Debian, Ubuntu, and derivatives

Introduction

Community Edition allows you to install ONLYOFFICE Docs on your local server and integrate online editors with ONLYOFFICE collaboration platform or other popular systems.

ONLYOFFICE Docs is an online office suite comprising viewers and editors for texts, spreadsheets and presentations, fully compatible with Office Open XML formats: .docx, .xlsx, .pptx and enabling collaborative editing in real time.

Functionality

  • Document Editor
  • Spreadsheet Editor
  • Presentation Editor
  • Mobile web viewers
  • Collaborative editing
  • Hieroglyph support
  • Support for all the popular formats: DOC, DOCX, TXT, ODT, RTF, ODP, EPUB, ODS, XLS, XLSX, CSV, PPTX, HTML

See the detailed list of features available for ONLYOFFICE Docs Community Edition.

Using it within ONLYOFFICE Workspace, you will be able to:

  • share files;
  • manage access rights to documents;
  • embed documents on a website;
  • view and edit files stored on Drive, Box, Dropbox, OneDrive, OwnCloud connected to ONLYOFFICE.

This guide will show you how to install ONLYOFFICE Docs Community Edition Linux version to your machine.

System requirements
  • CPU: dual core 2 GHz or better
  • RAM: at least 2 GB, but depends on the host OS. More is better
  • HDD: at least 40 GB of free space
  • SWAP: at least 4 GB, but depends on the host OS. More is better
  • OS: 64-bit Debian, Ubuntu or other compatible distribution with kernel version 3.13 or later
  • Additional requirements
    • PostgreSQL: version 12.9 or later
    • NGINX: version 1.3.13 or later
    • libstdc++6: version 4.8.4 or later
    • RabbitMQ

Installing ONLYOFFICE Docs

Installation with Debian based distributives also requires the presence of libstdc++6, NGINX and PostgreSQL in the system.

All the necessary instructions for these components and their dependencies' installation can be found at their official websites.

There are other dependencies installed together with ONLYOFFICE Docs:

  • libcurl3
  • libxml2
  • fonts-dejavu
  • fonts-liberation
  • ttf-mscorefonts-installer
  • fonts-crosextra-carlito
  • fonts-takao-gothic
  • fonts-opensymbol

These dependencies are installed automatically when you use Ubuntu 14.04 LTS or later. Earlier distributions might require their manual installation.

Installing dependencies

ONLYOFFICE Docs uses NGINX and PostgreSQL as database. Dependencies found in the system repository will be installed automatically at ONLYOFFICE Docs installation using the apt-get install command.

Installing and configuring PostgreSQL:

Install the PostgreSQL version included in your version of Ubuntu:

sudo apt-get install postgresql
If you want to install some other PostgreSQL version from the PostgreSQL Repository, please see the official PostgreSQL documentation for more detail on that.

After PostgreSQL is installed, create the PostgreSQL database and user:

The database user must have the onlyoffice name. You can specify any password.
sudo -i -u postgres psql -c "CREATE USER onlyoffice WITH PASSWORD 'onlyoffice';"
sudo -i -u postgres psql -c "CREATE DATABASE onlyoffice OWNER onlyoffice;"

Installing rabbitmq:

sudo apt-get install rabbitmq-server
Ubuntu distributives prior to 14.04 LTS might require some other dependencies to be installed.

Ubuntu 18.04 will require to install nginx-extras. This is done using the command:

sudo apt-get install nginx-extras
Changing the default ONLYOFFICE Docs port

By default, ONLYOFFICE Docs listens for the incoming connections using port 80. Starting with version 4.3 you can change the port for ONLYOFFICE Docs if you plan to use it instead of the default one.

If you are going to change the default port, make sure that it is open for the incoming/outgoing connections. See the complete list of the ports used by ONLYOFFICE Docs.

To do that, you will need to change the default port for the debconf system, running the command:

echo onlyoffice-documentserver onlyoffice/ds-port select <PORT_NUMBER> | sudo debconf-set-selections

Please write the port number instead of the <PORT_NUMBER> in the above command.

Warning If you want to change the ONLYOFFICE Docs protocol to HTTPS, do not change the port to 443, but use this instruction instead.

There are additional options which can be used for ONLYOFFICE Docs installation. Please read this section for more information on them.

After that, you can continue with ONLYOFFICE Docs installation.

Guide on installing ONLYOFFICE Docs

Add GPG key:

mkdir -p -m 700 ~/.gnupg
curl -fsSL https://download.onlyoffice.com/GPG-KEY-ONLYOFFICE | gpg --no-default-keyring --keyring gnupg-ring:/tmp/onlyoffice.gpg --import
chmod 644 /tmp/onlyoffice.gpg
sudo chown root:root /tmp/onlyoffice.gpg
sudo mv /tmp/onlyoffice.gpg /usr/share/keyrings/onlyoffice.gpg

Add ONLYOFFICE Docs repository:

echo "deb [signed-by=/usr/share/keyrings/onlyoffice.gpg] https://download.onlyoffice.com/repo/debian squeeze main" | sudo tee /etc/apt/sources.list.d/onlyoffice.list
While the APT package is built against Debian Squeeze, it is compatible with a number of Debian derivatives (including Ubuntu) which means you can use the same repository across all these distributions.

When installing ONLYOFFICE Docs on Debian, add the contrib component to /etc/apt/sources.list. To learn more, you can refer to the Debian documentation.

Update the package manager cache:

sudo apt-get update

Install mscorefonts:

sudo apt-get install ttf-mscorefonts-installer

Install ONLYOFFICE Docs

sudo apt-get install onlyoffice-documentserver
During the installation process, you will be asked to provide a password for the onlyoffice PostgreSQL user. Please enter the onlyoffice password that you have specified when configuring PostgreSQL.

After that, ONLYOFFICE Docs will be run as a process. The package will be updated just like any other deb package.

Now you can enter http://localhost in your browser address bar to open the ONLYOFFICE Docs welcome page, where you will find further instructions on how to enable document examples or integrate online editors into your web application using the provided API.

Running ONLYOFFICE Docs using HTTPS

In most cases accessing the portal via HTTPS protocol is much more secure than via HTTP which is used by default. You can easily run ONLYOFFICE Docs using secure connection. Please see the details here to learn more on how this can be done.

Additional information: more options for ONLYOFFICE Docs installation

The installation of ONLYOFFICE Docs allows the use of more debconf options, which might be very helpful in case you plan installing it to more than one server or in some other cases.

These options include:

  • PostgreSQL database options

    • Set PostgreSQL database host address (replacing <DB_HOST> with the actual address of the PostgreSQL server installed):

      echo onlyoffice-documentserver onlyoffice/db-host string <DB_HOST> | sudo debconf-set-selections

    • Set PostgreSQL database username (replacing <DB_USER> with the actual name of the user with the appropriate PostgreSQL database rights):

      echo onlyoffice-documentserver onlyoffice/db-user string <DB_USER> | sudo debconf-set-selections

    • Set PostgreSQL database user password (replacing <DB_PASSWORD> with the actual password of the user with the appropriate PostgreSQL database rights):

      echo onlyoffice-documentserver onlyoffice/db-pwd password <DB_PASSWORD> | debconf-set-selections

    • Set PostgreSQL database name (replacing <DB_NAME> with the actual PostgreSQL database name):

      echo onlyoffice-documentserver onlyoffice/db-name string <DB_NAME> | sudo debconf-set-selections
  • RabbitMQ options

    • Set RabbitMQ host address (replacing <RABBITMQ_HOST> with the actual address of RabbitMQ installed):

      echo onlyoffice-documentserver onlyoffice/rabbitmq-host string <RABBITMQ_HOST> | sudo debconf-set-selections

    • Set RabbitMQ username (replacing <RABBITMQ_USER> with the actual name of the user with the appropriate RabbitMQ rights):

      echo onlyoffice-documentserver onlyoffice/rabbitmq-user string <RABBITMQ_USER> | sudo debconf-set-selections

    • Set RabbitMQ user password (replacing <RABBITMQ_PWD> with the actual password of the user with the appropriate RabbitMQ rights):

      echo onlyoffice-documentserver onlyoffice/rabbitmq-pwd password <RABBITMQ_PWD> | sudo debconf-set-selections
  • JWT options

    You can use debconf-set-selections to disable the overwriting of the custom values in the local.json file after updating ONLYOFFICE Docs.

    • Enable JSON Web Tokens (JWT):

      echo onlyoffice-documentserver onlyoffice/jwt-enabled boolean true | sudo debconf-set-selections

    • Set a JWT secret key by replacing <JWT_SECRET> with your own value:

      echo onlyoffice-documentserver onlyoffice/jwt-secret password <JWT_SECRET> | sudo debconf-set-selections

Host ONLYOFFICE Docs on your own server or use it in the cloud

Get it nowUse in the cloud
Article with the tag:
Browse all tags