Articles with the tag:
Browse all tags
Close
Changelog
Close
Try in the cloud
Try in the cloud
Help Center
Search

Installing ONLYOFFICE DocSpace Community with additional script parameters

Introduction

ONLYOFFICE DocSpace Community is a paidpaidfree version of a document hub where you can connect users and documents in one place to boost collaboration.

ONLYOFFICE DocSpace Community is shipped as an automatic installation script for Linux operating systems with Docker installed. The script will set up Docker containers with all the components necessary for ONLYOFFICE DocSpace Community correct work and is easy to run, manage and update.

After you download the ONLYOFFICE DocSpace Community installation script, you might need to run it specifying some additional parameters, for example, if you want to install each component on a separate machine.

Use the following command to display the list of all the available Docker script parameters:

bash docspace-install.sh docker -h

Use the following command to display the list of all the available DEB/RPM script parameters:

bash docspace-install.sh package -h

You can find a short description and some usage examples for these parameters below.

When you run the script with parameters, you will be prompted to select the way you want to install ONLYOFFICE DocSpace. Type Y and press Enter to install ONLYOFFICE Docs using Docker. Type N and press Enter to install ONLYOFFICE DocSpace from DEB/RPM packages.

Credentials

Parameter Description
-hub, --hub dockerhub name
-un, --username dockerhub username
-p, --password dockerhub password

These parameters are used in case we provide you credentials to access a test repository so that you can run containers from images stored in it.

Example

bash docspace-install.sh -hub name -un username -p password

Installation type

Parameter Description Values Default
-it, --installation_type installation type community|developer|enterprise enterprisedevelopercommunity

This parameter allows you to install the specified solution: ONLYOFFICE DocSpace Community, ONLYOFFICE DocSpace Developer or ONLYOFFICE DocSpace Enterprise.

Example

bash docspace-install.sh -it community

This will install the ONLYOFFICE DocSpace Community solution.

bash docspace-install.sh -it developer

This will install the ONLYOFFICE DocSpace Developer solution.

bash docspace-install.sh -it enterprise

This will install the ONLYOFFICE DocSpace Enterprise solution.

Hardware check

Parameter Description Values Default
-skiphc, --skiphardwarecheck use to skip hardware check true|false false

This parameter allows you to skip checking if the system meets the minimal hardware requirements.

Example

bash docspace-install.sh -skiphc true

This will skip hardware check.

Component update

Parameter Description Values Default
-u, --update use to update existing components true|false false

This parameter allows you to install the latest versions of the necessary components if the corresponding components installed on your machine are outdated.

Example

bash docspace-install.sh -u true

This will consequently stop those containers that need to be updated, remove them and then run the latest versions of the corresponding ONLYOFFICE DocSpace Community components. If the current component version coincides with the latest available one, such a container will not be affected. If you have skipped some components during the previous installation, they will also be skipped. The DocSpace data should be picked up automatically.

Update Docs only to version 7.2.1.34 and skip the update for all other components:

bash docspace-install.sh -u true -docsi onlyoffice/documentserver-ee -docsv 7.2.1.34 -idocs true -ids false -irbt false -irds false

Update DocSpace only to version 1.2.0 and skip the update for all other components::

bash docspace-install.sh -u true -dsv v1.2.0 -idocs false -irbt false -irds false

Component installation

Parameter Description Values Default
-ids, --installdocspace install ONLYOFFICE DocSpace true|false true
-idocs, --installdocs install ONLYOFFICE Docs true|false true
-irbt, --installrabbitmq install RabbitMQ true|false true
-irds, --installredis install Redis true|false true
-imysql, --installmysql install MySQL true|false true

These parameters allow you to specify whether you need to install a certain component or not. They can be used if you want to install each component on a separate machine.

  • Use the true value to install a component.
  • Use the false value to skip a component installation.

Example

bash docspace-install.sh -idocs false

This will install all the ONLYOFFICE DocSpace Community components without ONLYOFFICE Docs.

bash docspace-install.sh -ids false -idocs true -imysql false -irbt false -irds false

This will skip the installation of ONLYOFFICE DocSpace, MySQL, RabbitMQ, and Redis and will install ONLYOFFICE Docs only.

Component version

Parameter Description
-dsv, --docspaceversion ONLYOFFICE DocSpace version
-docsv, --docsversion ONLYOFFICE Docs version

These parameters can be used to install a certain ONLYOFFICE DocSpace or ONLYOFFICE Docs version if for some reasons you do not want to install the latest version available in the repository. By default, an image tagged as latest is used to run the component container.

Example

