OnlyOffice
- Deployment of DocumentServer via SUBDOMAIN
  - Test that DocumentServer is running via SUBDOMAIN
  - Configure Seafile Server for SUBDOMAIN
- Deployment of DocumentServer via SUBFOLDER

OnlyOffice

From version 6.1.0+ on (including CE), Seafile supports OnlyOffice to view/edit office files online. In order to use OnlyOffice, you must first deploy an OnlyOffice server.

Info for clusters

In a cluster setup we recommend a dedicated DocumentServer host or a DocumentServer Cluster on a different subdomain.
Technically it works also via subfolder if the loadbalancer can handle folder for loadbalancing.

For most users we recommend to deploy the documentserver in a docker image locally and provide it via a subfolder.

Benefits:

no additional server required
no additional subdomain required
no additional SSL certificate required
easy and quick deployment
easy management

Summary

Deployment of DocumentServer via SUBDOMAIN

URL example: https://onlyoffice.domain.com

Subdomain
DNS record for subdomain
SSL certificate (LE works also)

For a quick and easy installation, we suggest you use ONLYOFFICE/Docker-DocumentServer for a subdomain installation. Just follow the guide in the OnlyOffice documentation.

Test that DocumentServer is running via SUBDOMAIN

After the installation process is finished, visit this page to make sure you have deployed OnlyOffice successfully: http{s}://{your Seafile Server's domain or IP}/welcome, you will get Document Server is running info at this page.

Configure Seafile Server for SUBDOMAIN

Add the following config option to seahub_settings.py.

# Enable Only Office
ENABLE_ONLYOFFICE = True
VERIFY_ONLYOFFICE_CERTIFICATE = False
ONLYOFFICE_APIJS_URL = 'http{s}://{your OnlyOffice server's domain or IP}/web-apps/apps/api/documents/api.js'
ONLYOFFICE_FILE_EXTENSION = ('doc', 'docx', 'ppt', 'pptx', 'xls', 'xlsx', 'odt', 'fodt', 'odp', 'fodp', 'ods', 'fods')
ONLYOFFICE_EDIT_FILE_EXTENSION = ('docx', 'pptx', 'xlsx')

Then restart the Seafile Server

./seafile.sh restart
./seahub.sh restart
# or
service seafile-server restart

When you click on a document you should see the new preview page.

Deployment of DocumentServer via SUBFOLDER

URL example: https://seafile.domain.com/onlyofficeds

Local proxy to subfolder on already existing Seafile Server (sub)domain.
SSL via Seafile Server domain, no additional certificate required !

Do NOT CHANGE the SUBFOLDER if not absolutely required for some reason!

The subfolder page is only important for communication between Seafile and the DocumentServer, there is nothing except the welcome page (e.g. no overview or settings). Users will need access to it though for the OnlyOffice document server editor to work properly.

/onlyoffice/ cannot be used as subfolder as this path is used for communication between Seafile and Document Server !

The following guide shows how to deploy the OnlyOffice Document server locally.
It is based on the “ONLYOFFICE/Docker-DocumentServer” documentation.

Requirements for OnlyOffice DocumentServer via Docker
https://github.com/ONLYOFFICE/Docker-DocumentServer#recommended-system-requirements

Install Docker

Ubuntu, Debian, CentOS

Deploy OnlyOffice DocumentServer Docker image

This downloads and deploys the DocumentServer on the local port 88.

Debian 8

docker run -i -t -d -p 88:80 --restart=always --name oods onlyoffice/documentserver

Ubuntu 16.04

docker run -dit -p 88:80 --restart always --name oods onlyoffice/documentserver

Nothing yet confirmed on CentOS 7, you may try any of the above commands, they may work also.

EXAMPLE: Debian Docker container with MEMORY LIMITS

In Debian 8 you first have to change some settings in the grub config to support memory limits for docker.

# Edit /etc/default/grub
# Add the following options
GRUB_CMDLINE_LINUX_DEFAULT="cgroup_enable=memory swapaccount=1"
# Update Grub2 and reboot
update-grub2 && reboot

Now you can start the docker image with memory limits.
docker run -i -t -d -p 88:80 --restart=always --memory "6g" --memory-swap="6g" --name oods onlyoffice/documentserver

