使用附加脚本参数安装 ONLYOFFICE Workspace 社区版
介绍
ONLYOFFICE Workspace 社区版 是一个免费的协作系统版本，旨在将文档管理、项目管理、客户关系和电子邮件通信整合到一个平台中。
ONLYOFFICE Workspace 社区版 作为一个自动安装脚本提供，适用于安装了 Docker 的 Linux 操作系统。该脚本将设置包含所有必要组件的 Docker 容器，以确保 ONLYOFFICE Workspace 社区版 的正常运行，并且易于运行、管理和更新。
下载 ONLYOFFICE Workspace 社区版 安装脚本后，您可能需要使用附加参数运行它，例如，将每个组件安装在单独的服务器上。使用以下命令显示所有可用脚本参数的列表：
bash workspace-install.sh -h
下面是这些参数的简短说明和一些使用示例。
镜像名称
| 参数 | 描述 |
|---|---|
-ci, --communityimage | ONLYOFFICE Community Server 镜像名称 |
-di, --documentimage | ONLYOFFICE Docs 镜像名称 |
-mi, --mailimage | ONLYOFFICE 邮件 镜像名称 |
-cpi, --controlpanelimage | ONLYOFFICE 控制面板 镜像名称 |
这些参数用于指定启动容器所用的镜像名称。指定的镜像必须在 Docker Hub 的官方公共仓库中可用。
示例
bash workspace-install.sh -ims false -di onlyoffice/documentserver -ics true -icp true
这将从仓库中存储的指定 ONLYOFFICE Docs 镜像运行容器，同时运行 ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板 容器。
组件版本
| 参数 | 描述 |
|---|---|
-cv, --communityversion | ONLYOFFICE Community Server 版本 |
-dv, --documentversion | ONLYOFFICE Docs 版本 |
-mv, --mailversion | ONLYOFFICE 邮件 版本 |
-cpv, --controlpanelversion | ONLYOFFICE 控制面板 版本 |
如果您不想使用仓库中可用的最新版本，这些参数允许您安装特定的组件版本。默认情况下，使用标记为 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 控制面板 1.6.0.52 版本以及最新版本的 ONLYOFFICE 邮件，因为未明确指定其版本。
服务器 IP
| 参数 | 描述 |
|---|---|
-dip, --documentserverip | ONLYOFFICE Docs IP 地址 |
-mip, --mailserverip | ONLYOFFICE 邮件 IP 地址 |
-mdbip, --mailserverdbip | ONLYOFFICE 邮件 数据库 IP 地址 |
如果您将组件安装在不同的机器上，可以使用这些参数来连接它们。
示例
bash workspace-install.sh -ics true -icp true -ids false -ims false -dip 192.168.3.202 -es false
这将安装 ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板，并将其与安装在另一台 IP 地址为 192.168.3.202 的机器上的 ONLYOFFICE Docs 连接。
ONLYOFFICE 邮件域名
| 参数 | 描述 |
|---|---|
-md, --maildomain | ONLYOFFICE 邮件 域名 |
此参数允许您指定用于 ONLYOFFICE 邮件 的自定义域名。
示例
bash workspace-install.sh -md "yourdomain.com"
这将安装所有 ONLYOFFICE Workspace 社区版 组件，包括指定了 yourdomain.com 域名的 ONLYOFFICE 邮件。
用于维护通信的域名必须有效并配置在此机器上（即，它应在 DNS 设置中有适当的 A 记录，将您的域名指向安装 ONLYOFFICE 邮件 的机器的 IP 地址）。
在上述命令中，"yourdomain.com" 参数应理解为 ONLYOFFICE 邮件的服务域。通常在将用于维护通信的域的 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 邮件 | true|false|pull | true |
-icp, --installcontrolpanel | 安装 ONLYOFFICE 控制面板 | true|false|pull | true |
这些参数允许您指定是否安装某个组件。它们可用于将每个组件安装在单独的服务器上。
- 使用
true值安装组件。 - 使用
false值跳过组件安装。 - 使用
pull值下载组件而不安装。
示例
bash workspace-install.sh -ims false
这将安装不含 ONLYOFFICE 邮件 的所有 ONLYOFFICE Workspace 组件。
bash workspace-install.sh -ics false -ids true -icp false -ims false -es true
这将跳过 ONLYOFFICE 邮件、ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板 的安装，仅安装 ONLYOFFICE Docs。
安装类型
| 参数 | 描述 | 值 | 默认值 |
|---|---|---|---|
-it, --installation_type | 安装类型 | WORKSPACE|WORKSPACE_ENTERPRISE | WORKSPACE_ENTERPRISE |
此参数用于安装指定的解决方案：ONLYOFFICE Workspace 或 ONLYOFFICE Workspace 企业版。
示例
bash workspace-install.sh -it GROUPS
这将安装 ONLYOFFICE Workspace 解决方案，其中包括 ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板 组件。
将组件用作外部服务器
| 参数 | 描述 | 值 | 默认值 |
|---|---|---|---|
-es, --useasexternalserver | 用作外部服务器 | true|false | false |
此参数用于将组件安装在单独的服务器上。
- 将 ONLYOFFICE Docs 和 ONLYOFFICE 邮件 安装在不同机器上时，使用
true值。 - 将 ONLYOFFICE Community Server 与 ONLYOFFICE 控制面板 一起安装在单独的机器上时，使用
false值。
示例
bash workspace-install.sh -ics false -ids false -icp false -ims true -md "yourdomain.com" -es true
这将跳过 ONLYOFFICE Docs、ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板 的安装，仅安装 ONLYOFFICE 邮件。
bash workspace-install.sh -ics true -icp true -ids false -ims false -dip 192.168.3.202 -es false
这将安装 ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板，并将其与安装在另一台机器上的 ONLYOFFICE Docs 连接。
创建交换文件
| 参数 | 描述 | 值 | 默认值 |
|---|---|---|---|
-ms, --makeswap | 创建交换文件 | true|false | false |
此参数用于创建 6 GB 的交换文件。默认情况下指定为 true 值，因此运行脚本时无需指定此参数。交换文件将自动创建。
示例
bash workspace-install.sh -ms false
如果交换文件已经存在，请使用此命令以防止在安装过程中创建新的交换文件。
如果您在不带 -ms 参数的情况下再次运行脚本，它会检查 onlyoffice_swapfile 是否存在。如果交换文件已经存在，脚本将不会再次创建交换文件。
MySQL 服务器
| 参数 | 描述 | 默认值 |
|---|---|---|
-mysqlh, --mysqlhost | MySQL 服务器主机 | localhost |
-mysqlprt, --mysqlport | MySQL 服务器端口 | 3306 |
-mysqlru, --mysqlrootuser | MySQL 服务器 root 用户 | root |
-mysqlrp, --mysqlrootpassword | MySQL 服务器 root 密码 | my-secret-pw |
如果您未明确指定这些参数，则使用默认值。
示例
bash workspace-install.sh -mysqlru root -mysqlrp new-secret-pw
此命令在 ONLYOFFICE Workspace 安装期间为 MySQL root 帐户设置自定义密码。
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 邮件数据库
| 参数 | 描述 | 默认值 |
|---|---|---|
-mysqlmd, --mysqlmaildatabase | ONLYOFFICE 邮件 数据库名称 | onlyoffice_mailserver |
-mysqlmu, --mysqlmailuser | ONLYOFFICE 邮件 数据库用户 | mail_admin |
-mysqlmp, --mysqlmailpassword | ONLYOFFICE 邮件 数据库密码 | Isadmin123 |
这些参数允许创建 ONLYOFFICE 邮件 数据库，可指定自定义数据库名称，以及在所创建数据库上具有超级用户权限的帐户的用户名和密码。如果您未明确指定这些参数，则使用默认值。
示例
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 密钥设置 |
此参数允许您在安装 ONLYOFFICE Workspace 社区版时指定自定义 machinekey。
此参数将写入 /app/onlyoffice/CommunityServer/data/.private/machinekey 配置文件。
示例
bash workspace-install.sh -mk yourmachinekey
JWT 密钥设置
| 参数 | 描述 |
|---|---|
-jwt, --jwtsecret | JWT 密钥设置 |
此参数允许您在安装 ONLYOFFICE Workspace 社区版 时指定自定义 JWT 密钥。该密钥用于对 JSON Web 令牌进行签名，并在向 ONLYOFFICE Docs 发出请求时验证令牌。
此参数将写入以下配置文件（路径是在容器内指定的）：
- 对于 Community Server -
/var/www/onlyoffice/WebStudio/web.appsettings.config - 对于 Document Server -
/etc/onlyoffice/documentserver/local.json
示例
bash workspace-install.sh -jwt yoursecret