使用附加脚本参数安装 ONLYOFFICE 协作空间社区版
介绍
ONLYOFFICE 协作空间社区版 是一个免费的协作系统版本,旨在将文档管理、项目管理、客户关系和电子邮件通信整合到一个平台中。
ONLYOFFICE 协作空间社区版 以自动安装脚本的形式提供,适用于已安装 Docker 的 Linux 操作系统。该脚本将设置包含所有必要组件的 Docker 容器,以确保 ONLYOFFICE 协作空间社区版 的正常运行,并且易于运行、管理和更新。
下载 ONLYOFFICE 协作空间社区版 安装脚本后,您可能需要指定一些附加参数来运行它,例如,如果您希望在不同的机器上安装每个组件。使用以下命令显示所有可用脚本参数的列表:
bash workspace-install.sh -h 您可以在下方找到这些参数的简要说明和一些使用示例。
镜像名称
| 参数 | 描述 |
|---|---|
-ci, --communityimage | ONLYOFFICE Community Server 镜像名称 |
-di, --documentimage | ONLYOFFICE 文档 镜像名称 |
-mi, --mailimage | ONLYOFFICE Mail 镜像名称 |
-cpi, --controlpanelimage | ONLYOFFICE 控制面板 镜像名称 |
这些参数可用于指定容器启动时所用的镜像名称。指定的镜像应存储在我们在 Docker Hub 上的官方公共仓库中。
示例
bash workspace-install.sh -ims false -di onlyoffice/documentserver -ics true -icp true 这将从存储库中指定的 ONLYOFFICE 文档 镜像启动一个容器,并运行 ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板 容器。
组件版本
| 参数 | 描述 |
|---|---|
-cv, --communityversion | ONLYOFFICE Community Server 版本 |
-dv, --documentversion | ONLYOFFICE 文档 版本 |
-mv, --mailversion | ONLYOFFICE Mail 版本 |
-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 Mail,因为其版本未被明确指定。
服务器 IP
| 参数 | 描述 |
|---|---|
-dip, --documentserverip | ONLYOFFICE 文档 IP 地址 |
-mip, --mailserverip | ONLYOFFICE Mail IP 地址 |
-mdbip, --mailserverdbip | ONLYOFFICE Mail 数据库 IP 地址 |
这些参数可用于在将组件安装在不同机器上时进行连接。
示例
bash workspace-install.sh -ics true -icp true -ids false -ims false -dip 192.168.3.202 -es false 这将安装 ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板,并将其与安装在不同机器上的 ONLYOFFICE 文档 连接,该机器的 IP 地址为 192.168.3.202。
ONLYOFFICE Mail 域名
| 参数 | 描述 |
|---|---|
-md, --maildomain | ONLYOFFICE Mail 域名 |
此参数允许指定将用于 ONLYOFFICE Mail 的自定义域名。
示例
bash workspace-install.sh -md "yourdomain.com" 这将安装所有 ONLYOFFICE 协作空间社区版 组件,包括带有指定域名 yourdomain.com 的 ONLYOFFICE Mail。
在上述命令中,
"yourdomain.com" 参数应理解为 ONLYOFFICE Mail 的服务域。通常在用于维护通信的域的 MX 记录 中指定。通常,"yourdomain.com" 看起来像 mx1.onlyoffice.com组件更新
| 参数 | 描述 | 值 | 默认 |
|---|---|---|---|
-u, --update | 用于更新现有组件 | true|false | false |
此参数允许安装必要组件的最新版本,如果您机器上安装的相应组件已过时。
示例
bash workspace-install.sh -u true 这将依次停止需要更新的容器,删除它们,然后运行相应 ONLYOFFICE 协作空间 组件的最新版本。如果当前组件版本与最新可用版本一致,则此类容器将不受影响。如果您在之前的安装中跳过了一些组件,它们也将被跳过。门户数据应自动获取。
凭据
| 参数 | 描述 |
|---|---|
-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 文档 | true|false|pull | true |
-ims, --installmailserver | 安装 ONLYOFFICE Mail | true|false|pull | true |
-icp, --installcontrolpanel | 安装 ONLYOFFICE 控制面板 | true|false|pull | true |
这些参数允许您指定是否需要安装某个组件。如果您希望在不同的机器上安装每个组件,可以使用这些参数。
- 使用
true值安装组件。 - 使用
false值跳过组件安装。 - 使用
pull值下载组件而不安装。
示例
bash workspace-install.sh -ims false 这将安装所有 ONLYOFFICE 协作空间 组件,但不包括 ONLYOFFICE Mail。
bash workspace-install.sh -ics false -ids true -icp false -ims false -es true 这将跳过 ONLYOFFICE Mail、ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板 的安装,仅安装 ONLYOFFICE 文档。
安装类型
| 参数 | 描述 | 值 | 默认 |
|---|---|---|---|
-it, --installation_type | 安装类型 | WORKSPACE|WORKSPACE_ENTERPRISE | WORKSPACE_ENTERPRISE |
此参数允许安装指定的解决方案:ONLYOFFICE 协作空间 或 ONLYOFFICE 协作空间企业版。
示例
bash workspace-install.sh -it GROUPS 这将安装包括 ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板 组件的 ONLYOFFICE 协作空间 解决方案。
将组件用作外部服务器
| 参数 | 描述 | 值 | 默认 |
|---|---|---|---|
-es, --useasexternalserver | 用作外部服务器 | true|false | false |
此参数用于在将组件安装在不同机器上时。
- 在将 ONLYOFFICE 文档 和 ONLYOFFICE Mail 安装在不同机器上时使用
true值。 - 在将 ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板 安装在单独的机器上时使用
false值。
示例
bash workspace-install.sh -ics false -ids false -icp false -ims true -md "yourdomain.com" -es true 这将跳过 ONLYOFFICE 文档、ONLYOFFICE Community Server 和 ONLYOFFICE 控制面板 的安装,仅安装 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 控制面板,并将其与安装在不同机器上的 ONLYOFFICE 文档 连接。
交换文件创建
| 参数 | 描述 | 值 | 默认 |
|---|---|---|---|
-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 |
-mysqlrp, --mysqlrootpassword | MySQL 服务器根密码 | my-secret-pw |
如果您未明确指定这些参数,将使用默认值。
示例
bash workspace-install.sh -mysqlru root -mysqlrp new-secret-pw 此命令允许在 ONLYOFFICE 协作空间 安装期间为 MySQL 根账户设置您自己的密码。
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 键的设置 |
此参数允许在安装 ONLYOFFICE 协作空间社区版时指定您自己的 machinekey。
/app/onlyoffice/CommunityServer/data/.private/machinekey 配置文件。示例
bash workspace-install.sh -mk yourmachinekey JWT 密钥设置
| 参数 | 描述 |
|---|---|
-jwt, --jwtsecret | JWT 密钥的设置 |
此参数允许在安装 ONLYOFFICE 协作空间社区版时指定您自己的 JWT 密钥。该密钥用于签署 JSON web token 并在请求 ONLYOFFICE 文档时验证该 token。
- 对于 Community Server -
/var/www/onlyoffice/WebStudio/web.appsettings.config - 对于 Document Server -
/etc/onlyoffice/documentserver/local.json
示例
bash workspace-install.sh -jwt yoursecret