These limits are above the minimum recommendation (4G RAM/2GB SWAP) so the DocumentServer’s performance keeps up, while multiple users edit documents. Docker SWAP works different from machine SWAP, check the docker documentation.

Docker documentation

If you have any issues please check the docker documentation.

Auto-starting the docker image.

If you wish to limit the resources that docker uses check the docker documentation.

Configure Webserver

Configure Nginx

Variable mapping

Add the following configuration to your seafile nginx .conf file (e.g. /etc/ngnix/conf.d/seafile.conf) out of the server directive. These variables are to be defined for the DocumentServer to work in a subfolder.

# Required for only office document server
map $http_x_forwarded_proto $the_scheme {
        default $http_x_forwarded_proto;
        "" $scheme;
    }
map $http_x_forwarded_host $the_host {
        default $http_x_forwarded_host;
        "" $host;
    }
map $http_upgrade $proxy_connection {
        default upgrade;
        "" close;
    }

Proxy server settings subfolder

Add the following configuration to your seafile nginx .conf file (e.g. /etc/ngnix/conf.d/seafile.conf) within the server directive.


...   
location /onlyofficeds/ {
        # THIS ONE IS IMPORTANT ! - Trailing slash !
        proxy_pass http://{your Seafile server's domain or IP}:88/;
        proxy_http_version 1.1;
        client_max_body_size 100M; # Limit Document size to 100MB
        proxy_read_timeout 3600s;
        proxy_connect_timeout 3600s;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $proxy_connection;
        # THIS ONE IS IMPORTANT ! - Subfolder and NO trailing slash !
        proxy_set_header X-Forwarded-Host $the_host/onlyofficeds;
        proxy_set_header X-Forwarded-Proto $the_scheme;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
...

Configure Apache

BETA - Requires further testing!

Add the following configuration to your seafile apache config file (e.g. sites-enabled/seafile.conf) outside the <VirtualHost > directive.

...
LoadModule authn_core_module modules/mod_authn_core.so
LoadModule authz_core_module modules/mod_authz_core.so
LoadModule unixd_module modules/mod_unixd.so
LoadModule proxy_module modules/mod_proxy.so
LoadModule proxy_http_module modules/mod_proxy_http.so
LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so
LoadModule headers_module modules/mod_headers.so
LoadModule setenvif_module modules/mod_setenvif.so
<IfModule unixd_module>
  User daemon
  Group daemon
</IfModule>
...

Add the following configuration to your seafile apache config file (e.g. sites-enabled/seafile.conf) inside the <VirtualHost > directive at the end.

...
Define VPATH /onlyofficeds
Define DS_ADDRESS {your Seafile server's domain or IP}:88
...
<Location ${VPATH}>
  Require all granted
  SetEnvIf Host "^(.*)$" THE_HOST=$1
  RequestHeader setifempty X-Forwarded-Proto http
  RequestHeader setifempty X-Forwarded-Host %{THE_HOST}e
  RequestHeader edit X-Forwarded-Host (.*) $1${VPATH}
  ProxyAddHeaders Off
  ProxyPass "http://${DS_ADDRESS}/"
  ProxyPassReverse "http://${DS_ADDRESS}/"
</Location>
...

Test that DocumentServer is running via SUBFOLDER

After the installation process is finished, visit this page to make sure you have deployed OnlyOffice successfully: http{s}://{your Seafile Server's domain or IP}/{your subdolder}/welcome, you will get Document Server is running info at this page.

Configure Seafile Server for SUBFOLDER

Add the following config option to seahub_settings.py:

# Enable Only Office
ENABLE_ONLYOFFICE = True
VERIFY_ONLYOFFICE_CERTIFICATE = True
ONLYOFFICE_APIJS_URL = 'http{s}://{your Seafile server's domain or IP}/{your subdolder}/web-apps/apps/api/documents/api.js'
ONLYOFFICE_FILE_EXTENSION = ('doc', 'docx', 'ppt', 'pptx', 'xls', 'xlsx', 'odt', 'fodt', 'odp', 'fodp', 'ods', 'fods')
ONLYOFFICE_EDIT_FILE_EXTENSION = ('docx', 'pptx', 'xlsx')