Установка ONLYOFFICE Workspace Enterprise с параметрами скрипта
Введение
ONLYOFFICE Workspace Enterprise — это платная версия системы для совместной работы, централизованного управления документами, проектами, взаимоотношениями с клиентами и электронной перепиской.
ONLYOFFICE Workspace Enterprise поставляется как скрипт автоматической установки для операционных систем Linux с установленным сервисом Docker. Скрипт установит контейнеры Docker со всеми компонентами, необходимыми для правильной работы ONLYOFFICE Workspace Enterprise. Он легко запускается, настраивается, и его удобно использовать для обновления.
После того как вы скачаете скрипт установки ONLYOFFICE Workspace Enterprise, вам может потребоваться запустить его, указав некоторые дополнительные параметры, например, если вы хотите установить каждый компонент на отдельной машине. Используйте следующую команду, чтобы вывести на экран список всех доступных параметров скрипта:
bash workspace-enterprise-install.sh -h
Ниже приводится краткое описание и примеры использования этих параметров.
Имя образа
| Параметр | Описание |
|---|---|
-ci, --communityimage | имя образа ONLYOFFICE Community Server или путь к файлу .tar.gz |
-di, --documentimage | имя образа ONLYOFFICE Docs или путь к файлу .tar.gz |
-mi, --mailimage | имя образа ONLYOFFICE Mail или путь к файлу .tar.gz |
-cpi, --controlpanelimage | имя образа Панели управления ONLYOFFICE или путь к файлу .tar.gz |
Эти параметры можно использовать, чтобы указать имя образа, из которого требуется запустить контейнер. Указанный образ должен находиться в нашем официальном публичном репозитории на Docker Hub. Если вы скачали архив .tar.gz со страницы Загрузки, можно также указать путь к этому файлу .tar.gz, сохраненному на вашей машине.
Пример
bash workspace-enterprise-install.sh -ims false -di onlyoffice/documentserver-ee -ics true -icp true
В результате будет запущен контейнер из указанного образа ONLYOFFICE Docs, находящегося в репозитории, а также будут запущены контейнеры ONLYOFFICE Community Server и Панели управления ONLYOFFICE.
bash workspace-enterprise-install.sh -ims false -ics true -ci "/home/user/CommunityServer-12.5.2.tar.gz" -ids false -icp true
В результате будет запущен контейнер из указанного локального файла .tar.gz, содержащего образ ONLYOFFICE Community Server, а также будет запущен контейнер Панели управления ONLYOFFICE из образа, находящегося в репозитории Docker Hub.
Версия компонента
| Параметр | Описание |
|---|---|
-cv, --communityversion | версия ONLYOFFICE Community Server |
-dv, --documentversion | версия ONLYOFFICE Docs |
-mv, --mailversion | версия ONLYOFFICE Mail |
-cpv, --controlpanelversion | версия Панели управления ONLYOFFICE |
Эти параметры можно использовать, чтобы установить определенную версию компонента, если вы не хотите устанавливать самую последнюю версию, доступную в репозитории. По умолчанию для запуска контейнера каждого из компонентов используется образ с тегом latest.
Пример
Откройте в браузере репозиторий на Docker Hub, выберите нужный компонент и перейдите на вкладку Tags, чтобы просмотреть все теги, доступные в репозитории. Укажите для нужных компонентов версии, которые требуется установить:
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"
В результате будет установлена версия 8.9.0.150 ONLYOFFICE Community Server, версия 1.6.0.52 Панели управления ONLYOFFICE и самая последняя версия ONLYOFFICE Mail, поскольку его версия не была явно указана.
IP-адрес сервера
| Параметр | Описание |
|---|---|
-dip, --documentserverip | IP-адрес ONLYOFFICE Docs |
-mip, --mailserverip | IP-адрес ONLYOFFICE Mail |
-mdbip, --mailserverdbip | IP-адрес базы данных ONLYOFFICE Mail |
Эти параметры можно использовать для подключения компонентов, если они установлены на разных машинах.
Пример
bash workspace-enterprise-install.sh -ics true -icp true -ids false -ims false -dip 192.168.3.202 -es false
В результате будет установлен ONLYOFFICE Community Server с Панелью управления ONLYOFFICE. Он будет подключен к ONLYOFFICE Docs, установленному на другой машине с IP-адресом 192.168.3.202.
Доменное имя ONLYOFFICE Mail
| Параметр | Описание |
|---|---|
-md, --maildomain | доменное имя ONLYOFFICE Mail |
Этот параметр позволяет задать собственное доменное имя, которое будет использоваться для ONLYOFFICE Mail.
Пример
bash workspace-enterprise-install.sh -md "yourdomain.com"
В результате будут установлены все компоненты ONLYOFFICE Workspace Enterprise, включая ONLYOFFICE Mail, для которого указано доменное имя yourdomain.com.
Домен, который будет использоваться для ведения переписки, должен быть действительным, и он должен быть настроен на эту машину (то есть должен иметь соответствующую A-запись в настройках DNS, связывающую доменное имя с IP-адресом машины, на которой установлен ONLYOFFICE Mail).
В приведенной выше команде под параметром "yourdomain.com" следует понимать служебный домен почтового сервера. Обычно его указывают в MX-записи домена, который будет использоваться для ведения переписки. Как правило, "yourdomain.com" имеет вид mx1.onlyoffice.com
Обновление компонентов
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-u, --update | обновить существующие компоненты | true|false | false |
Этот параметр позволяет установить последние версии нужных компонентов, если соответствующие компоненты, установленные на вашей машине, устарели.
Пример
bash workspace-enterprise-install.sh -u true
В результате те контейнеры, которые требуется обновить, будут последовательно остановлены, удалены, а затем будут запущены последние версии соответствующих компонентов ONLYOFFICE Workspace Enterprise. Если текущая версия компонента совпадает с последней доступной версией, такой контейнер не будет затронут. Если в ходе предыдущей установки вы пропустили какие-то компоненты, они также будут пропущены. Данные портала должны подхватиться автоматически.
Учетные данные
| Параметр | Описание |
|---|---|
-un, --username | имя пользователя учетной записи на Docker Hub |
-p, --password | пароль учетной записи на Docker Hub |
Эти параметры используются в том случае, если мы предоставим вам учетные данные для доступа к тестовому репозиторию, чтобы вы могли запустить контейнеры из находящихся в нем образов.
Пример
bash workspace-enterprise-install.sh -md "yourdomain.com" -un username -p password
Установка компонентов
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-ics, --installcommunityserver | установить ONLYOFFICE Community Server | true|false|pull | true |
-ids, --installdocumentserver | установить ONLYOFFICE Docs | true|false|pull | true |
-ims, --installmailserver | установить ONLYOFFICE Mail | true|false|pull | true |
-icp, --installcontrolpanel | установить Панель управления ONLYOFFICE | true|false|pull | true |
Эти параметры позволяют указать, надо ли устанавливать определенный компонент. Их можно использовать, если вы хотите установить каждый компонент на отдельной машине.
- Используйте значение
true, чтобы установить компонент. - Используйте значение
false, чтобы пропустить установку компонента. - Используйте значение
pull, чтобы скачать компонент, не устанавливая его.
Не пропускайте установку Панели управления ONLYOFFICE при установке ONLYOFFICE Community Server, иначе по завершении установки вы не сможете ввести лицензионный ключ и, например, добавить ONLYOFFICE Mail в вашу копию ONLYOFFICE Workspace Enterprise.
Пример
bash workspace-enterprise-install.sh -ims false
В результате будут установлены все компоненты ONLYOFFICE Workspace Enterprise, кроме ONLYOFFICE Mail.
bash workspace-enterprise-install.sh -ics false -ids true -icp false -ims false -es true
В результате будет пропущена установка ONLYOFFICE Mail, ONLYOFFICE Community Server и Панели управления ONLYOFFICE, а установлен будет только ONLYOFFICE Docs.
Тип установки
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-it, --installation_type | тип установки | WORKSPACE|WORKSPACE_ENTERPRISE | WORKSPACE_ENTERPRISE |
Этот параметр позволяет установить указанное решение: ONLYOFFICE Workspace Community или ONLYOFFICE Workspace Enterprise.
Пример
bash workspace-enterprise-install.sh -it WORKSPACE
В результате будут установлены компоненты ONLYOFFICE Community Server и Панель управления ONLYOFFICE.
Использование компонента в качестве внешнего сервера
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-es, --useasexternalserver | использовать в качестве внешнего сервера | true|false | false |
Этот параметр используется в том случае, если компоненты устанавливаются на разных машинах.
- Используйте значение
trueпри установке ONLYOFFICE Docs и ONLYOFFICE Mail на отдельных машинах. - Используйте значение
falseпри установке ONLYOFFICE Community Server вместе с Панелью управления ONLYOFFICE на отдельной машине.
Пример
bash workspace-enterprise-install.sh -ics false -ids false -icp false -ims true -md "yourdomain.com" -es true
В результате будет пропущена установка ONLYOFFICE Docs, ONLYOFFICE Community Server и Панели управления ONLYOFFICE, а установлен будет только ONLYOFFICE Mail.
bash workspace-enterprise-install.sh -ics true -icp true -ids false -ims false -dip 192.168.3.202 -es false
В результате будет установлен ONLYOFFICE Community Server с Панелью управления ONLYOFFICE. Он будет подключен к ONLYOFFICE Docs, установленному на другой машине.
Создание swap-файла
| Параметр | Описание | Значения | По умолчанию |
|---|---|---|---|
-ms, --makeswap | создать swap-файл | true|false | false |
Этот параметр позволяет создать swap-файл размером 6 ГБ. По умолчанию указано значение true, следовательно, при запуске скрипта не требуется указывать этот параметр. Swap-файл будет создан автоматически.
Пример
bash workspace-enterprise-install.sh -ms false
Если вы создали swap-файл ранее, можно использовать эту команду, чтобы не создавать swap-файл при установке.
Если повторно запускать скрипт, не указывая параметр -ms, он проверяет наличие onlyoffice_swapfile. Если swap-файл уже существует, скрипт не будет создавать swap-файл повторно.
Сервер MySQL
| Параметр | Описание | По умолчанию |
|---|---|---|
-mysqlh, --mysqlhost | хост сервера MySQL | localhost |
-mysqlprt, --mysqlport | порт сервера MySQL | 3306 |
-mysqlru, --mysqlrootuser | пользователь root сервера MySQL | root |
-mysqlrp, --mysqlrootpassword | пароль пользователя root сервера MySQL | my-secret-pw |
Если эти параметры явно не указаны, используются значения по умолчанию.
Пример
bash workspace-enterprise-install.sh -mysqlru root -mysqlrp new-secret-pw
Эта команда позволяет задать собственный пароль для учетной записи root в MySQL при установке ONLYOFFICE Workspace Enterprise.
База данных ONLYOFFICE Community Server
| Параметр | Описание | По умолчанию |
|---|---|---|
-mysqld, --mysqldatabase | имя базы данных ONLYOFFICE Community Server | onlyoffice |
-mysqlu, --mysqluser | пользователь базы данных ONLYOFFICE Community Server | onlyoffice_user |
-mysqlp, --mysqlpassword | пароль пользователя базы данных ONLYOFFICE Community Server | onlyoffice_pass |
Эти параметры позволяют создать базу данных ONLYOFFICE Community Server, указав пользовательское имя базы данных, а также имя пользователя и пароль для учетной записи с правами суперпользователя на созданную базу данных. Если эти параметры явно не указаны, используются значения по умолчанию.
Пример
bash workspace-enterprise-install.sh -mysqld communitydatabase -mysqlu username -mysqlp password
База данных ONLYOFFICE Mail
| Параметр | Описание | По умолчанию |
|---|---|---|
-mysqlmd, --mysqlmaildatabase | имя базы данных ONLYOFFICE Mail | onlyoffice_mailserver |
-mysqlmu, --mysqlmailuser | пользователь базы данных ONLYOFFICE Mail | mail_admin |
-mysqlmp, --mysqlmailpassword | пароль пользователя базы данных ONLYOFFICE Mail | Isadmin123 |
Эти параметры позволяют создать базу данных ONLYOFFICE Mail, указав пользовательское имя базы данных, а также имя пользователя и пароль для учетной записи с правами суперпользователя на созданную базу данных. Если эти параметры явно не указаны, используются значения по умолчанию.
Пример
bash workspace-enterprise-install.sh -md "mx.yourdomain.com" -mysqlmd maildatabase -mysqlmu username -mysqlmp password
Порт ONLYOFFICE Community Server
| Параметр | Описание | По умолчанию |
|---|---|---|
-cp, --communityport | порт ONLYOFFICE Community Server | 80 |
Этот параметр позволяет изменить порт, на котором будет запущен ONLYOFFICE Community Server. По умолчанию используется порт 80.
Пример
bash workspace-enterprise-install.sh -cp 8080
Настройка для core.machinekey
| Параметр | Описание |
|---|---|
-mk, --machinekey | настройка для ключа core.machinekey |
Этот параметр позволяет задать собственный machinekey при установке ONLYOFFICE Workspace Enterprise.
Этот параметр записывается в файл конфигурации /app/onlyoffice/CommunityServer/data/.private/machinekey.
Пример
bash workspace-enterprise-install.sh -mk yourmachinekey
Настройка для секретного ключа JWT
| Параметр | Описание |
|---|---|
-jwt, --jwtsecret | настройка для секретного ключа JWT |
Этот параметр позволяет задать собственный секретный ключ JWT при установке ONLYOFFICE Workspace Enterprise. Секретный ключ используется для подписи веб-токена JSON и проверки токена при запросах к ONLYOFFICE Docs.
Этот параметр записывается в следующие файлы конфигурации (пути указаны внутри контейнеров):
- Для Community Server —
/var/www/onlyoffice/WebStudio/web.appsettings.config - Для Document Server —
/etc/onlyoffice/documentserver/local.json
Пример
bash workspace-enterprise-install.sh -jwt yoursecret