使用附加脚本参数安装 ONLYOFFICE Apps开发者版
介绍
ONLYOFFICE Apps开发者版是一个付费版本的文档中心，您可以将用户和文档连接在一个地方以促进协作。
ONLYOFFICE Apps开发者版作为适用于安装了 Docker 的 Linux 操作系统的自动安装脚本提供。该脚本将设置包含 ONLYOFFICE Apps开发者版正常工作所需所有组件的 Docker 容器，并且易于运行、管理和更新。
下载 ONLYOFFICE Apps开发者版安装脚本后，您可能需要指定一些附加参数来运行它，例如，如果您希望将每个组件安装在单独的机器上。
使用以下命令显示所有可用 Docker 脚本参数的列表：
bash apps-developer-install.sh docker -h
使用以下命令显示所有可用 DEB/RPM 脚本参数的列表：
bash apps-developer-install.sh package -h
您可以在下面找到这些参数的简要说明和一些使用示例。
当您带参数运行脚本时，系统将提示您选择安装 ONLYOFFICE Apps的方式。输入 Y 并按 Enter 使用 Docker 安装 ONLYOFFICE Apps。输入 N 并按 Enter 从 DEB/RPM 软件包安装 ONLYOFFICE Apps。
凭证
| 参数 | 描述 |
|---|---|
-reg, --registry | docker registry URL (例如 https://myregistry.com:5000) |
-un, --username | docker registry 登录名 |
-p, --password | docker registry 密码 |
当我们向您提供访问测试仓库的凭证时，这些参数用于运行存储在该仓库中的镜像容器。
示例
bash apps-developer-install.sh -reg URL -un username -p password
安装类型
| 参数 | 描述 | 值 | 默认值 |
|---|---|---|---|
-it, --installationtype | 安装类型 | community|developer|enterprise | developer |
此参数允许您安装指定的解决方案：ONLYOFFICE Apps社区版、ONLYOFFICE Apps开发者版或 ONLYOFFICE Apps企业版。
示例
bash apps-developer-install.sh -it community
这将安装 ONLYOFFICE Apps社区版解决方案。
硬件检查
| 参数 | 描述 | 值 | 默认值 |
|---|---|---|---|
-skiphc, --skiphardwarecheck | 用于跳过硬件检查 | true|false | false |
此参数允许您跳过检查系统是否满足最低硬件要求。
示例
bash apps-developer-install.sh -skiphc true
这将跳过硬件检查。
组件更新
| 参数 | 描述 | 值 | 默认值 |
|---|---|---|---|
-u, --update | 用于更新现有组件 | true|false | false |
如果您的机器上安装的相应组件已过时，此参数允许您安装最新版本的必要组件。
示例
bash apps-developer-install.sh -u true
这将停止需要更新的容器，移除它们，然后运行相应 ONLYOFFICE Apps开发者版组件的最新版本。如果当前组件版本与最新可用版本一致，则不会影响该容器。如果您在之前的安装中跳过了某些组件，它们也将被跳过。ONLYOFFICE Apps 数据应自动获取。
仅将文档更新到版本 7.2.1.34 并跳过所有其他组件的更新：
bash apps-developer-install.sh -u true -docsi onlyoffice/documentserver-de -docsv 7.2.1.34 -idocs true -ia false -irbt false -irds false
仅将 ONLYOFFICE Apps 更新到版本 1.2.0 并跳过所有其他组件的更新：
bash apps-developer-install.sh -u true -asv v1.2.0 -idocs false -irbt false -irds false
组件安装
| 参数 | 描述 | 值 | 默认值 |
|---|---|---|---|
-ia, --installapps | 安装 ONLYOFFICE Apps | true|false | true |
-idocs, --installdocs | 安装 ONLYOFFICE 文档 | 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-developer-install.sh -idocs false
这将安装所有 ONLYOFFICE Apps开发者版组件，但不包括 ONLYOFFICE 文档。
bash apps-developer-install.sh -ia false -idocs true -imysql false -irbt false -irds false
这将跳过安装 ONLYOFFICE Apps、MySQL、RabbitMQ 和 Redis，仅安装 ONLYOFFICE 文档。
组件版本
| 参数 | 描述 |
|---|---|
-asv, --appsversion | ONLYOFFICE Apps版本 |
-docsv, --docsversion | ONLYOFFICE 文档版本 |
如果您因某些原因不想安装仓库中的最新版本，这些参数可用于安装特定的 ONLYOFFICE Apps或 ONLYOFFICE 文档版本。默认情况下，使用标记为 latest 的镜像来运行组件容器。
示例
在浏览器中打开 Docker Hub 仓库，选择 ONLYOFFICE 文档并转到标签选项卡以查看仓库中所有可用标签。指定您要安装的版本：
bash apps-developer-install.sh -docsv 7.2.1.34
这将安装带有 ONLYOFFICE 文档 7.2.1.34 版本的 ONLYOFFICE Apps。
ONLYOFFICE 文档镜像名称
| 参数 | 描述 |
|---|---|
-docsi, --docsimage | ONLYOFFICE 文档镜像名称 |
此参数可用于指定容器应从中启动的 ONLYOFFICE 文档镜像名称。指定的镜像应存储在我们官方的 Docker Hub 公共仓库中。
示例
bash apps-developer-install.sh -docsi onlyoffice/documentserver-de
这将从存储在仓库中的指定 ONLYOFFICE 文档镜像运行容器。
主机设置
| 参数 | 描述 |
|---|---|
-ash, --appshost | ONLYOFFICE Apps主机 |
-esh, --elastichost | OpenSearch 主机 |
如果您将组件安装在单独的机器上，这些参数可用于连接组件。
示例
bash apps-developer-install.sh -esh 192.168.3.202
这将安装 ONLYOFFICE Apps并将其与安装在具有 192.168.3.202 IP 地址的不同机器上的 OpenSearch 连接。
core.machinekey 设置
| 参数 | 描述 |
|---|---|
-mk, --machinekey | core.machinekey 键的设置 |
此参数允许您在安装 ONLYOFFICE Apps开发者版时指定自己的 machinekey。
此参数写入 /app/onlyoffice/config/appsettings.json 配置文件（路径在 onlyoffice-studio 容器内指定）。
示例
bash apps-developer-install.sh -mk yourmachinekey
ONLYOFFICE Apps外部端口
| 参数 | 描述 | 默认值 |
|---|---|---|
-ep, --externalport | ONLYOFFICE Apps外部端口 | 80 |
此参数允许您更改 ONLYOFFICE Apps运行的端口。默认使用端口 80。
示例
bash apps-developer-install.sh -ep 8080
JWT 头和密钥设置
| 参数 | 描述 |
|---|---|
-jh, --jwtheader | JWT 头设置 |
-js, --jwtsecret | JWT 密钥设置 |
这些参数允许您在安装 ONLYOFFICE Apps开发者版时指定 JWT 头和自己的 JWT 密钥。JWT 头定义用于发送 JWT 的 http 头。密钥用于签署 JSON web token 并在请求 ONLYOFFICE 文档时验证 token。
这些参数写入以下配置文件（路径在 onlyoffice-studio 和 onlyoffice-document-server 容器内指定）：
- 对于 ONLYOFFICE Apps -
/app/onlyoffice/config/appsettings.json - 对于文档服务器 -
/etc/onlyoffice/documentserver/local.json
示例
bash apps-developer-install.sh -js yoursecret
MySQL 服务器
| 参数 | 描述 | 默认值 |
|---|---|---|
-mysqlrp, --mysqlrootpassword | MySQL 服务器 root 密码 | 自动生成 |
-mysqlh, --mysqlhost | MySQL 服务器主机 | localhost |
-mysqlport, --mysqlport | MySQL 服务器端口号 | 3306 |
如果您未明确指定主机和端口，则使用默认值。如果您未设置 root 密码，则会自动生成。
示例
bash apps-developer-install.sh -mysqlrp new-secret-pw
此命令允许您在安装 ONLYOFFICE Apps开发者版期间为 MySQL root 帐户设置自己的密码。
ONLYOFFICE Apps数据库
| 参数 | 描述 | 默认值 |
|---|---|---|
-mysqld, --mysqldatabase | ONLYOFFICE Apps数据库名称 | onlyoffice_apps |
-mysqlu, --mysqluser | ONLYOFFICE Apps数据库用户 | - |
-mysqlp, --mysqlpassword | ONLYOFFICE Apps数据库密码 | 自动生成 |
这些参数允许您创建 ONLYOFFICE Apps数据库，指定自定义数据库名称，以及为对创建的数据库具有超级用户权限的帐户指定用户名和密码。如果您未明确指定数据库名称，则使用默认值。如果您未设置密码，则会自动生成。
示例
bash apps-developer-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 服务器。使用 -irbt false 参数跳过 RabbitMQ 的安装，然后指定您自己服务器的连接参数。如果您未明确指定协议、主机、端口或虚拟主机，则使用默认值。
示例
bash apps-developer-install.sh -irbt false --rabbitmqhost mq.example.com --rabbitmqusername username --rabbitmqpassword password
这将安装不含 RabbitMQ 的 ONLYOFFICE Apps，并将其连接到在 mq.example.com 主机上运行的 RabbitMQ 服务器。
Redis 服务器
| 参数 | 描述 | 默认值 |
|---|---|---|
--redishost | Redis 服务器主机 | localhost |
--redisport | Redis 服务器端口号 | 6379 |
--redisusername | Redis 用户名（如果服务器需要授权） | - |
--redispassword | Redis 用户密码（如果服务器需要授权） | - |
使用这些参数将 ONLYOFFICE Apps 连接到已在另一台机器上运行的 Redis 服务器。使用 -irds false 参数跳过 Redis 的安装，然后指定您自己服务器的连接参数。仅当您的 Redis 服务器需要授权时，才需要用户名和密码。
示例
bash apps-developer-install.sh -irds false --redishost redis.example.com --redispassword password
这将安装不含 Redis 的 ONLYOFFICE Apps，并将其连接到在 redis.example.com 主机上运行的 Redis 服务器。
OpenSearch 服务器
| 参数 | 描述 | 默认值 |
|---|---|---|
--elasticprotocol | OpenSearch 连接协议 | http |
--elasticport | OpenSearch 服务器端口号 | 9200 |
将这些参数与上文“主机设置”部分中介绍的 -esh, --elastichost 参数一起使用，可将 ONLYOFFICE Apps 连接到在另一台机器上运行的 OpenSearch 服务器。如果您未明确指定协议和端口，则使用默认值。
示例
bash apps-developer-install.sh -esh search.example.com --elasticprotocol https --elasticport 9200
这将通过 HTTPS 将 ONLYOFFICE Apps 连接到在 search.example.com 主机上运行的 OpenSearch 服务器。
切换到 HTTPS
| 参数 | 描述 |
|---|---|
-led, --letsencryptdomain | 定义 Let's Encrypt 证书的域名 |
-lem, --letsencryptmail | 定义 Let's Encrypt 证书的域管理员邮件地址 |
-cf, --certfile | 域证书文件的路径 |
-ckf, --certkeyfile | 证书私钥文件的路径 |
这些参数允许您将工作空间切换到 HTTPS。它们仅可用于 Docker 版本。
示例
bash apps-developer-install.sh docker --letsencryptmail user@example.com --letsencryptdomain yourdomain.com
这将自动创建并安装 letsencrypt.org CA 签名的证书到您的服务器，并重新启动 NGINX 服务以使更改生效。
bash apps-developer-install.sh docker --certfile path --certkeyfile path
这将应用您自己的 SSL 证书。