jiriks74/Docker-DocumentServer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1b9dc9b4ba
Docker-DocumentServer/README.md
Jiří Štefka 1b9dc9b4ba
Update README.md
2022-09-21 02:31:17 +02:00

26 KiB
Raw Blame History

NOW WORKING FOR amd64 and arm64 natively!

Docker Pulls Docker Stars Docker Size

GitHub Stars GitHub Forks

This repository is based on the official Dockerfile and docker-compose.yml files with all the needed files as well

Usage

docker-compose with prebuilt image (recommended)

  • Docker will pull the correct architecture automatically
  • Below in Details you'll find a docker-compose.yml templete. To use it, make a directory where data from the container will be saved, create docker-compose.yml file in it and put the template from below in it. Then modify the template to your needs.
version: '2'
services:
  onlyoffice-documentserver:
    image: jiriks74/onlyoffice-documentserver:latest
    container_name: onlyoffice-documentserver
    depends_on:
      - onlyoffice-postgresql
      - onlyoffice-rabbitmq
    environment:
      - DB_TYPE=postgres
      - DB_HOST=onlyoffice-postgresql
      - DB_PORT=5432
      - DB_NAME=onlyoffice
      - DB_USER=onlyoffice
      - AMQP_URI=amqp://guest:guest@onlyoffice-rabbitmq
      # Uncomment strings below to enable the JSON Web Token validation.
      #- JWT_ENABLED=true
      #- JWT_SECRET=secret
      #- JWT_HEADER=AuthorizationJwt
      #- JWT_IN_BODY=true
      # Uncomment the line below to set larger file limits (about 1GB)
      #- LARGER_FILE_LIMITS=true
    ports:
      - '80:80'
      - '443:443'
    stdin_open: true
    restart: always
    stop_grace_period: 120s
    volumes:
       # Uncomment the line below to get access to the slide themes directory.
       # To use the themes, copy them to the slideThemes directory and run `docker exec -it <container-name> /usr/bin/documentserver-generate-allfonts.sh`
       #- ./slideThemes:/var/www/onlyoffice/documentserver/sdkjs/slide/themes/src
       - /var/www/onlyoffice/Data
       - /var/log/onlyoffice
       - /var/lib/onlyoffice/documentserver/App_Data/cache/files
       - /var/www/onlyoffice/documentserver-example/public/files
       - /usr/share/fonts
       
  onlyoffice-rabbitmq:
    container_name: onlyoffice-rabbitmq
    image: rabbitmq
    restart: always
    expose:
      - '5672'

  onlyoffice-postgresql:
    container_name: onlyoffice-postgresql
    image: postgres:9.5
    environment:
      - POSTGRES_DB=onlyoffice
      - POSTGRES_USER=onlyoffice
      - POSTGRES_HOST_AUTH_METHOD=trust
    restart: always
    expose:
      - '5432'
    volumes:
      - postgresql_data:/var/lib/postgresql

volumes:
  postgresql_data:

Setup Secret keywith Nextcloud

  1. Uncomment four lines starting with JWT in docker-compose
  2. Set your secret on line JWT_SECRET=yourSecret
  3. Open Nexcloud's config.php (by default /var/www/nextcloud/config/config.php)
  4. Add this to the 2nd last line (before the line with );) and paste in your secret (3rd last line)
  'onlyoffice' =>
    array (
      "jwt_secret" => "yourSecret",
      "jwt_header" => "AuthorizationJwt"
  )
  1. Go to your Nextcloud settings, navigate to Onlyoffice settings
  2. Add your server Address and Secret key
  3. Save

Setup lager file limits

  • Uncomment the - LARGER_FILE_LIMITS=true line in docker-compose.yml

Generate custom themes

  1. Uncomment the - ./slideThemes:/var/www/onlyoffice/documentserver/sdkjs/slide/themes/src line in docker-compose.yml
  2. Put your themes into the slideThemes directory
  3. Run docker exec -it <container-name> /usr/bin/documentserver-generate-allfonts.sh
    • (This will take some time. I have totally 35 themes and it took about 30 minutes to generate them on a Raspberry Pi 4 4GB)
  4. If you want to add more themes later, repeat step 2 and 3.

