Установка ONLYOFFICE Apps Developer с параметрами скрипта
Введение
ONLYOFFICE Apps Developer — это платная версия хаба документов, в котором можно объединить пользователей и документы в одном месте, чтобы упростить совместную работу.
ONLYOFFICE Apps Developer поставляется в виде скрипта автоматической установки для операционных систем Linux с установленным Docker. Скрипт настроит контейнеры Docker со всеми компонентами, необходимыми для правильной работы ONLYOFFICE Apps Developer, и прост в запуске, управлении и обновлении.
После скачивания скрипта установки ONLYOFFICE Apps Developer вам может потребоваться запустить его с некоторыми дополнительными параметрами, например, если вы хотите установить каждый компонент на отдельном компьютере.
Используйте следующую команду, чтобы вывести список всех доступных параметров скрипта для Docker:
bash apps-developer-install.sh docker -h
Используйте следующую команду, чтобы вывести список всех доступных параметров скрипта для DEB/RPM:
bash apps-developer-install.sh package -h
Ниже приведено краткое описание этих параметров и примеры их использования.
При запуске скрипта с параметрами вам будет предложено выбрать способ установки ONLYOFFICE Apps. Введите Y и нажмите Enter, чтобы установить ONLYOFFICE Apps с помощью Docker. Введите N и нажмите Enter, чтобы установить ONLYOFFICE Apps из пакетов DEB/RPM.
Учетные данные
| Параметр | Описание |
|---|---|
-reg, --registry | URL-адрес реестра Docker (например, https://myregistry.com:5000) |
-un, --username | логин для реестра Docker |
-p, --password | пароль для реестра Docker |
Эти параметры используются в том случае, если мы предоставляем вам учетные данные для доступа к тестовому репозиторию, чтобы вы могли запускать контейнеры из хранящихся в нем образов.
Пример
bash apps-developer-install.sh -reg URL -un username -p password
Тип установки
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-it, --installationtype | тип установки | community|developer|enterprise | developer |
Этот параметр позволяет установить указанное решение: ONLYOFFICE Apps Community, ONLYOFFICE Apps Developer или ONLYOFFICE Apps Enterprise.
Пример
bash apps-developer-install.sh -it community
Это установит решение ONLYOFFICE Apps Community.
Проверка оборудования
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-skiphc, --skiphardwarecheck | используется для пропуска проверки оборудования | true|false | false |
Этот параметр позволяет пропустить проверку того, соответствует ли система минимальным требованиям к оборудованию.
Пример
bash apps-developer-install.sh -skiphc true
Это пропустит проверку оборудования.
Обновление компонентов
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-u, --update | используется для обновления существующих компонентов | true|false | false |
Этот параметр позволяет установить последние версии необходимых компонентов, если соответствующие компоненты, установленные на вашем компьютере, устарели.
Пример
bash apps-developer-install.sh -u true
Это последовательно остановит те контейнеры, которые необходимо обновить, удалит их, а затем запустит последние версии соответствующих компонентов ONLYOFFICE Apps Developer. Если текущая версия компонента совпадает с последней доступной, этот контейнер затронут не будет. Если при предыдущей установке вы пропустили некоторые компоненты, они также будут пропущены. Данные ONLYOFFICE Apps должны подхватиться автоматически.
Обновите только Docs до версии 7.2.1.34 и пропустите обновление всех остальных компонентов:
bash apps-developer-install.sh -u true -docsi onlyoffice/documentserver-de -docsv 7.2.1.34 -idocs true -ia false -irbt false -irds false
Обновите только ONLYOFFICE Apps до версии 1.2.0 и пропустите обновление всех остальных компонентов:
bash apps-developer-install.sh -u true -asv v1.2.0 -idocs false -irbt false -irds false
Установка компонентов
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-ia, --installapps | установить ONLYOFFICE Apps | true|false | true |
-idocs, --installdocs | установить ONLYOFFICE Docs | true|false | true |
-irbt, --installrabbitmq | установить RabbitMQ | true|false | true |
-irds, --installredis | установить Redis | true|false | true |
-imysql, --installmysql | установить MySQL | true|false | true |
Эти параметры позволяют указать, нужно ли устанавливать тот или иной компонент. Их можно использовать, если вы хотите установить каждый компонент на отдельном компьютере.
- Используйте значение
true, чтобы установить компонент. - Используйте значение
false, чтобы пропустить установку компонента.
Пример
bash apps-developer-install.sh -idocs false
Это установит все компоненты ONLYOFFICE Apps Developer, кроме ONLYOFFICE Docs.
bash apps-developer-install.sh -ia false -idocs true -imysql false -irbt false -irds false
Это пропустит установку ONLYOFFICE Apps, MySQL, RabbitMQ и Redis и установит только ONLYOFFICE Docs.
Версия компонентов
| Параметр | Описание |
|---|---|
-asv, --appsversion | версия ONLYOFFICE Apps |
-docsv, --docsversion | версия ONLYOFFICE Docs |
Эти параметры можно использовать, чтобы установить определенную версию ONLYOFFICE Apps или ONLYOFFICE Docs, если по каким-либо причинам вы не хотите устанавливать последнюю версию, доступную в репозитории. По умолчанию для запуска контейнера компонента используется образ с тегом latest.
Пример
Откройте репозиторий Docker Hub в браузере, выберите ONLYOFFICE Docs и перейдите на вкладку Tags, чтобы просмотреть все теги, доступные в репозитории. Укажите версию, которую вы хотите установить:
bash apps-developer-install.sh -docsv 7.2.1.34
Это установит ONLYOFFICE Apps с ONLYOFFICE Docs версии 7.2.1.34.
Имя образа ONLYOFFICE Docs
| Параметр | Описание |
|---|---|
-docsi, --docsimage | имя образа ONLYOFFICE Docs |
Этот параметр можно использовать, чтобы указать имя образа ONLYOFFICE Docs, из которого должен быть запущен контейнер. Указанный образ должен храниться в нашем официальном общедоступном репозитории на Docker Hub.
Пример
bash apps-developer-install.sh -docsi onlyoffice/documentserver-de
Это запустит контейнер из указанного образа ONLYOFFICE Docs, хранящегося в репозитории.
Настройка хостов
| Параметр | Описание |
|---|---|
-ash, --appshost | хост ONLYOFFICE Apps |
-esh, --elastichost | хосты OpenSearch |
Эти параметры можно использовать для соединения компонентов, если вы устанавливаете их на отдельных компьютерах.
Пример
bash apps-developer-install.sh -esh 192.168.3.202
Это установит ONLYOFFICE Apps и подключит его к OpenSearch, установленному на другом компьютере с IP-адресом 192.168.3.202.
Настройка core.machinekey
| Параметр | Описание |
|---|---|
-mk, --machinekey | Настройка ключа core.machinekey |
Этот параметр позволяет указать собственный machinekey при установке ONLYOFFICE Apps Developer.
Этот параметр записывается в файл конфигурации /app/onlyoffice/config/appsettings.json (путь указан внутри контейнера onlyoffice-studio).
Пример
bash apps-developer-install.sh -mk yourmachinekey
Внешний порт ONLYOFFICE Apps
| Параметр | Описание | По умолчанию |
|---|---|---|
-ep, --externalport | внешний порт ONLYOFFICE Apps | 80 |
Этот параметр позволяет изменить порт, на котором будет работать ONLYOFFICE Apps. По умолчанию используется порт 80.
Пример
bash apps-developer-install.sh -ep 8080
Настройки заголовка и секретного ключа JWT
| Параметр | Описание |
|---|---|
-jh, --jwtheader | Настройка заголовка JWT |
-js, --jwtsecret | Настройка секретного ключа JWT |
Эти параметры позволяют указать заголовок JWT и собственный секретный ключ JWT при установке ONLYOFFICE Apps Developer. Заголовок JWT определяет HTTP-заголовок, который будет использоваться для отправки JWT. Секретный ключ используется для подписи веб-токена JSON и проверки токена при запросе к ONLYOFFICE Docs.
Эти параметры записываются в следующие файлы конфигурации (пути указаны внутри контейнеров onlyoffice-studio и onlyoffice-document-server):
- Для ONLYOFFICE Apps —
/app/onlyoffice/config/appsettings.json - Для Document Server —
/etc/onlyoffice/documentserver/local.json
Пример
bash apps-developer-install.sh -js yoursecret
Сервер MySQL
| Параметр | Описание | По умолчанию |
|---|---|---|
-mysqlrp, --mysqlrootpassword | пароль root сервера MySQL | генерируется автоматически |
-mysqlh, --mysqlhost | хост сервера MySQL | localhost |
-mysqlport, --mysqlport | номер порта сервера MySQL | 3306 |
Если хост и порт явно не указаны, используются значения по умолчанию. Пароль root генерируется автоматически, если вы не задали его.
Пример
bash apps-developer-install.sh -mysqlrp new-secret-pw
Эта команда позволяет задать собственный пароль для учетной записи root MySQL во время установки ONLYOFFICE Apps Developer.
База данных ONLYOFFICE Apps
| Параметр | Описание | По умолчанию |
|---|---|---|
-mysqld, --mysqldatabase | имя базы данных ONLYOFFICE Apps | onlyoffice_apps |
-mysqlu, --mysqluser | пользователь базы данных ONLYOFFICE Apps | - |
-mysqlp, --mysqlpassword | пароль базы данных ONLYOFFICE Apps | генерируется автоматически |
Эти параметры позволяют создать базу данных ONLYOFFICE Apps, указав собственное имя базы данных, а также имя пользователя и пароль для учетной записи с правами суперпользователя в созданной базе данных. Если имя базы данных явно не указано, используется значение по умолчанию. Если пароль не задан, он генерируется автоматически.
Пример
bash apps-developer-install.sh -mysqld appsdatabase -mysqlu username -mysqlp password
Сервер RabbitMQ
| Параметр | Описание | По умолчанию |
|---|---|---|
--rabbitmqprotocol | протокол подключения к RabbitMQ | amqp |
--rabbitmqhost | хост сервера RabbitMQ | localhost |
--rabbitmqport | номер порта сервера RabbitMQ | 5672 |
--rabbitmqusername | имя пользователя RabbitMQ | - |
--rabbitmqpassword | пароль пользователя RabbitMQ | - |
--rabbitmqvirtualhost | виртуальный хост RabbitMQ | / |
Используйте эти параметры, чтобы подключить ONLYOFFICE Apps к серверу RabbitMQ, который уже запущен на другом компьютере. Пропустите установку RabbitMQ с помощью параметра -irbt false, затем укажите параметры подключения к вашему серверу. Если протокол, хост, порт или виртуальный хост явно не указаны, используются значения по умолчанию.
Пример
bash apps-developer-install.sh -irbt false --rabbitmqhost mq.example.com --rabbitmqusername username --rabbitmqpassword password
Это установит ONLYOFFICE Apps без RabbitMQ и подключит его к серверу RabbitMQ, работающему на хосте mq.example.com.
Сервер Redis
| Параметр | Описание | По умолчанию |
|---|---|---|
--redishost | хост сервера Redis | localhost |
--redisport | номер порта сервера Redis | 6379 |
--redisusername | имя пользователя Redis, если сервер требует авторизации | - |
--redispassword | пароль пользователя Redis, если сервер требует авторизации | - |
Используйте эти параметры, чтобы подключить ONLYOFFICE Apps к серверу Redis, который уже запущен на другом компьютере. Пропустите установку Redis с помощью параметра -irds false, затем укажите параметры подключения к вашему серверу. Имя пользователя и пароль нужны, только если ваш сервер Redis требует авторизации.
Пример
bash apps-developer-install.sh -irds false --redishost redis.example.com --redispassword password
Это установит ONLYOFFICE Apps без Redis и подключит его к серверу Redis, работающему на хосте redis.example.com.
Сервер OpenSearch
| Параметр | Описание | По умолчанию |
|---|---|---|
--elasticprotocol | протокол подключения к OpenSearch | http |
--elasticport | номер порта сервера OpenSearch | 9200 |
Используйте эти параметры вместе с параметром -esh, --elastichost, описанным выше в разделе «Настройка хостов», чтобы подключить ONLYOFFICE Apps к серверу OpenSearch, работающему на другом компьютере. Если протокол и порт явно не указаны, используются значения по умолчанию.
Пример
bash apps-developer-install.sh -esh search.example.com --elasticprotocol https --elasticport 9200
Это подключит ONLYOFFICE Apps к серверу OpenSearch, работающему на хосте search.example.com, по протоколу HTTPS.
Переключение на HTTPS
| Параметр | Описание |
|---|---|
-led, --letsencryptdomain | определяет домен для сертификата Let's Encrypt |
-lem, --letsencryptmail | определяет адрес электронной почты администратора домена для сертификата Let's Encrypt |
-cf, --certfile | путь к файлу сертификата для домена |
-ckf, --certkeyfile | путь к файлу закрытого ключа для сертификата |
Эти параметры позволяют переключить рабочее пространство на протокол HTTPS. Их можно использовать только для Docker-версии.
Пример
bash apps-developer-install.sh docker --letsencryptmail user@example.com --letsencryptdomain yourdomain.com
Это автоматически создаст и установит на ваш сервер сертификат, подписанный центром сертификации letsencrypt.org, а также перезапустит сервис NGINX, чтобы изменения вступили в силу.
bash apps-developer-install.sh docker --certfile path --certkeyfile path
Это применит ваш собственный сертификат SSL.