追加のスクリプトパラメーターを使用したONLYOFFICE Apps コミュニティ版のインストール
はじめに
ONLYOFFICE Apps Communityは、ユーザーとドキュメントを一か所に集めてコラボレーションを促進できるドキュメントハブの無料版です。
ONLYOFFICE Apps Communityは、DockerがインストールされたLinuxオペレーティングシステム用の自動インストールスクリプトとして提供されます。このスクリプトは、ONLYOFFICE Apps Communityが正しく動作するために必要なすべてのコンポーネントを含むDockerコンテナをセットアップし、実行、管理、更新が簡単です。
ONLYOFFICE Apps Communityのインストールスクリプトをダウンロードした後、たとえば各コンポーネントを別々のマシンにインストールしたい場合などには、追加のパラメーターを指定して実行する必要がある場合があります。
利用可能なすべてのDockerスクリプトパラメーターのリストを表示するには、次のコマンドを使用します：
bash apps-install.sh docker -h
利用可能なすべてのDEB/RPMスクリプトパラメーターのリストを表示するには、次のコマンドを使用します：
bash apps-install.sh package -h
これらのパラメーターの簡単な説明と使用例を以下に示します。
パラメーターを指定してスクリプトを実行すると、ONLYOFFICE Appsのインストール方法を選択するよう求められます。Dockerを使用してONLYOFFICE Appsをインストールするには、Yを入力してEnterを押します。DEB/RPMパッケージからONLYOFFICE Appsをインストールするには、Nを入力してEnterを押します。
認証情報
| パラメーター | 説明 |
|---|---|
-reg, --registry | DockerレジストリのURL（例：https://myregistry.com:5000） |
-un, --username | Dockerレジストリのログイン名 |
-p, --password | Dockerレジストリのパスワード |
これらのパラメーターは、テスト用リポジトリにアクセスするための認証情報を当社が提供した場合に使用され、そこに保存されているイメージからコンテナを実行できるようになります。
例
bash apps-install.sh -reg URL -un username -p password
インストールタイプ
| パラメーター | 説明 | 値 | デフォルト |
|---|---|---|---|
-it, --installationtype | インストールタイプ | community|developer|enterprise | community |
このパラメーターを使用すると、指定したソリューション（ONLYOFFICE Apps Community、ONLYOFFICE Apps Developer、またはONLYOFFICE Apps Enterprise）をインストールできます。
例
bash apps-install.sh -it enterprise
これにより、ONLYOFFICE Apps Enterpriseソリューションがインストールされます。
ハードウェアチェック
| パラメーター | 説明 | 値 | デフォルト |
|---|---|---|---|
-skiphc, --skiphardwarecheck | ハードウェアチェックをスキップする場合に使用 | true|false | false |
このパラメーターを使用すると、システムが最小ハードウェア要件を満たしているかどうかのチェックをスキップできます。
例
bash apps-install.sh -skiphc true
これにより、ハードウェアチェックがスキップされます。
コンポーネントの更新
| パラメーター | 説明 | 値 | デフォルト |
|---|---|---|---|
-u, --update | 既存のコンポーネントを更新する場合に使用 | true|false | false |
このパラメーターを使用すると、マシンにインストールされている対応するコンポーネントが古い場合に、必要なコンポーネントの最新バージョンをインストールできます。
例
bash apps-install.sh -u true
これにより、更新が必要なコンテナが順次停止・削除され、対応するONLYOFFICE Apps Communityコンポーネントの最新バージョンが実行されます。現在のコンポーネントのバージョンが利用可能な最新バージョンと一致する場合、そのコンテナは影響を受けません。以前のインストール時にスキップしたコンポーネントは、今回もスキップされます。ONLYOFFICE Appsのデータは自動的に引き継がれます。
Docsのみをバージョン7.2.1.34に更新し、他のすべてのコンポーネントの更新をスキップします：
bash apps-install.sh -u true -docsi onlyoffice/documentserver -docsv 7.2.1.34 -idocs true -ia false -irbt false -irds false
ONLYOFFICE Appsのみをバージョン1.2.0に更新し、他のすべてのコンポーネントの更新をスキップします：
bash apps-install.sh -u true -asv v1.2.0 -idocs false -irbt false -irds false
コンポーネントのインストール
| パラメーター | 説明 | 値 | デフォルト |
|---|---|---|---|
-ia, --installapps | ONLYOFFICE Appsをインストール | true|false | true |
-idocs, --installdocs | ONLYOFFICE Docsをインストール | 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-install.sh -idocs false
これにより、ONLYOFFICE Docsを除くONLYOFFICE Apps Communityのすべてのコンポーネントがインストールされます。
bash apps-install.sh -ia false -idocs true -imysql false -irbt false -irds false
これにより、ONLYOFFICE Apps、MySQL、RabbitMQ、Redisのインストールがスキップされ、ONLYOFFICE Docsのみがインストールされます。
コンポーネントのバージョン
| パラメーター | 説明 |
|---|---|
-asv, --appsversion | ONLYOFFICE Appsのバージョン |
-docsv, --docsversion | ONLYOFFICE Docsのバージョン |
リポジトリで利用可能な最新バージョンをインストールしたくない場合に、これらのパラメーターを使用して特定のバージョンのONLYOFFICE AppsまたはONLYOFFICE Docsをインストールできます。デフォルトでは、latestのタグが付いたイメージがコンポーネントコンテナの実行に使用されます。
例
ブラウザでDocker Hubリポジトリを開き、ONLYOFFICE Docsを選択してTagsタブに移動し、リポジトリで利用可能なすべてのタグを表示します。インストールしたいバージョンを指定します：
bash apps-install.sh -docsv 7.2.1.34
これにより、ONLYOFFICE Docs 7.2.1.34バージョンとともにONLYOFFICE Appsがインストールされます。
ONLYOFFICE Docs イメージ名
| パラメーター | 説明 |
|---|---|
-docsi, --docsimage | ONLYOFFICE Docsのイメージ名 |
このパラメーターを使用すると、コンテナの起動元となるONLYOFFICE Docsイメージの名前を指定できます。指定するイメージは、Docker Hub上の当社の公式パブリックリポジトリに保存されている必要があります。
例
bash apps-install.sh -docsi onlyoffice/documentserver
これにより、リポジトリに保存されている指定のONLYOFFICE Docsイメージからコンテナが実行されます。
ホストの設定
| パラメーター | 説明 |
|---|---|
-ash, --appshost | ONLYOFFICE Appsのホスト |
-esh, --elastichost | OpenSearchのホスト |
これらのパラメーターは、コンポーネントを別々のマシンにインストールする場合に、コンポーネントを接続するために使用できます。
例
bash apps-install.sh -esh 192.168.3.202
これにより、ONLYOFFICE Appsがインストールされ、IPアドレス192.168.3.202を持つ別のマシンにインストールされているOpenSearchに接続されます。
core.machinekey の設定
| パラメーター | 説明 |
|---|---|
-mk, --machinekey | core.machinekeyキーの設定 |
このパラメーターを使用すると、ONLYOFFICE Apps Communityのインストール時に独自のmachinekeyを指定できます。
このパラメーターは、/app/onlyoffice/config/appsettings.json設定ファイルに書き込まれます（パスはonlyoffice-studioコンテナ内で指定されます）。
例
bash apps-install.sh -mk yourmachinekey
ONLYOFFICE Apps 外部ポート
| パラメーター | 説明 | デフォルト |
|---|---|---|
-ep, --externalport | ONLYOFFICE Appsの外部ポート | 80 |
このパラメーターを使用すると、ONLYOFFICE Appsが動作するポートを変更できます。デフォルトではポート80が使用されます。
例
bash apps-install.sh -ep 8080
JWT ヘッダーとシークレットの設定
| パラメーター | 説明 |
|---|---|
-jh, --jwtheader | JWTヘッダーの設定 |
-js, --jwtsecret | JWTシークレットキーの設定 |
これらのパラメーターを使用すると、ONLYOFFICE Apps Communityのインストール時にJWTヘッダーと独自のJWTシークレットキーを指定できます。JWTヘッダーは、JWTの送信に使用されるhttpヘッダーを定義します。シークレットキーは、JSON Webトークンへの署名と、ONLYOFFICE Docsへのリクエスト時のトークンの検証に使用されます。
これらのパラメーターは、次の設定ファイルに書き込まれます（パスはonlyoffice-studioおよびonlyoffice-document-serverコンテナ内で指定されます）：
- ONLYOFFICE Appsの場合 -
/app/onlyoffice/config/appsettings.json - Document Serverの場合 -
/etc/onlyoffice/documentserver/local.json
例
bash apps-install.sh -js yoursecret
MySQL サーバー
| パラメーター | 説明 | デフォルト |
|---|---|---|
-mysqlrp, --mysqlrootpassword | MySQLサーバーのrootパスワード | 自動生成 |
-mysqlh, --mysqlhost | MySQLサーバーのホスト | localhost |
-mysqlport, --mysqlport | MySQLサーバーのポート番号 | 3306 |
ホストとポートを明示的に指定しない場合は、デフォルト値が使用されます。rootパスワードを設定しない場合は、自動的に生成されます。
例
bash apps-install.sh -mysqlrp new-secret-pw
このコマンドを使用すると、ONLYOFFICE Apps Communityのインストール中にMySQLのrootアカウントに独自のパスワードを設定できます。
ONLYOFFICE Apps データベース
| パラメーター | 説明 | デフォルト |
|---|---|---|
-mysqld, --mysqldatabase | ONLYOFFICE Appsのデータベース名 | onlyoffice_apps |
-mysqlu, --mysqluser | ONLYOFFICE Appsのデータベースユーザー | - |
-mysqlp, --mysqlpassword | ONLYOFFICE Appsのデータベースパスワード | 自動生成 |
これらのパラメーターを使用すると、カスタムのデータベース名と、作成したデータベースに対するスーパーユーザー権限を持つアカウントのユーザー名とパスワードを指定して、ONLYOFFICE Appsのデータベースを作成できます。データベース名を明示的に指定しない場合は、デフォルト値が使用されます。パスワードを設定しない場合は、自動的に生成されます。
例
bash apps-install.sh -mysqld appsdatabase -mysqlu username -mysqlp password
RabbitMQサーバー
| パラメーター | 説明 | デフォルト |
|---|---|---|
--rabbitmqprotocol | RabbitMQの接続プロトコル | amqp |
--rabbitmqhost | RabbitMQサーバーのホスト | localhost |
--rabbitmqport | RabbitMQサーバーのポート番号 | 5672 |
--rabbitmqusername | RabbitMQのユーザー名 | - |
--rabbitmqpassword | RabbitMQのユーザーパスワード | - |
--rabbitmqvirtualhost | RabbitMQの仮想ホスト | / |
これらのパラメーターを使用して、別のマシンで既に実行されているRabbitMQサーバーにONLYOFFICE Appsを接続します。-irbt falseパラメーターでRabbitMQのインストールをスキップしてから、ご自身のサーバーの接続パラメーターを指定します。プロトコル、ホスト、ポート、仮想ホストを明示的に指定しない場合は、デフォルト値が使用されます。
例
bash apps-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のユーザーパスワード（サーバーで認証が必要な場合） | - |
これらのパラメーターを使用して、別のマシンで既に実行されているRedisサーバーにONLYOFFICE Appsを接続します。-irds falseパラメーターでRedisのインストールをスキップしてから、ご自身のサーバーの接続パラメーターを指定します。ユーザー名とパスワードは、Redisサーバーで認証が必要な場合にのみ必要です。
例
bash apps-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パラメーターとともにこれらのパラメーターを使用して、別のマシンで実行されているOpenSearchサーバーにONLYOFFICE Appsを接続します。プロトコルとポートを明示的に指定しない場合は、デフォルト値が使用されます。
例
bash apps-install.sh -esh search.example.com --elasticprotocol https --elasticport 9200
これにより、ONLYOFFICE Appsが、search.example.comホストで実行されているOpenSearchサーバーにHTTPS経由で接続されます。
HTTPS への切り替え
| パラメーター | 説明 |
|---|---|
-led, --letsencryptdomain | Let's Encrypt証明書のドメインを定義 |
-lem, --letsencryptmail | Let's Encrypt証明書のドメイン管理者のメールアドレスを定義 |
-cf, --certfile | ドメインの証明書ファイルへのパス |
-ckf, --certkeyfile | 証明書の秘密鍵ファイルへのパス |
これらのパラメーターを使用すると、ワークスペースをHTTPSに切り替えることができます。Docker版でのみ使用できます。
例
bash apps-install.sh docker --letsencryptmail user@example.com --letsencryptdomain yourdomain.com
これにより、letsencrypt.org CA署名付き証明書が自動的に作成されてサーバーにインストールされ、変更を有効にするためにNGINXサービスが再起動されます。
bash apps-install.sh docker --certfile path --certkeyfile path
これにより、独自のSSL証明書が適用されます。