Open the Docker Hub repository in your browser, select ONLYOFFICE Docs and go to the Tags tab to view all the tags available in the repository. Specify the version you want to install:

bash docspace-install.sh -docsv 7.2.1.34

This will install ONLYOFFICE DocSpace with the ONLYOFFICE Docs 7.2.1.34 version.

ONLYOFFICE Docs image name

Parameter Description
-docsi, --docsimage ONLYOFFICE Docs image name

This parameter can be used to specify a name of the ONLYOFFICE Docs image that a container should be started from. The specified image should be stored in our official public repository on Docker Hub.

Example

bash docspace-install.sh -docsi onlyoffice/documentserver-ee

bash docspace-install.sh -docsi onlyoffice/documentserver-de

bash docspace-install.sh -docsi onlyoffice/documentserver

This will run a container from the specified ONLYOFFICE Docs image stored in the repository.

Setting for hosts

Parameter Description
-dsh, --docspacehost ONLYOFFICE DocSpace host
-esh, --elastichost Elasticsearch hosts

These parameters can be used to connect the components if you install them on separate machines.

Example

bash docspace-install.sh -esh 192.168.3.202

This will install ONLYOFFICE DocSpace and connect it with Elasticsearch installed on a different machine which has the 192.168.3.202 IP address.

Setting for core.machinekey

Parameter Description
-mk, --machinekey Setting for the core.machinekey key

This parameter allows you to specify your own machinekey when installing ONLYOFFICE DocSpace Community.

This parameter is written to the /app/onlyoffice/config/appsettings.json configuration file (the path is specified within the onlyoffice-studio container).

Example

bash docspace-install.sh -mk yourmachinekey

ONLYOFFICE DocSpace external port

Parameter Description Default
-ep, --externalport ONLYOFFICE DocSpace external port 80

This parameter allows you to change the port on which ONLYOFFICE DocSpace will run. By default, port 80 is used.

Example

bash docspace-install.sh -ep 8080

Settings for JWT header and secret

Parameter Description
-jh, --jwtheader Setting for the JWT header
-js, --jwtsecret Setting for the JWT secret key

These parameters allow you you to specify the JWT header and your own JWT secret key when installing ONLYOFFICE DocSpace Community. The JWT header defines the http header that will be used to send the JWT. The secret key is used to sign the JSON web token and validate the token upon the request to ONLYOFFICE Docs.

These parameters are written to the following configuration files (the paths are specified within the onlyoffice-studio and onlyoffice-document-server containers):
  • For DocSpace - /app/onlyoffice/config/appsettings.json
  • For Document Server - /etc/onlyoffice/documentserver/local.json

Example

bash docspace-install.sh -js yoursecret

MySQL server

Parameter Description Default
-mysqlrp, --mysqlrootpassword MySQL server root password my-secret-pw
-mysqlh, --mysqlhost MySQL server host localhost
-mysqlport, --mysqlport MySQL server port number 3306

If you do not explicitly specify these parameters, the default values are used.

Example

bash docspace-install.sh -mysqlrp new-secret-pw

This command allows you to set your own password for the MySQL root account during the ONLYOFFICE DocSpace Community installation.

ONLYOFFICE DocSpace database

Parameter Description Default
-mysqld, --mysqldatabase ONLYOFFICE DocSpace database name onlyoffice
-mysqlu, --mysqluser ONLYOFFICE DocSpace database user onlyoffice_user
-mysqlp, --mysqlpassword ONLYOFFICE DocSpace database password onlyoffice_pass

These parameters allow you you to create the ONLYOFFICE DocSpace database specifying custom database name, as well as a username and password for the account with superuser permissions on the created database. If you do not explicitly specify these parameters, the default values are used.

Example

bash docspace-install.sh -mysqld docspacedatabase -mysqlu username -mysqlp password

Switching to HTTPS

Parameter Description
-led, --letsencryptdomain defines the domain for the Let's Encrypt certificate
-lem, --letsencryptmail defines the domain administrator mail address for the Let's Encrypt certificate
-cf, --certfile path to the certificate file for the domain
-ckf, --certkeyfile path to the private key file for the certificate

These parameters allow you to switch the portal to HTTPS. They can be used for the Docker version only.

Example

bash docspace-install.sh docker --letsencryptmail user@example.com --letsencryptdomain yourdomain.com

This will automatically create and install the letsencrypt.org CA-signed certificate to your server and restart the NGINX service for the changes to take effect.

bash docspace-install.sh docker --certfile path --certkeyfile path

This will apply your own SSL certificate.

Download Host on your own server Available for
Docker, Windows and Linux
You Might Also Like This:
Close