Установка ONLYOFFICE Apps Community с параметрами скрипта
Введение
ONLYOFFICE Apps Community — это бесплатная версия центра документов, где можно объединить пользователей и документы в одном месте для более эффективной совместной работы.
ONLYOFFICE Apps Community поставляется в виде скрипта автоматической установки для операционных систем Linux с установленным Docker. Скрипт развернет Docker-контейнеры со всеми компонентами, необходимыми для корректной работы ONLYOFFICE Apps Community; такую установку легко запускать, администрировать и обновлять.
После скачивания скрипта установки ONLYOFFICE Apps Community его может понадобиться запустить с дополнительными параметрами, например, если вы хотите установить каждый компонент на отдельной машине.
Чтобы вывести список всех доступных параметров скрипта для Docker, используйте следующую команду:
bash apps-install.sh docker -h
Чтобы вывести список всех доступных параметров скрипта для DEB/RPM, используйте следующую команду:
bash apps-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-install.sh -reg URL -un username -p password
Тип установки
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-it, --installationtype | тип установки | community|developer|enterprise | community |
Этот параметр позволяет установить указанное решение: ONLYOFFICE Apps Community, ONLYOFFICE Apps Developer или ONLYOFFICE Apps Enterprise.
Пример
bash apps-install.sh -it enterprise
Будет установлено решение ONLYOFFICE Apps Enterprise.
Проверка оборудования
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-skiphc, --skiphardwarecheck | используйте, чтобы пропустить проверку оборудования | true|false | false |
Этот параметр позволяет пропустить проверку соответствия системы минимальным требованиям к оборудованию.
Пример
bash apps-install.sh -skiphc true
Проверка оборудования будет пропущена.
Обновление компонентов
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-u, --update | используйте для обновления существующих компонентов | true|false | false |
Этот параметр позволяет установить последние версии необходимых компонентов, если соответствующие компоненты, установленные на вашей машине, устарели.
Пример
bash apps-install.sh -u true
Скрипт последовательно остановит контейнеры, которые необходимо обновить, удалит их, а затем запустит последние версии соответствующих компонентов ONLYOFFICE Apps Community. Если текущая версия компонента совпадает с последней доступной, такой контейнер затронут не будет. Если во время предыдущей установки вы пропустили какие-то компоненты, они также будут пропущены. Данные ONLYOFFICE Apps должны подхватиться автоматически.
Обновите только Docs до версии 7.2.1.34 и пропустите обновление всех остальных компонентов:
bash apps-install.sh -u true -docsi onlyoffice/documentserver -docsv 7.2.1.34 -idocs true -ia false -irbt false -irds false
Обновите только ONLYOFFICE Apps до версии 1.2.0 и пропустите обновление всех остальных компонентов:
bash apps-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-install.sh -idocs false
Будут установлены все компоненты ONLYOFFICE Apps Community, кроме ONLYOFFICE Docs.
bash apps-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-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-install.sh -docsi onlyoffice/documentserver
Будет запущен контейнер из указанного образа ONLYOFFICE Docs, хранящегося в репозитории.
Настройка хостов
| Параметр | Описание |
|---|---|
-ash, --appshost | хост ONLYOFFICE Apps |
-esh, --elastichost | хосты OpenSearch |
Эти параметры можно использовать для соединения компонентов, если вы устанавливаете их на отдельных машинах.
Пример
bash apps-install.sh -esh 192.168.3.202
Будет установлено ONLYOFFICE Apps и выполнено подключение к OpenSearch, установленному на другой машине с IP-адресом 192.168.3.202.
Настройка core.machinekey
| Параметр | Описание |
|---|---|
-mk, --machinekey | настройка ключа core.machinekey |
Этот параметр позволяет указать собственный machinekey при установке ONLYOFFICE Apps Community.
Этот параметр записывается в файл конфигурации /app/onlyoffice/config/appsettings.json (путь указан внутри контейнера onlyoffice-studio).
Пример
bash apps-install.sh -mk yourmachinekey
Внешний порт ONLYOFFICE Apps
| Параметр | Описание | По умолчанию |
|---|---|---|
-ep, --externalport | внешний порт ONLYOFFICE Apps | 80 |
Этот параметр позволяет изменить порт, на котором будет работать ONLYOFFICE Apps. По умолчанию используется порт 80.
Пример
bash apps-install.sh -ep 8080
Настройки заголовка и секретного ключа JWT
| Параметр | Описание |
|---|---|
-jh, --jwtheader | настройка заголовка JWT |
-js, --jwtsecret | настройка секретного ключа JWT |
Эти параметры позволяют указать заголовок JWT и собственный секретный ключ JWT при установке ONLYOFFICE Apps Community. Заголовок JWT определяет HTTP-заголовок, который будет использоваться для отправки JWT. Секретный ключ используется для подписи токена JSON Web Token и проверки токена при запросе к ONLYOFFICE Docs.
Эти параметры записываются в следующие файлы конфигурации (пути указаны внутри контейнеров onlyoffice-studio и onlyoffice-document-server):
- Для ONLYOFFICE Apps —
/app/onlyoffice/config/appsettings.json - Для Document Server —
/etc/onlyoffice/documentserver/local.json
Пример
bash apps-install.sh -js yoursecret
Сервер MySQL
| Параметр | Описание | По умолчанию |
|---|---|---|
-mysqlrp, --mysqlrootpassword | пароль root сервера MySQL | auto-generated |
-mysqlh, --mysqlhost | хост сервера MySQL | localhost |
-mysqlport, --mysqlport | номер порта сервера MySQL | 3306 |
Если вы явно не укажете хост и порт, используются значения по умолчанию. Пароль root генерируется автоматически, если вы его не задали.
Пример
bash apps-install.sh -mysqlrp new-secret-pw
Эта команда позволяет задать собственный пароль для учетной записи root MySQL во время установки ONLYOFFICE Apps Community.
База данных ONLYOFFICE Apps
| Параметр | Описание | По умолчанию |
|---|---|---|
-mysqld, --mysqldatabase | имя базы данных ONLYOFFICE Apps | onlyoffice_apps |
-mysqlu, --mysqluser | пользователь базы данных ONLYOFFICE Apps | - |
-mysqlp, --mysqlpassword | пароль базы данных ONLYOFFICE Apps | генерируется автоматически |
Эти параметры позволяют создать базу данных ONLYOFFICE Apps с указанием пользовательского имени базы данных, а также имени пользователя и пароля для учетной записи с правами суперпользователя в созданной базе данных. Если вы явно не укажете имя базы данных, используется значение по умолчанию. Если вы не зададите пароль, он генерируется автоматически.
Пример
bash apps-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-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-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-install.sh -esh search.example.com --elasticprotocol https --elasticport 9200
ONLYOFFICE Apps будет подключено по HTTPS к серверу OpenSearch, работающему на хосте search.example.com.
Переключение на HTTPS
| Параметр | Описание |
|---|---|
-led, --letsencryptdomain | определяет домен для сертификата Let's Encrypt |
-lem, --letsencryptmail | определяет адрес электронной почты администратора домена для сертификата Let's Encrypt |
-cf, --certfile | путь к файлу сертификата для домена |
-ckf, --certkeyfile | путь к файлу закрытого ключа для сертификата |
Эти параметры позволяют переключить рабочее пространство на HTTPS. Их можно использовать только для версии Docker.
Пример
bash apps-install.sh docker --letsencryptmail user@example.com --letsencryptdomain yourdomain.com
Будет автоматически создан и установлен на ваш сервер сертификат, подписанный центром сертификации letsencrypt.org, и перезапущена служба NGINX, чтобы изменения вступили в силу.
bash apps-install.sh docker --certfile path --certkeyfile path
Будет применен ваш собственный SSL-сертификат.