Articles with the tag:
Close
Changelog
Close
Help Center
Enterprise Edition

Installing Enterprise Edition with additional script parameters

Introduction

Enterprise Edition is a paidfree version free for educational institutions of collaborative system developed to manage documents, projects, customer relationship and email correspondence, all in one place.

Enterprise Edition is shipped in two main versions: as a virtual machine image, compatible with most popular virtual machine managing software, and 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 Enterprise Edition correct work and is easy to run, manage and update.

After you download the 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 enterprise-install.sh -h

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

Container name

Parameter Description
-cc, --communitycontainer community container name
-dc, --documentcontainer document container name
-mc, --mailcontainer mail container name
-cpc, --controlpanelcontainer control panel container name

These parameters can be used to assign a custom name to a container when running it. By default, the following names are used for the containers: onlyoffice-community-server, onlyoffice-document-server, onlyoffice-mail-server, onlyoffice-control-panel.

Example

bash enterprise-install.sh -ims false -cc name1 -dc name2 -cpc name3
bash opensource-install.sh -ims false -cc name1 -dc name2

This will install all the Enterprise Edition components without Mail Server. After the installation, the Community Server, Document Server and Control Panel containers will acquire the specified names (name1, name2, name3). Use the docker ps command to display all the running containers and verify that names have been acquired correctly.

Image name

Parameter Description
-ci, --communityimage community image name or .tar.gz file path
-di, --documentimage document image name or .tar.gz file path
-mi, --mailimage mail image name or .tar.gz file path
-cpi, --controlpanelimage 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 enterprise-install.sh -ims false -ci onlyoffice4enterprise/communityserver-ee -ids false -icp true
bash opensource-install.sh -ims false -ci onlyoffice/communityserver -ids false

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

bash enterprise-install.sh -ims false -ics true -ci "/home/user/onlyoffice4enterprise-communityserver-ee_8.9.0.150.tar.gz" -ids false -icp true

This will run a container from the specified local .tar.gz file that contains the Community Server image as well as run a Control Panel container from the image stored in the Docker Hub repository.

Component version

Parameter Description
-cv, --communityversion community version
-dv, --documentversion document version
-mv, --mailversion mail version
-cpv, --controlpanelversion control panel version

These parameters can be used to install a certain component 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 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 enterprise-install.sh -ics true -cv 8.9.0.150 -ids false -icp true -cpv 1.6.0.52 -ims true -md "yourdomain.com"
bash opensource-install.sh -ics true -cv 8.9.0.150 -ids false -ims true -md "yourdomain.com"

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

Server IP

Parameter Description
-dip, --documentserverip document server ip
-mip, --mailserverip mail server ip
-mdbip, --mailserverdbip mail server db ip

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

Example

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

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

Mail domain name

Parameter Description
-md, --maildomain mail domain name

This parameter allows to specify your own domain name that will be used for Mail Server.

Example

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

This will install all the Enterprise Edition components including Mail Server with the yourdomain.com domain name specified.

Your domain that will be used for maintaining correspondence must be valid and configured for this machine (i.e. it should have the appropriate A record in the DNS settings that points your domain name to the IP address of the machine where Mail Server is installed).
In the command above, the "yourdomain.com" parameter must be understood as a service domain for Mail Server. 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
-u, --update use to update existing components true|false

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

Example

bash enterprise-install.sh -md "yourdomain.com" -u true

This will consequently stop those containers that need to be updated, remove them and then run the latest versions of the corresponding 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 enterprise-install.sh -md "yourdomain.com" -un username -p password

Component installation

Parameter Description Values
-ics, --installcommunityserver install community server true|false|pull
-ids, --installdocumentserver install document server true|false|pull
-ims, --installmailserver install mail server true|false|pull
-icp, --installcontrolpanel install control panel true|false|pull

These parameters allow 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.
  • Use the pull value to download a component without installing it.
Please do not skip Control Panel installation when installing Community Server, otherwise you will not be able to enter your license key after the installation is finished and add, for instance, Mail Server to your Enterprise Edition instance.

Example

bash enterprise-install.sh -ims false 

This will install all the Enterprise Edition components without Mail Server.

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

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

Using a component as an external server

Parameter Description Values
-es, --useasexternalserver use as external server true|false

This parameter is used in case you install components on separate machines.

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

Example

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

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

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

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

Service count

Parameter Description
-svc, --servicecount number of services

This parameter allows to specify the number of the Redis monoserve services you want to use. By default, 2 services are used, but you can specify a greater value.

Example

bash enterprise-install.sh -ims false -svc 4

Swap file creation

Parameter Description Values
-ms, --makeswap make swap file true|false

This parameter allows to create 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 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.

How to install server version using the provided script parameters
Close
Download Host on your own server Available for Docker,
Windows, Linux and virtual machines
You Might Also Like This:
Close