Installing ONLYOFFICE Workspace Community using additional script parameters

Introduction

ONLYOFFICE Workspace Community is a free version of the collaborative system developed to manage documents, projects, customer relationships, and email correspondence, all in one place.

ONLYOFFICE Workspace Community is shipped as an automatic installation script for Linux operating systems with Docker installed. The script sets up Docker containers with all the components required for ONLYOFFICE Workspace Community correct operation and is easy to run, manage and update.

After you download the ONLYOFFICE Workspace Community installation script, you may need to run it with additional parameters, for example, to install each component on a separate server. Use the following command to display the list of all the available script parameters:

bash workspace-install.sh -h

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

Image name

These parameters specify the name of the image from which a container should be started. The specified image must be available in the official public repository on Docker Hub.

Example

bash workspace-install.sh -ims false -di onlyoffice/documentserver -ics true -icp true

This will run a container from the specified ONLYOFFICE Docs image stored in the repository as well as run the ONLYOFFICE Community Server and ONLYOFFICE Control Panel containers.

Component version

These parameters allow you to install a specific component version if you do not wish to use the latest version available in the repository. By default, an image tagged as latest is used to run each component container.

Example

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

bash workspace-install.sh -ics true -cv 8.9.0.150 -ids false -icp true -cpv 1.6.0.52 -ims true -md "yourdomain.com"

This will install the ONLYOFFICE Community Server 8.9.0.150 version, the ONLYOFFICE Control Panel 1.6.0.52 version and the latest version of ONLYOFFICE Mail as its version has not been specified explicitly.

Server IP

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

Example

bash workspace-install.sh -ics true -icp true -ids false -ims false -dip 192.168.3.202 -es false

This will install ONLYOFFICE Community Server with ONLYOFFICE Control Panel and connect it with ONLYOFFICE Docs installed on a different machine which has the 192.168.3.202 IP address.

ONLYOFFICE Mail domain name

This parameter allows you to specify a custom domain name that will be used for ONLYOFFICE Mail.

Example

bash workspace-install.sh -md "yourdomain.com"

This will install all the ONLYOFFICE Workspace Community components including ONLYOFFICE Mail with the yourdomain.com domain name specified.

Component update

This parameter installs the latest versions of any outdated components if the corresponding components installed on your machine are outdated.

Example

bash workspace-install.sh -u true

This will stop the containers that require updating, remove them, and start the latest versions of the corresponding ONLYOFFICE Workspace components. Containers whose current version matches the latest available will not be affected. Components skipped during the previous installation will also be skipped. Portal data will be preserved automatically.

Credentials

These parameters are used when credentials are provided to access a test repository, allowing you to run containers from images stored there.

Example

bash workspace-install.sh -md "yourdomain.com" -un username -p password

Component installation

These parameters allow you to specify whether to install a certain component. They can be used to install each component on a separate server.

• Use the true value to install a component.
• Use the false value to skip a component installation.
• Use the pull value to download a component without installing it.

Example

bash workspace-install.sh -ims false 

This will install all the ONLYOFFICE Workspace components without ONLYOFFICE Mail.

bash workspace-install.sh -ics false -ids true -icp false -ims false -es true 

This will skip the installation of ONLYOFFICE Mail, ONLYOFFICE Community Server and ONLYOFFICE Control Panel and will install ONLYOFFICE Docs only.

Installation type

This parameter installs the specified solution: ONLYOFFICE Workspace or ONLYOFFICE Workspace Enterprise Edition.

Example

bash workspace-install.sh -it GROUPS 

This will install the ONLYOFFICE Workspace solution which includes the ONLYOFFICE Community Server and ONLYOFFICE Control Panel components.

Using a component as an external server

This parameter is used when installing components on separate servers.

• Use the true value when installing ONLYOFFICE Docs and ONLYOFFICE Mail on separate machines.
• Use the false value when installing ONLYOFFICE Community Server together with ONLYOFFICE Control Panel on a separate machine.

Example

bash workspace-install.sh -ics false -ids false -icp false -ims true -md "yourdomain.com" -es true

This will skip the installation of ONLYOFFICE Docs, ONLYOFFICE Community Server and ONLYOFFICE Control Panel and will install ONLYOFFICE Mail only.

bash workspace-install.sh -ics true -icp true -ids false -ims false -dip 192.168.3.202 -es false

This will install ONLYOFFICE Community Server with ONLYOFFICE Control Panel and connect it with ONLYOFFICE Docs installed on a different machine.

Swap file creation

This parameter creates a 6 GB swap file. By default, the true value is specified, therefore you do not need to specify this parameter when running the script. The swap file will be created automatically.

Example

bash workspace-install.sh -ms false

If a swap file already exists, use this command to prevent a new swap file from being created during installation..

If you run the script again without the -ms parameter, it checks whether onlyoffice_swapfile is present. If the swap file already exists, the script will not create a swap file once again.

MySQL server

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

Example

bash workspace-install.sh -mysqlru root -mysqlrp new-secret-pw

This command sets a custom password for the MySQL root account during ONLYOFFICE Workspace installation.

ONLYOFFICE Community Server database

These parameters allow to create the ONLYOFFICE Community Server database with a custom name, along with a username and password for an account with superuser permissions. If you do not explicitly specify these parameters, the default values are used.

Example

bash workspace-install.sh -mysqld communitydatabase -mysqlu username -mysqlp password

ONLYOFFICE Mail database

These parameters allow to create the ONLYOFFICE Mail 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 workspace-install.sh -md "mx.yourdomain.com" -mysqlmd maildatabase -mysqlmu username -mysqlmp password

ONLYOFFICE Community Server port

This parameter changes the port on which ONLYOFFICE Community Server runs. The default port is 80.

Example

bash workspace-install.sh -cp 8080

Setting for core.machinekey

This parameter allows you to specify a custom machinekey when installing ONLYOFFICE Workspace Community.

Example

bash workspace-install.sh -mk yourmachinekey

Setting for JWT secret

This parameter allows you to specify a custom JWT secret key when installing ONLYOFFICE Workspace Community. The secret key is used to sign the JSON web token and validate the token upon the request to ONLYOFFICE Docs.

Example

bash workspace-install.sh -jwt yoursecret