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