Help Center

run ONLYOFFICE Docs Developer Edition and all the necessary infrastructure in a distributed manner;
This instruction describes how to use the Docker Compose tool on a single computer. To run containers in a distributed manner on several hosts please refer to the Docker Swarm documentation.
flexibly scale ONLYOFFICE Docs performance;
provide fault-tolerance and high availability of the application.

This guide will show you how to install ONLYOFFICE Docs to your machine using Docker Compose.

System requirements

CPU

dual core 2 GHz or better
RAM

4 GB or more
HDD

at least 40 GB of free space
SWAP

at least 4 GB, but depends of the host OS. More is better
OS

amd64 Linux distribution with kernel version 3.10 or later
Additional requirements
- Docker: any version supported by Docker team

Installing Docker Compose

Install docker-compose following the instructions that can be found here.

Downloading the Docker-DocumentServer repository

Download the latest version of the Docker-DocumentServer repository by executing the following command:

git clone https://github.com/ONLYOFFICE/Docker-DocumentServer

Once the repository is downloaded, go to the Docker-DocumentServer folder:

cd Docker-DocumentServer

Starting and using ONLYOFFICE Docs

To start ONLYOFFICE Docs execute the following command:

sudo docker-compose -f cluster.yml up -d

To scale ONLYOFFICE Docs execute the following command:

sudo docker-compose -f cluster.yml scale onlyoffice-documentserver=<container_number>

where container_number is a number of the ONLYOFFICE Docs containers running concurrently.

To stop ONLYOFFICE Docs use the following command:

sudo docker-compose -f cluster.yml down -v

Configuring ONLYOFFICE Docs

Using custom fonts

Mount the fonts folder from your local machine to the fonts folder within the onlyoffice-documentserver-data container. To do that:

open the cluster.yml file,
find the services -> onlyoffice-documentserver-data -> volumes section,
replace the - /usr/share/fonts string with the following one:
```
 - /your_local_fonts_folder:/usr/share/fonts
```

Setting up HTTPS

To use the HTTPS protocol you need to uncomment the following strings in the cluster.yml file:

- FORCE_SSL=true
- CERT_FOLDER=/certs/
- /app/onlyoffice/DocumentServer/data/certs/onlyoffice.pem:/certs/cert1.pem

Create the /app/onlyoffice/DocumentServer/data/certs/onlyoffice.pem file that contains a certificate and a private key.

When using CA certified certificates, the Private key (.key) and SSL certificate (.crt) are provided to you by the CA. When using self-signed certificates you need to generate these files yourself. Skip steps 1-3 in the following section if you have CA certified SSL certificates.

Generation of self signed certificates

Generation of self-signed SSL certificates involves a simple 3 step procedure

STEP 1: Create the server private key

openssl genrsa -out onlyoffice.key 2048

STEP 2: Create the certificate signing request (CSR)

openssl req -new -key onlyoffice.key -out onlyoffice.csr

STEP 3: Sign the certificate using the private key and CSR

openssl x509 -req -days 365 -in onlyoffice.csr -signkey onlyoffice.key -out onlyoffice.crt

STEP 4: Merge both the files

cp onlyoffice.crt onlyoffice.pem
cat onlyoffice.key >> onlyoffice.pem

Download Host on your own server Available for
Docker, Windows and Linux

Articles with the tag:

Changelog