- Home
- Workspace
- Installation
- Enterprise
- Docker
- Installing ONLYOFFICE Workspace Enterprise with additional script parameters
Installing ONLYOFFICE Workspace Enterprise with additional script parameters
Introduction
ONLYOFFICE Workspace Enterprise Edition is a paid version of collaborative system developed to manage documents, projects, customer relationship and email correspondence, all in one place.
ONLYOFFICE Workspace Enterprise Edition 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 Workspace Enterprise Edition correct work and is easy to run, manage and update.
After you download the ONLYOFFICE Workspace Enterprise Edition 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 script parameters:
bash workspace-enterprise-install.sh -h
You can find a short description and some usage examples for these parameters below.
Image name
Parameter | Description |
---|---|
-ci, --communityimage | ONLYOFFICE Community Server image name or .tar.gz file path |
-di, --documentimage | ONLYOFFICE Docs image name or .tar.gz file path |
-mi, --mailimage | ONLYOFFICE Mail image name or .tar.gz file path |
-cpi, --controlpanelimage | ONLYOFFICE Control Panel image name or .tar.gz file path |
These parameters can be used to specify a name of the image that a container should be started from. The specified image should be stored in our official public repository on Docker Hub. If you have downloaded a .tar.gz archive from the Downloads page, you can also specify a path to this .tar.gz file stored on your machine.
Example
bash workspace-enterprise-install.sh -ims false -di onlyoffice/documentserver-ee -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.
bash workspace-enterprise-install.sh -ims false -ics true -ci "/home/user/CommunityServer-12.5.2.tar.gz" -ids false -icp true
This will run a container from the specified local .tar.gz file that contains the ONLYOFFICE Community Server image, as well as run a ONLYOFFICE Control Panel container from the image stored in the Docker Hub repository.
Component version
Parameter | Description |
---|---|
-cv, --communityversion | ONLYOFFICE Community Server version |
-dv, --documentversion | ONLYOFFICE Docs version |
-mv, --mailversion | ONLYOFFICE Mail version |
-cpv, --controlpanelversion | ONLYOFFICE Control Panel version |
These parameters can be used to install a certain component version if you do not want to install 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 necessary component and go to the Tags tab to view all the tags available in the repository. Specify the version you want to install for the necessary components:
bash workspace-enterprise-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
Parameter | Description |
---|---|
-dip, --documentserverip | ONLYOFFICE Docs IP address |
-mip, --mailserverip | ONLYOFFICE Mail IP address |
-mdbip, --mailserverdbip | ONLYOFFICE Mail database IP address |
These parameters can be used to connect the components if you install them on separate machines.
Example
bash workspace-enterprise-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
Parameter | Description |
---|---|
-md, --maildomain | ONLYOFFICE Mail domain name |
This parameter allows specifying your own domain name that will be used for ONLYOFFICE Mail.
Example
bash workspace-enterprise-install.sh -md "yourdomain.com"
This will install all the ONLYOFFICE Workspace Enterprise Edition components, including ONLYOFFICE Mail with the yourdomain.com
domain name specified.
In the command above, the
"yourdomain.com"
parameter must be understood as a service domain for ONLYOFFICE Mail. It is usually specified in the MX record of the domain that will be used for maintaining correspondence. As a rule, the "yourdomain.com"
looks like mx1.onlyoffice.com
Component update
Parameter | Description | Values | Default |
---|---|---|---|
-u, --update | use to update existing components | true|false | false |
This parameter allows installing the latest versions of the necessary components if the corresponding components installed on your machine are outdated.
Example
bash workspace-enterprise-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 Workspace Enterprise Edition 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 portal data should be picked up automatically.
Credentials
Parameter | Description |
---|---|
-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 workspace-enterprise-install.sh -md "yourdomain.com" -un username -p password
Component installation
Parameter | Description | Values | Default |
---|---|---|---|
-ics, --installcommunityserver | install ONLYOFFICE Community Server | true|false|pull | true |
-ids, --installdocumentserver | install ONLYOFFICE Docs | true|false|pull | true |
-ims, --installmailserver | install ONLYOFFICE Mail | true|false|pull | true |
-icp, --installcontrolpanel | install ONLYOFFICE Control Panel | true|false|pull | true |
These parameters allow specifying 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. - Use the
pull
value to download a component without installing it.
Example
bash workspace-enterprise-install.sh -ims false
This will install all the ONLYOFFICE Workspace Enterprise Edition components without ONLYOFFICE Mail.
bash workspace-enterprise-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
Parameter | Description | Values | Default |
---|---|---|---|
-it, --installation_type | installation type | WORKSPACE|WORKSPACE_ENTERPRISE | WORKSPACE_ENTERPRISE |
This parameter allows installing the specified solution: ONLYOFFICE Workspace or ONLYOFFICE Workspace Enterprise Edition.
Example
bash workspace-enterprise-install.sh -it WORKSPACE
This will install the ONLYOFFICE Community Server and ONLYOFFICE Control Panel components.
Using a component as an external server
Parameter | Description | Values | Default |
---|---|---|---|
-es, --useasexternalserver | use as external server | true|false | false |
This parameter is used in case you install components on separate machines.
- 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-enterprise-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-enterprise-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
Parameter | Description | Values | Default |
---|---|---|---|
-ms, --makeswap | make swap file | true|false | false |
This parameter allows creating 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-enterprise-install.sh -ms false
If you have previously created a swap file, you can use this command so that not to create a swap file during the installation.
In case you run the script again without specifying the -ms
parameter, it checks if the onlyoffice_swapfile
is present. If the swap file already exists, the script will not create a swap file once again.
MySQL server
Parameter | Description | Default |
---|---|---|
-mysqlh, --mysqlhost | MySQL server host | localhost |
-mysqlprt, --mysqlport | MySQL server port | 3306 |
-mysqlru, --mysqlrootuser | MySQL server root user | root |
-mysqlrp, --mysqlrootpassword | MySQL server root password | my-secret-pw |
If you do not explicitly specify these parameters, the default values are used.
Example
bash workspace-enterprise-install.sh -mysqlru root -mysqlrp new-secret-pw
This command allows setting your own password for the MySQL root account during the ONLYOFFICE Workspace Enterprise Edition installation.
ONLYOFFICE Community Server database
Parameter | Description | Default |
---|---|---|
-mysqld, --mysqldatabase | ONLYOFFICE Community Server database name | onlyoffice |
-mysqlu, --mysqluser | ONLYOFFICE Community Server database user | onlyoffice_user |
-mysqlp, --mysqlpassword | ONLYOFFICE Community Server database password | onlyoffice_pass |
These parameters allow creating the ONLYOFFICE Community Server 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-enterprise-install.sh -mysqld communitydatabase -mysqlu username -mysqlp password
ONLYOFFICE Mail database
Parameter | Description | Default |
---|---|---|
-mysqlmd, --mysqlmaildatabase | ONLYOFFICE Mail database name | onlyoffice_mailserver |
-mysqlmu, --mysqlmailuser | ONLYOFFICE Mail database user | mail_admin |
-mysqlmp, --mysqlmailpassword | ONLYOFFICE Mail database password | Isadmin123 |
These parameters allow creating 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-enterprise-install.sh -md "mx.yourdomain.com" -mysqlmd maildatabase -mysqlmu username -mysqlmp password
ONLYOFFICE Community Server port
Parameter | Description | Default |
---|---|---|
-cp, --communityport | ONLYOFFICE Community Server port | 80 |
This parameter allows changing the port on which ONLYOFFICE Community Server will run. By default, port 80 is used.
Example
bash workspace-enterprise-install.sh -cp 8080
Setting for core.machinekey
Parameter | Description |
---|---|
-mk, --machinekey | Setting for the core.machinekey key |
This parameter allows specifying your own machinekey when installing ONLYOFFICE Workspace Enterprise Edition.
/app/onlyoffice/CommunityServer/data/.private/machinekey
configuration file.Example
bash workspace-enterprise-install.sh -mk yourmachinekey
Setting for JWT secret
Parameter | Description |
---|---|
-jwt, --jwtsecret | Setting for the JWT secret key |
This parameter allows specifying your own JWT secret key when installing ONLYOFFICE Workspace Enterprise Edition. The secret key is used to sign the JSON web token and validate the token upon the request to ONLYOFFICE Docs.
- For Community Server -
/var/www/onlyoffice/WebStudio/web.appsettings.config
- For Document Server -
/etc/onlyoffice/documentserver/local.json
Example
bash workspace-enterprise-install.sh -jwt yoursecret