Tags used on DockerHub

  • latest - the latest version of the Documentserver - amd64 version
  • Version tags (eg. 7.0.1-37) - these tags are equal to the Documentserver version of the onlyoffice-documentserver debian package used in the image

Building the image yourself (not recommended - may take a lot of time)

1. Clone the repository (for example to your home directory cd /home/$USER/)

git clone https://github.com/jiriks74/Docker-DocumentServer.git && cd Docker-DocumentServer

2. Build the docker image

Building only for the architecture you are building the image on (when building on Raspberry Pi result will be arm64, when on pc result will be amd64)

docker-compose build

Building for all supported architectures (you have to have your environment setup for emulation of arm64 with qemu) - you have to push to DockerHub

docker buildx build --push --platform linux/arm64,linux/amd64,linux/386 .

3. Create and start the container

docker-compose up -d

  • This will start the server. It is set to be automatically started/restarted so as long you have docker running on startup this will start automatically

Updating the image yourself

1. Stop and delete the old container

docker-compose down

2. (optional) Clear the docker cache

- ! This will remove all unused cache images ! (good for saving space, bad if you develop with and need cache, but you understand it at that point)

docker rmi $(docker images -f "dangling=true" -q)

4. Rebuild the image without cache

Building only for the architecture you are building the image on (when building on Raspberry Pi result will be arm64, when on pc result will be amd64)

docker-compose build

Building for all supported architectures (you have to have your environment setup for emulation of arm64 with qemu) - you have to push to DockerHub

docker buildx build --push --platform linux/arm64,linux/amd64,linux/386 .

3. Create and start the new container

docker-compose up -d

The rest of this file is the official README.md from OnlyOffice-Documentserver repository. I will not change anything in it, it may not work, but considering the changes I made, it should be fully compatible (beware that you must change the docker-compose.yml from building the image locally to using this repository). If you want to change something, make a issue on my repository and we'll figure it out.

Overview

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.

Functionality

  • 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.

Recommended System Requirements

  • 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

Running Docker Image

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.

Configuring Docker Image

Storing Data

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

Running ONLYOFFICE Document Server on Different Port

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

Running ONLYOFFICE Document Server using HTTPS

    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.

Using the automatically generated Let's Encrypt SSL Certificates

    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 Certificates

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

STEP 1: Create the server private key

openssl genrsa -out tls.key 2048

STEP 2: Create the certificate signing request (CSR)

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

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

openssl x509 -req -days 365 -in tls.csr -signkey tls.key -out tls.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 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.key

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

Available Configuration Parameters

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_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 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 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.
  • JWT_ENABLED: Specifies the enabling the JSON Web Token validation by the ONLYOFFICE Document Server. Defaults to false.
  • JWT_SECRET: Defines the secret key to validate the JSON Web Token in the request to the ONLYOFFICE Document Server. Defaults to secret.
  • 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.
  • USE_UNAUTHORIZED_STORAGE: Set to trueif using selfsigned 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 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.

Installing ONLYOFFICE Document Server integrated with Community and Mail Servers

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 onlyoffice

Then launch containers on it using the 'docker run --net onlyoffice' option:

STEP 2: Install MySQL.

Follow these steps to install MySQL server.

STEP 3: Install ONLYOFFICE Document Server.

sudo docker run --net onlyoffice -i -t -d --restart=always --name onlyoffice-document-server \
	-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/documentserver

STEP 4: 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/mailserver

The additional parameters for mail server are available here.

To learn more, refer to the ONLYOFFICE Mail Server documentation.

STEP 5: Install ONLYOFFICE Community Server

sudo docker run --net onlyoffice -i -t -d --restart=always --name onlyoffice-community-server -p 80:80 -p 443:443 -p 5222:5222 \
 -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 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 \
 onlyoffice/communityserver

Where ${MAIL_SERVER_IP} is the IP address for ONLYOFFICE Mail Server. You can easily get it using the command:

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.sh

STEP 2: Install ONLYOFFICE Community Edition executing the following command:

bash opensource-install.sh -md yourdomain.com

Or, 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

Issues

Docker Issues

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.

Document Server usage issues

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).

Project Information

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

User Feedback and Support

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.