Home
Docs
Installation and configuration
Community
Docker version
Installing ONLYOFFICE Docs for Docker on a local server

Installing ONLYOFFICE Docs for Docker on a local server

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 in 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 Docker version to your machine.

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 on 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 ONLYOFFICE Docs

You need the latest Docker version installed. If you do not have it, please see the Installation section on Docker website to learn how to get it.

Docker specifies Google DNS servers by default. If your ONLYOFFICE Docs is not going to have access to the Internet, we recommend that you change the default Docker DNS address to the address of your local DNS server. To do that, go to the /etc/default/docker file and change the IP address in the following line to the IP address of a DNS server in your local network:

docker_OPTS="--dns 8.8.8.8"

For the RPM based operating systems like CentOS:

Create the /etc/docker/daemon.json configuration file with the following contents:
```
{ "dns" : [ "8.8.8.8" ] }
```
Restart the Docker service:
```
sudo systemctl restart docker.service
```

After you have Docker installed, run it and execute the following command:

sudo docker run -i -t -d -p 80:80 --restart=always -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver

Important Starting from version 7.2, we added a random generation of JWT secret. If JWT secret is not specified with the environment variable, it leads to its re-generation during every VMs or physical server reboot, so there might be problems in integrations. To avoid this issue, specify your own value in -e JWT_SECRET=my_jwt_secret.

If you are not going to use JWT in your installation, use -e JWT_ENABLED=false.

Use this command if you wish to install ONLYOFFICE Docs separately. To install ONLYOFFICE Docs integrated with ONLYOFFICE Workspace and ONLYOFFICE Mail, refer to the corresponding instructions below.

By default, ONLYOFFICE Docs listens to the incoming connections using port 80. Starting from version 4.3, you can change the port for ONLYOFFICE Docs if you plan to use it instead of the default one. This can be easily done by changing the mapping port during the installation:

sudo docker run -i -t -d -p <PORT_NUMBER>:80 --restart=always -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver

Where <PORT_NUMBER> is the number of port you want ONLYOFFICE Docs to use.

This will install ONLYOFFICE Docs and all the dependencies it needs (the list of what is being done by the script can be found here).

Storing data outside containers

All the data are stored in the specially-designated directories, data volumes, at the following location:

/var/log/onlyoffice for ONLYOFFICE Docs logs
/var/www/onlyoffice/Data for certificates
/var/lib/onlyoffice for file cache
/var/lib/postgresql for database

We recommend We strongly recommend that you store the data outside the Docker containers on the host machine as it allows you to easily update ONLYOFFICE Docs once the new version is released without losing your data.

To get access to your data located outside the container, you need to mount the volumes. It can be done by specifying the -v option in the docker run command.

sudo docker run -i -t -d -p 80:80 --restart=always \
    -v /app/onlyoffice/DocumentServer/logs:/var/log/onlyoffice  \
    -v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data  \
    -v /app/onlyoffice/DocumentServer/lib:/var/lib/onlyoffice \
    -v /app/onlyoffice/DocumentServer/db:/var/lib/postgresql -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver

Please note, that in case you are trying to mount the folders which are not yet created, these folders will be created but the access to them will be limited. You will need to change their access rights manually.

Normally, you do not need to store container data because the container operation does not depend on its state. Saving data will be useful:

for easy access to container data, such as logs;
to remove the limit on the size of the data inside the container;
when using services launched outside the container such as PostgreSQL, Redis, RabbitMQ.

Running ONLYOFFICE Docs using HTTPS

sudo docker run -i -t -d -p 443:443 --restart=always \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver

Access to the ONLYOFFICE application can be secured using SSL to prevent unauthorized access. While a CA certified SSL certificate allows for verification of trust via the CA, self-signed certificates can also provide an equal level of trust verification as long as each client takes some additional steps to verify the identity of your website. The instructions on achieving this are provided below.

To secure the application via SSL, basically two things are needed:

Private key (.key)
SSL certificate (.crt)

So you need to create and install the following files:

/app/onlyoffice/DocumentServer/data/certs/onlyoffice.key
/app/onlyoffice/DocumentServer/data/certs/onlyoffice.crt

When using CA certified certificates (e.g., Let's Encrypt), these files are provided to you by the CA. If you are using self-signed certificates, you need to generate these files yourself.

Switching ONLYOFFICE Docs to HTTPS using certbot

The easiest way to switch ONLYOFFICE Docs to HTTPS is to automatically get Let's Encrypt SSL Certificates using certbot.

Run the ONLYOFFICE Docs Docker container, specifying ports 80 and 443 and setting your own values for the variables:

sudo docker run -i -t -d -p 80:80 -p 443:443 --restart=always \
    -e LETS_ENCRYPT_DOMAIN=yourdomain.com -e LETS_ENCRYPT_MAIL=email@example.com -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver

Where:

LETS_ENCRYPT_DOMAIN - a domain name to use for the certificate.
LETS_ENCRYPT_MAIL - an email used for registration and recovery contact.

The letsencrypt.org CA-signed certificate will be automatically generated and installed to your server. Now, your ONLYOFFICE Docs should be available at the https://yourdomain.com address.

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

You have now generated an SSL certificate that's valid for 365 days.

Strengthening the server security

This section provides you with instructions to strengthen your server security.

To achieve this, you need to generate stronger DHE parameters.

openssl dhparam -out dhparam.pem 2048

Installation of the SSL certificates

Out of the four files generated above, you need to install the onlyoffice.key, onlyoffice.crt and dhparam.pem files at the onlyoffice server. The CSR file is not needed, but do make sure you safely back up the file (in case you ever need it again).

The default path that the onlyoffice application is configured to look for the SSL certificates is at /var/www/onlyoffice/Data/certs, this can however be changed using the SSL_KEY_PATH, SSL_CERTIFICATE_PATH and SSL_DHPARAM_PATH configuration options.

The /var/www/onlyoffice/Data/ path is the path of the data store, which means that you have to create a folder named certs inside /app/onlyoffice/DocumentServer/data/ and copy the files into it and as a measure of security you will update the permission on the onlyoffice.key file to only be readable by the owner.

mkdir -p /app/onlyoffice/DocumentServer/data/certs
cp onlyoffice.key /app/onlyoffice/DocumentServer/data/certs/
cp onlyoffice.crt /app/onlyoffice/DocumentServer/data/certs/
cp dhparam.pem /app/onlyoffice/DocumentServer/data/certs/
chmod 400 /app/onlyoffice/DocumentServer/data/certs/onlyoffice.key

And restart Docker container:

sudo docker restart {{DOCUMENT_SERVER_ID}}

You are now just one step away from having our application secured.

Available configuration parameters

Please refer to the docker run command options for the --env-file flag, where you can specify all required environment variables in a single file. This will save you from writing a potentially long docker run command.

Below is the complete list of parameters that can be set using environment variables.

ONLYOFFICE_HTTPS_HSTS_ENABLED: Advanced configuration option for turning off the HSTS configuration. Applicable only when SSL is in use. Defaults to true.
ONLYOFFICE_HTTPS_HSTS_MAXAGE: Advanced configuration option for setting the HSTS max-age in the onlyoffice NGINX vHost configuration. Applicable only when SSL is in use. Defaults to 31536000.
SSL_CERTIFICATE_PATH: The path to the SSL certificate to use. Defaults to /var/www/onlyoffice/Data/certs/tls.crt.
SSL_KEY_PATH: The path to the SSL certificate private key. Defaults to /var/www/onlyoffice/Data/certs/tls.key.
SSL_DHPARAM_PATH: The path to the Diffie-Hellman parameter. Defaults to /var/www/onlyoffice/Data/certs/dhparam.pem.
SSL_VERIFY_CLIENT: Enable verification of client certificates using the CA_CERTIFICATES_PATH file. Defaults to false.
DB_TYPE: The database type. Supported values are postgres, mariadb or mysql. Defaults to postgres.
DB_HOST: The IP address or the name of the host where the database server is running.
DB_PORT: The database server port number.
DB_NAME: The name of a database to be created on the image startup.
DB_USER: The new username with superuser permissions for the database account.
DB_PWD: The password set for the database account.
AMQP_URI: The AMQP URI to connect to the message broker server.
AMQP_TYPE: The message broker type. Supported values are rabbitmq or activemq. Defaults to rabbitmq.
REDIS_SERVER_HOST: The IP address or the name of the host where the Redis server is running.
REDIS_SERVER_PORT: The Redis server port number.
NGINX_WORKER_PROCESSES: Defines the number of NGINX worker processes.
NGINX_WORKER_CONNECTIONS: Sets the maximum number of simultaneous connections that can be opened by a NGINX worker process.
SECURE_LINK_SECRET: Defines secret for the nginx config directive secure_link_md5. Defaults to random string.
JWT_ENABLED: Specifies the enabling of the JSON web token validation by ONLYOFFICE Docs. Defaults to true.
JWT_SECRET: Defines the secret key to validate the JSON web token in the request to ONLYOFFICE Docs. Defaults to random value.
JWT_HEADER: Defines the HTTP header that will be used to send the JSON web token. Defaults to Authorization.
JWT_IN_BODY: Specifies the enabling of the token validation in the request body to the ONLYOFFICE Docs. Defaults to false.
WOPI_ENABLED: Specifies the enabling of the wopi handlers. Defaults to false.
USE_UNAUTHORIZED_STORAGE: Set to true if using self-signed certificates for your storage server, e.g. Nextcloud. Defaults to false.
GENERATE_FONTS: When true, regenerates fonts list and the fonts thumbnails etc. at each start. Defaults to true.
METRICS_ENABLED: Specifies the enabling StatsD for ONLYOFFICE Docs. Defaults to false.
METRICS_HOST: Defines StatsD listening host. Defaults to localhost.
METRICS_PORT: Defines StatsD listening port. Defaults to 8125.
METRICS_PREFIX: Defines StatsD metrics prefix for backend services. Defaults to ds..
LETS_ENCRYPT_DOMAIN: Defines the domain for Let's Encrypt certificate.
LETS_ENCRYPT_MAIL: Defines the domain administrator mail address for Let's Encrypt certificate.

Installing ONLYOFFICE Docs integrated with ONLYOFFICE Workspace and ONLYOFFICE Mail

ONLYOFFICE Docs is a part of ONLYOFFICE Workspace that comprises also ONLYOFFICE Community Server, ONLYOFFICE Control Panel and ONLYOFFICE Mail. In case you want to install all of them and integrate with each other, read these instructions.

Alternative ways to install ONLYOFFICE Docs

Alternatively, you can use an automatic installation script to install the whole Workspace at once. For the mail server to work correctly, you need to specify its hostname yourdomain.com.

STEP 1: Download the installation script file

Execute the following command:

wget https://download.onlyoffice.com/install/workspace-install.sh

STEP 2: Install Workspace

Run the following command to do that:

bash workspace-install.sh -md yourdomain.com

Or you can use docker-compose to install ONLYOFFICE Docs. See the instructions here on how to do that.

ONLYOFFICE Docs ipv6 setup

Works and is supported only for Linux hosts

Docker does not currently provide ipv6 addresses to containers by default. This function is experimental now.

To set up interaction via ipv6, you need to enable support for this feature in your Docker. For this you need:

create the /etc/docker/daemon.json file with the following content:
```
{
"ipv6": true,
"fixed-cidr-v6": "2001:db8:abc1::/64"
}
```
restart docker with the following command: systemctl restart docker

After that, all running containers receive an ipv6 address and have an inet6 interface.

You can check your default bridge network and see the field there EnableIPv6=true. A new ipv6 subnet will also be added.

For more information, visit the official Docker manual site.

Watch video

How to deploy ONLYOFFICE Docs on your server using Docker

Learn how to get powerful online editors ONLYOFFICE Docs ready on your server using Docker. It is super easy and won't take more than a couple of minutes!

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

Get it now Use in the cloud