sudo docker run -i -t -d -p 443:443 --restart=always \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data onlyoffice/documentserver-ee
sudo docker run -i -t -d -p 443:443 --restart=always \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data onlyoffice/documentserver-de
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, 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/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 \
-e LETS_ENCRYPT_DOMAIN=yourdomain.com -e LETS_ENCRYPT_MAIL=email@example.com onlyoffice/documentserver-ee
sudo docker run -i -t -d -p 80:80 -p 443:443 \
-e LETS_ENCRYPT_DOMAIN=yourdomain.com -e LETS_ENCRYPT_MAIL=email@example.com onlyoffice/documentserver-de
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 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 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 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 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 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.
- JWT_ENABLED: Specifies the enabling the JSON web token validation by ONLYOFFICE Docs. Defaults to
false.
- JWT_SECRET: Defines the secret key to validate the JSON web token in the request to ONLYOFFICE Docs. 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 Docs. 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 administator mail address for Let's Encrypt certificate.