追加のスクリプトパラメーターを使用してONLYOFFICE Apps デベロッパー版をインストールする
はじめに
ONLYOFFICE Apps Developerは、ユーザーとドキュメントを一つの場所でつなぎ、コラボレーションを強化するための有料版のドキュメントハブです。
ONLYOFFICE Apps Developerは、DockerがインストールされたLinuxオペレーティングシステム用の自動インストールスクリプトとして提供されます。このスクリプトは、ONLYOFFICE Apps Developerが正しく動作するために必要なすべてのコンポーネントを含むDockerコンテナをセットアップし、簡単に実行、管理、更新できます。
ONLYOFFICE Apps Developerのインストールスクリプトをダウンロードした後、例えば各コンポーネントを別々のマシンにインストールしたい場合など、追加のパラメータを指定して実行する必要があるかもしれません。
すべての利用可能なDockerスクリプトパラメータのリストを表示するには、次のコマンドを使用します：
bash apps-developer-install.sh docker -h
すべての利用可能なDEB/RPMスクリプトパラメータのリストを表示するには、次のコマンドを使用します：
bash apps-developer-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-developer-install.sh -reg URL -un username -p password
インストールタイプ
| パラメータ | 説明 | 値 | デフォルト |
|---|---|---|---|
-it, --installationtype | インストールタイプ | community|developer|enterprise | developer |
このパラメータを使用して、指定されたソリューションをインストールできます：ONLYOFFICE Apps Community、ONLYOFFICE Apps Developer、またはONLYOFFICE Apps Enterprise。
例
bash apps-developer-install.sh -it community
これにより、ONLYOFFICE Apps Communityソリューションがインストールされます。
ハードウェアチェック
| パラメータ | 説明 | 値 | デフォルト |
|---|---|---|---|
-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 Developerコンポーネントの最新バージョンが実行されます。現在のコンポーネントバージョンが最新の利用可能なバージョンと一致する場合、そのコンテナは影響を受けません。前回のインストール中にいくつかのコンポーネントをスキップした場合、それらもスキップされます。ONLYOFFICE Appsデータは自動的に取得されるはずです。
Docsをバージョン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 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-developer-install.sh -idocs false
これにより、ONLYOFFICE Docsを除くすべてのONLYOFFICE Apps Developerコンポーネントがインストールされます。
bash apps-developer-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-developer-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-developer-install.sh -docsi onlyoffice/documentserver-de
これにより、リポジトリに保存されている指定されたONLYOFFICE Docsイメージからコンテナが実行されます。
ホストの設定
| パラメーター | 説明 |
|---|---|
-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 Developerをインストールする際に独自の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 Developerをインストールする際に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-developer-install.sh -js yoursecret
MySQLサーバー
| パラメーター | 説明 | デフォルト |
|---|---|---|
-mysqlrp, --mysqlrootpassword | MySQLサーバールートパスワード | 自動生成 |
-mysqlh, --mysqlhost | MySQLサーバーホスト | localhost |
-mysqlport, --mysqlport | MySQLサーバーポート番号 | 3306 |
ホストとポートを明示的に指定しない場合、デフォルト値が使用されます。ルートパスワードを設定しない場合は、自動的に生成されます。
例
bash apps-developer-install.sh -mysqlrp new-secret-pw
このコマンドを使用すると、ONLYOFFICE Apps Developerのインストール中にMySQLルートアカウントの独自のパスワードを設定できます。
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仮想ホスト | / |
これらのパラメーターを使用して、別のマシンですでに実行中のRabbitMQサーバーにONLYOFFICE Appsを接続します。-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ユーザーパスワード（サーバーが認証を必要とする場合） | - |
これらのパラメーターを使用して、別のマシンですでに実行中のRedisサーバーにONLYOFFICE Appsを接続します。-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 |
別のマシンで実行中のOpenSearchサーバーにONLYOFFICE Appsを接続するには、上記の「ホストの設定」セクションで説明している-esh, --elastichostパラメーターと一緒にこれらのパラメーターを使用します。プロトコルとポートを明示的に指定しない場合、デフォルト値が使用されます。
例
bash apps-developer-install.sh -esh search.example.com --elasticprotocol https --elasticport 9200
これにより、search.example.comホストで実行中のOpenSearchサーバーにHTTPS経由でONLYOFFICE Appsが接続されます。
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証明書が適用されます。