Installing ONLYOFFICE Apps Enterprise using additional script parameters
Introduction
ONLYOFFICE Apps Enterprise is a paid version of a document hub where you can connect users and documents in one place to boost collaboration.
ONLYOFFICE Apps Enterprise 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 Apps Enterprise correct work and is easy to run, manage and update.
After you download the ONLYOFFICE Apps Enterprise 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 apps-enterprise-install.sh docker -h
Use the following command to display the list of all the available DEB/RPM script parameters:
bash apps-enterprise-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 Apps. Type Y and press Enter to install ONLYOFFICE Apps using Docker. Type N and press Enter to install ONLYOFFICE Apps from DEB/RPM packages.
Credentials
| Parameter | Description |
|---|---|
-reg, --registry | docker registry URL (e.g., https://myregistry.com:5000) |
-un, --username | docker registry login |
-p, --password | docker registry 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 apps-enterprise-install.sh -reg URL -un username -p password
Installation type
| Parameter | Description | Values | Default |
|---|---|---|---|
-it, --installationtype | installation type | community|developer|enterprise | enterprise |
This parameter allows you to install the specified solution: ONLYOFFICE Apps Community, ONLYOFFICE Apps Developer or ONLYOFFICE Apps Enterprise.
Example
bash apps-enterprise-install.sh -it community
This will install the ONLYOFFICE Apps Community 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 apps-enterprise-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 apps-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 Apps Enterprise 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 ONLYOFFICE Apps data should be picked up automatically.
Update Docs only to version 7.2.1.34 and skip the update for all other components:
bash apps-enterprise-install.sh -u true -docsi onlyoffice/documentserver-ee -docsv 7.2.1.34 -idocs true -ia false -irbt false -irds false
Update ONLYOFFICE Apps only to version 1.2.0 and skip the update for all other components:
bash apps-enterprise-install.sh -u true -asv v1.2.0 -idocs false -irbt false -irds false
Component installation
| Parameter | Description | Values | Default |
|---|---|---|---|
-ia, --installapps | install ONLYOFFICE Apps | 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
truevalue to install a component. - Use the
falsevalue to skip a component installation.
Example
bash apps-enterprise-install.sh -idocs false
This will install all the ONLYOFFICE Apps Enterprise components without ONLYOFFICE Docs.
bash apps-enterprise-install.sh -ia false -idocs true -imysql false -irbt false -irds false
This will skip the installation of ONLYOFFICE Apps, MySQL, RabbitMQ, and Redis and will install ONLYOFFICE Docs only.
Component version
| Parameter | Description |
|---|---|
-asv, --appsversion | ONLYOFFICE Apps version |
-docsv, --docsversion | ONLYOFFICE Docs version |
These parameters can be used to install a certain ONLYOFFICE Apps 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 apps-enterprise-install.sh -docsv 7.2.1.34
This will install ONLYOFFICE Apps 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 apps-enterprise-install.sh -docsi onlyoffice/documentserver-ee
This will run a container from the specified ONLYOFFICE Docs image stored in the repository.
Setting for hosts
| Parameter | Description |
|---|---|
-ash, --appshost | ONLYOFFICE Apps host |
-esh, --elastichost | OpenSearch hosts |
These parameters can be used to connect the components if you install them on separate machines.
Example
bash apps-enterprise-install.sh -esh 192.168.3.202
This will install ONLYOFFICE Apps and connect it with OpenSearch 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 Apps Enterprise.
This parameter is written to the /app/onlyoffice/config/appsettings.json configuration file (the path is specified within the onlyoffice-studio container).
Example
bash apps-enterprise-install.sh -mk yourmachinekey
ONLYOFFICE Apps external port
| Parameter | Description | Default |
|---|---|---|
-ep, --externalport | ONLYOFFICE Apps external port | 80 |
This parameter allows you to change the port on which ONLYOFFICE Apps will run. By default, port 80 is used.
Example
bash apps-enterprise-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 to specify the JWT header and your own JWT secret key when installing ONLYOFFICE Apps Enterprise. 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 ONLYOFFICE Apps -
/app/onlyoffice/config/appsettings.json - For Document Server -
/etc/onlyoffice/documentserver/local.json
Example
bash apps-enterprise-install.sh -js yoursecret
MySQL server
| Parameter | Description | Default |
|---|---|---|
-mysqlrp, --mysqlrootpassword | MySQL server root password | auto-generated |
-mysqlh, --mysqlhost | MySQL server host | localhost |
-mysqlport, --mysqlport | MySQL server port number | 3306 |
If you do not explicitly specify the host and port, the default values are used. The root password is generated automatically if you do not set it.
Example
bash apps-enterprise-install.sh -mysqlrp new-secret-pw
This command allows you to set your own password for the MySQL root account during the ONLYOFFICE Apps Enterprise installation.
ONLYOFFICE Apps database
| Parameter | Description | Default |
|---|---|---|
-mysqld, --mysqldatabase | ONLYOFFICE Apps database name | onlyoffice_apps |
-mysqlu, --mysqluser | ONLYOFFICE Apps database user | - |
-mysqlp, --mysqlpassword | ONLYOFFICE Apps database password | auto-generated |
These parameters allow you to create the ONLYOFFICE Apps 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 the database name, the default value is used. If you do not set a password, it is generated automatically.
Example
bash apps-enterprise-install.sh -mysqld appsdatabase -mysqlu username -mysqlp password
RabbitMQ server
| Parameter | Description | Default |
|---|---|---|
--rabbitmqprotocol | RabbitMQ connection protocol | amqp |
--rabbitmqhost | RabbitMQ server host | localhost |
--rabbitmqport | RabbitMQ server port number | 5672 |
--rabbitmqusername | RabbitMQ user name | - |
--rabbitmqpassword | RabbitMQ user password | - |
--rabbitmqvirtualhost | RabbitMQ virtual host | / |
Use these parameters to connect ONLYOFFICE Apps to a RabbitMQ server that is already running on another machine. Skip the RabbitMQ installation with the -irbt false parameter, then specify the connection parameters of your own server. If you do not explicitly specify the protocol, host, port, or virtual host, the default values are used.
Example
bash apps-enterprise-install.sh -irbt false --rabbitmqhost mq.example.com --rabbitmqusername username --rabbitmqpassword password
This will install ONLYOFFICE Apps without RabbitMQ and connect it to the RabbitMQ server running on the mq.example.com host.
Redis server
| Parameter | Description | Default |
|---|---|---|
--redishost | Redis server host | localhost |
--redisport | Redis server port number | 6379 |
--redisusername | Redis user name, if the server requires authorization | - |
--redispassword | Redis user password, if the server requires authorization | - |
Use these parameters to connect ONLYOFFICE Apps to a Redis server that is already running on another machine. Skip the Redis installation with the -irds false parameter, then specify the connection parameters of your own server. The user name and password are only needed if your Redis server requires authorization.
Example
bash apps-enterprise-install.sh -irds false --redishost redis.example.com --redispassword password
This will install ONLYOFFICE Apps without Redis and connect it to the Redis server running on the redis.example.com host.
OpenSearch server
| Parameter | Description | Default |
|---|---|---|
--elasticprotocol | OpenSearch connection protocol | http |
--elasticport | OpenSearch server port number | 9200 |
Use these parameters together with the -esh, --elastichost parameter described in the Setting for hosts section above to connect ONLYOFFICE Apps to an OpenSearch server running on another machine. If you do not explicitly specify the protocol and port, the default values are used.
Example
bash apps-enterprise-install.sh -esh search.example.com --elasticprotocol https --elasticport 9200
This will connect ONLYOFFICE Apps to the OpenSearch server running on the search.example.com host over HTTPS.
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 workspace to HTTPS. They can be used for the Docker version only.
Example
bash apps-enterprise-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 apps-enterprise-install.sh docker --certfile path --certkeyfile path
This will apply your own SSL certificate.