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