- Overview
- Functionality
- Recommended System Requirements
- Running Docker Image
- Configuring Docker Image
- Installing ONLYOFFICE Document Server integrated with Community and Mail Servers
- ONLYOFFICE Document Server ipv6 setup
- Issues
- Project Information
- User Feedback and Support
ONLYOFFICE Document Server 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.
Starting from version 6.0, Document Server is distributed as ONLYOFFICE Docs. It has three editions. With this image, you will install the free Community version.
ONLYOFFICE Docs can be used as a part of ONLYOFFICE Workspace or with third-party sync&share solutions (e.g. Nextcloud, ownCloud, Seafile) to enable collaborative editing within their interface.
Important Please update docker-engine to latest version (20.10.21 as of writing this doc) before using it. We use ubuntu:22.04 as base image and it older versions of docker have compatibility problems with it
- ONLYOFFICE Document Editor
- ONLYOFFICE Spreadsheet Editor
- ONLYOFFICE Presentation Editor
- ONLYOFFICE Documents application for iOS
- Collaborative editing
- Hieroglyph support
- Support for all the popular formats: DOC, DOCX, TXT, ODT, RTF, ODP, EPUB, ODS, XLS, XLSX, CSV, PPTX, HTML
Integrating it with ONLYOFFICE Community Server you will be able to:
- view and edit files stored on Drive, Box, Dropbox, OneDrive, OwnCloud connected to ONLYOFFICE;
- share files;
- embed documents on a website;
- manage access rights to documents.
- RAM: 4 GB or more
- CPU: dual-core 2 GHz or higher
- Swap: at least 2 GB
- HDD: at least 2 GB of free space
- Distribution: 64-bit Red Hat, CentOS or other compatible distributive with kernel version 3.8 or later, 64-bit Debian, Ubuntu or other compatible distributive with kernel version 3.8 or later
- Docker: version 1.9.0 or later
sudo docker run -i -t -d -p 80:80 onlyoffice/documentserver
Use this command if you wish to install ONLYOFFICE Document Server separately. To install ONLYOFFICE Document Server integrated with Community and Mail Servers, refer to the corresponding instructions below.
All the data are stored in the specially-designated directories, data volumes, at the following location:
- /var/log/onlyoffice for ONLYOFFICE Document Server logs
- /var/www/onlyoffice/Data for certificates
- /var/lib/onlyoffice for file cache
- /var/lib/postgresql for database
To get access to your data from 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 \
-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/rabbitmq:/var/lib/rabbitmq \
-v /app/onlyoffice/DocumentServer/redis:/var/lib/redis \
-v /app/onlyoffice/DocumentServer/db:/var/lib/postgresql onlyoffice/documentserver
Normally, you do not need to store container data because the container's 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
To change the port, use the -p command. E.g.: to make your portal accessible via port 8080 execute the following command:
sudo docker run -i -t -d -p 8080:80 onlyoffice/documentserver
sudo docker run -i -t -d -p 443:443 \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data onlyoffice/documentserver
Access to the onlyoffice application can be secured using SSL so as to prevent unauthorized access. While a CA certified SSL certificate allows for verification of trust via the CA, a 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. Below the instructions on achieving this are provided.
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/tls.key
/app/onlyoffice/DocumentServer/data/certs/tls.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.
sudo docker run -i -t -d -p 80:80 -p 443:443 \
-e LETS_ENCRYPT_DOMAIN=your_domain -e LETS_ENCRYPT_MAIL=your_mail onlyoffice/documentserver
If you want to get and extend Let's Encrypt SSL Certificates automatically just set LETS_ENCRYPT_DOMAIN and LETS_ENCRYPT_MAIL variables.
Generation of self-signed SSL certificates involves a simple 3 step procedure.
STEP 1: Create the server private key
openssl genrsa -out tls.key 2048STEP 2: Create the certificate signing request (CSR)
openssl req -new -key tls.key -out tls.csrSTEP 3: Sign the certificate using the private key and CSR
openssl x509 -req -days 365 -in tls.csr -signkey tls.key -out tls.crtYou have now generated an SSL certificate that's valid for 365 days.
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 2048Out of the four files generated above, you need to install the tls.key, tls.crt and dhparam.pem files at the onlyoffice server. The CSR file is not needed, but do make sure you safely backup 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 tls.key file to only be readable by the owner.
mkdir -p /app/onlyoffice/DocumentServer/data/certs
cp tls.key /app/onlyoffice/DocumentServer/data/certs/
cp tls.crt /app/onlyoffice/DocumentServer/data/certs/
cp dhparam.pem /app/onlyoffice/DocumentServer/data/certs/
chmod 400 /app/onlyoffice/DocumentServer/data/certs/tls.keyYou are now just one step away from having our application secured.
Please refer 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's 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_PATHfile. Defaults tofalse - NODE_EXTRA_CA_CERTS: The NODE_EXTRA_CA_CERTS to extend CAs with the extra certificates for Node.js. Defaults to
/var/www/onlyoffice/Data/certs/extra-ca-certs.pem. - DB_TYPE: The database type. Supported values are
postgres,mariadb,mysql,mssqlororacle. Defaults topostgres. - 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 use. Should be existing on container startup.
- DB_USER: The new user name with superuser permissions for the database account.
- DB_PWD: The password set for the database account.
- AMQP_URI: The AMQP URI to connect to message broker server.
- AMQP_TYPE: The message broker type. Supported values are
rabbitmqoractivemq. Defaults torabbitmq. - 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.
- REDIS_SERVER_PASS: The Redis server password. The password is not set by default.
- 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 the JSON Web Token validation by the ONLYOFFICE Document Server. Defaults to
true. - JWT_SECRET: Defines the secret key to validate the JSON Web Token in the request to the ONLYOFFICE Document Server. 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 the token validation in the request body to the ONLYOFFICE Document Server. Defaults to
false. - WOPI_ENABLED: Specifies the enabling the wopi handlers. Defaults to
false. - ALLOW_META_IP_ADDRESS: Defines if it is allowed to connect meta IP address or not. Defaults to
false. - ALLOW_PRIVATE_IP_ADDRESS: Defines if it is allowed to connect private IP address or not. Defaults to
false. - USE_UNAUTHORIZED_STORAGE: Set to
trueif using selfsigned certificates for your storage server e.g. Nextcloud. Defaults tofalse - 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 Document Server. 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 administator mail address for Let's Encrypt certificate.
ONLYOFFICE Document Server is a part of ONLYOFFICE Community Edition that comprises also Community Server and Mail Server. To install them, follow these easy steps:
STEP 1: Create the onlyoffice network.
docker network create --driver bridge onlyofficeThen launch containers on it using the 'docker run --net onlyoffice' option:
STEP 2: Install MySQL.
Follow these steps to install MySQL server.
STEP 3: Generate JWT Secret
JWT secret defines the secret key to validate the JSON Web Token in the request to the ONLYOFFICE Document Server. You can specify it yourself or easily get it using the command:
JWT_SECRET=$(cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 12);
STEP 4: Install ONLYOFFICE Document Server.
sudo docker run --net onlyoffice -i -t -d --restart=always --name onlyoffice-document-server \
-e JWT_ENABLED=true \
-e JWT_SECRET=${JWT_SECRET} \
-e JWT_HEADER=AuthorizationJwt \
-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 \
onlyoffice/documentserverSTEP 5: Install ONLYOFFICE Mail Server.
For the mail server correct work you need to specify its hostname 'yourdomain.com'.
sudo docker run --init --net onlyoffice --privileged -i -t -d --restart=always --name onlyoffice-mail-server -p 25:25 -p 143:143 -p 587:587 \
-e MYSQL_SERVER=onlyoffice-mysql-server \
-e MYSQL_SERVER_PORT=3306 \
-e MYSQL_ROOT_USER=root \
-e MYSQL_ROOT_PASSWD=my-secret-pw \
-e MYSQL_SERVER_DB_NAME=onlyoffice_mailserver \
-v /app/onlyoffice/MailServer/data:/var/vmail \
-v /app/onlyoffice/MailServer/data/certs:/etc/pki/tls/mailserver \
-v /app/onlyoffice/MailServer/logs:/var/log \
-h yourdomain.com \
onlyoffice/mailserverThe additional parameters for mail server are available here.
To learn more, refer to the ONLYOFFICE Mail Server documentation.
STEP 6: Install ONLYOFFICE Community Server
sudo docker run --net onlyoffice -i -t -d --privileged --restart=always --name onlyoffice-community-server -p 80:80 -p 443:443 -p 5222:5222 --cgroupns=host \
-e MYSQL_SERVER_ROOT_PASSWORD=my-secret-pw \
-e MYSQL_SERVER_DB_NAME=onlyoffice \
-e MYSQL_SERVER_HOST=onlyoffice-mysql-server \
-e MYSQL_SERVER_USER=onlyoffice_user \
-e MYSQL_SERVER_PASS=onlyoffice_pass \
-e DOCUMENT_SERVER_PORT_80_TCP_ADDR=onlyoffice-document-server \
-e DOCUMENT_SERVER_JWT_ENABLED=true \
-e DOCUMENT_SERVER_JWT_SECRET=${JWT_SECRET} \
-e DOCUMENT_SERVER_JWT_HEADER=AuthorizationJwt \
-e MAIL_SERVER_API_HOST=${MAIL_SERVER_IP} \
-e MAIL_SERVER_DB_HOST=onlyoffice-mysql-server \
-e MAIL_SERVER_DB_NAME=onlyoffice_mailserver \
-e MAIL_SERVER_DB_PORT=3306 \
-e MAIL_SERVER_DB_USER=root \
-e MAIL_SERVER_DB_PASS=my-secret-pw \
-v /app/onlyoffice/CommunityServer/data:/var/www/onlyoffice/Data \
-v /app/onlyoffice/CommunityServer/logs:/var/log/onlyoffice \
-v /app/onlyoffice/CommunityServer/letsencrypt:/etc/letsencrypt \
-v /sys/fs/cgroup:/sys/fs/cgroup:rw \
onlyoffice/communityserverWhere ${MAIL_SERVER_IP} is the IP address for ONLYOFFICE Mail Server. You can easily get it using the command:
MAIL_SERVER_IP=$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' onlyoffice-mail-server)
Alternatively, you can use an automatic installation script to install the whole ONLYOFFICE Community Edition at once. For the mail server correct work you need to specify its hostname 'yourdomain.com'.
STEP 1: Download the Community Edition Docker script file
wget https://download.onlyoffice.com/install/opensource-install.shSTEP 2: Install ONLYOFFICE Community Edition executing the following command:
bash opensource-install.sh -md yourdomain.comOr, use docker-compose. For the mail server correct work you need to specify its hostname 'yourdomain.com'. Assuming you have docker-compose installed, execute the following command:
wget https://raw.githubusercontent.com/ONLYOFFICE/Docker-CommunityServer/master/docker-compose.groups.yml
docker-compose up -d(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.jsonfile 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
As a relatively new project Docker is being worked on and actively developed by its community. So it's recommended to use the latest version of Docker, because the issues that you encounter might have already been fixed with a newer Docker release.
The known Docker issue with ONLYOFFICE Document Server with rpm-based distributives is that sometimes the processes fail to start inside Docker container. Fedora and RHEL/CentOS users should try disabling selinux with setenforce 0. If it fixes the issue then you can either stick with SELinux disabled which is not recommended by RedHat, or switch to using Ubuntu.
Due to the operational characteristic, Document Server saves a document only after the document has been closed by all the users who edited it. To avoid data loss, you must forcefully disconnect the Document Server users when you need to stop Document Server in cases of the application update, server reboot etc. To do that, execute the following script on the server where Document Server is installed:
sudo docker exec <CONTAINER> documentserver-prepare4shutdown.sh
Please note, that both executing the script and disconnecting users may take a long time (up to 5 minutes).
Official website: https://www.onlyoffice.com
Code repository: https://github.com/ONLYOFFICE/DocumentServer
Docker Image: https://github.com/ONLYOFFICE/Docker-DocumentServer
License: GNU AGPL v3.0
Free version vs commercial builds comparison: https://github.com/ONLYOFFICE/DocumentServer#onlyoffice-document-server-editions
SaaS version: https://www.onlyoffice.com/cloud-office.aspx
If you have any problems with or questions about this image, please visit our official forum to find answers to your questions: forum.onlyoffice.com or you can ask and answer ONLYOFFICE development questions on Stack Overflow.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent