追加のスクリプトパラメーターを使用してONLYOFFICE DocSpace デベロッパー版をインストールする
はじめに
ONLYOFFICE DocSpace Developerは、ユーザーとドキュメントを一つの場所でつなぎ、コラボレーションを強化するための有料版のドキュメントハブです。
ONLYOFFICE DocSpace Developerは、DockerがインストールされたLinuxオペレーティングシステム用の自動インストールスクリプトとして提供されます。このスクリプトは、ONLYOFFICE DocSpace Developerが正しく動作するために必要なすべてのコンポーネントを含むDockerコンテナをセットアップし、簡単に実行、管理、更新できます。
ONLYOFFICE DocSpace Developerのインストールスクリプトをダウンロードした後、例えば各コンポーネントを別々のマシンにインストールしたい場合など、追加のパラメータを指定して実行する必要があるかもしれません。
すべての利用可能なDockerスクリプトパラメータのリストを表示するには、次のコマンドを使用します:
bash docspace-developer-install.sh docker -h
すべての利用可能なDEB/RPMスクリプトパラメータのリストを表示するには、次のコマンドを使用します:
bash docspace-developer-install.sh package -h
これらのパラメータの簡単な説明と使用例を以下に示します。
パラメータを指定してスクリプトを実行すると、ONLYOFFICE DocSpaceのインストール方法を選択するように求められます。Dockerを使用してONLYOFFICE DocSpaceをインストールするにはYと入力し、Enterを押します。DEB/RPMパッケージからONLYOFFICE DocSpaceをインストールするにはNと入力し、Enterを押します。
認証情報
| パラメータ | 説明 |
|---|---|
-reg, --registry | DockerレジストリURL(例:https://myregistry.com:5000) |
-un, --username | Dockerレジストリのログイン |
-p, --password | Dockerレジストリのパスワード |
これらのパラメータは、テストリポジトリにアクセスするための認証情報を提供する場合に使用され、そこに保存されたイメージからコンテナを実行できます。
例
bash docspace-developer-install.sh -reg URL -un username -p password
インストールタイプ
| パラメータ | 説明 | 値 | デフォルト |
|---|---|---|---|
-it, --installation_type | インストールタイプ | community|developer|enterprise | developer |
このパラメータを使用して、指定されたソリューションをインストールできます:ONLYOFFICE DocSpace Community、ONLYOFFICE DocSpace Developer、またはONLYOFFICE DocSpace Enterprise。
例
bash docspace-developer-install.sh -it community
これにより、ONLYOFFICE DocSpace Communityソリューションがインストールされます。
ハードウェアチェック
| パラメータ | 説明 | 値 | デフォルト |
|---|---|---|---|
-skiphc, --skiphardwarecheck | ハードウェアチェックをスキップするために使用 | true|false | false |
このパラメータを使用すると、システムが最低限のハードウェア要件を満たしているかどうかを確認することをスキップできます。
例
bash docspace-developer-install.sh -skiphc true
これにより、ハードウェアチェックがスキップされます。
コンポーネントの更新
| パラメータ | 説明 | 値 | デフォルト |
|---|---|---|---|
-u, --update | 既存のコンポーネントを更新するために使用 | true|false | false |
このパラメータを使用すると、マシンにインストールされている対応するコンポーネントが古い場合、必要なコンポーネントの最新バージョンをインストールできます。
例
bash docspace-developer-install.sh -u true
これにより、更新が必要なコンテナが停止され、削除され、対応するONLYOFFICE DocSpace Developerコンポーネントの最新バージョンが実行されます。現在のコンポーネントバージョンが最新の利用可能なバージョンと一致する場合、そのコンテナは影響を受けません。前回のインストール中にいくつかのコンポーネントをスキップした場合、それらもスキップされます。DocSpaceデータは自動的に取得されるはずです。
Docsをバージョン7.2.1.34にのみ更新し、他のすべてのコンポーネントの更新をスキップします:
bash docspace-developer-install.sh -u true -docsi onlyoffice/documentserver-de -docsv 7.2.1.34 -idocs true -ids false -irbt false -irds false
DocSpaceをバージョン1.2.0にのみ更新し、他のすべてのコンポーネントの更新をスキップします:
bash docspace-developer-install.sh -u true -dsv v1.2.0 -idocs false -irbt false -irds false
コンポーネントのインストール
| パラメータ | 説明 | 値 | デフォルト |
|---|---|---|---|
-ids, --installdocspace | ONLYOFFICE DocSpaceをインストール | 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 docspace-developer-install.sh -idocs false
これにより、ONLYOFFICE Docsを除くすべてのONLYOFFICE DocSpace Developerコンポーネントがインストールされます。
bash docspace-developer-install.sh -ids false -idocs true -imysql false -irbt false -irds false
これにより、ONLYOFFICE DocSpace、MySQL、RabbitMQ、およびRedisのインストールがスキップされ、ONLYOFFICE Docsのみがインストールされます。
コンポーネントバージョン
| パラメータ | 説明 |
|---|---|
-dsv, --docspaceversion | ONLYOFFICE DocSpaceのバージョン |
-docsv, --docsversion | ONLYOFFICE Docsのバージョン |
これらのパラメーターを使用すると、リポジトリで利用可能な最新バージョンをインストールしたくない場合に、特定のONLYOFFICE DocSpaceまたはONLYOFFICE Docsのバージョンをインストールすることができます。デフォルトでは、latestとしてタグ付けされたイメージがコンポーネントコンテナを実行するために使用されます。
例
ブラウザでDocker Hubリポジトリを開き、ONLYOFFICE Docsを選択し、Tagsタブに移動してリポジトリで利用可能なすべてのタグを表示します。インストールしたいバージョンを指定します:
bash docspace-developer-install.sh -docsv 7.2.1.34
これにより、ONLYOFFICE Docs 7.2.1.34バージョンのONLYOFFICE DocSpaceがインストールされます。
ONLYOFFICE Docs イメージ名
| パラメーター | 説明 |
|---|---|
-docsi, --docsimage | ONLYOFFICE Docsイメージ名 |
このパラメーターを使用すると、コンテナを開始するためのONLYOFFICE Docsイメージの名前を指定できます。指定されたイメージは、Docker Hubの公式公開リポジトリに保存されている必要があります。
例
bash docspace-developer-install.sh -docsi onlyoffice/documentserver-de
これにより、リポジトリに保存されている指定されたONLYOFFICE Docsイメージからコンテナが実行されます。
ホストの設定
| パラメーター | 説明 |
|---|---|
-dsh, --docspacehost | ONLYOFFICE DocSpaceホスト |
-esh, --elastichost | Elasticsearchホスト |
これらのパラメーターを使用すると、コンポーネントを別々のマシンにインストールした場合に接続できます。
例
bash docspace-developer-install.sh -esh 192.168.3.202
これにより、ONLYOFFICE DocSpaceがインストールされ、192.168.3.202のIPアドレスを持つ別のマシンにインストールされたElasticsearchと接続されます。
core.machinekeyの設定
| パラメーター | 説明 |
|---|---|
-mk, --machinekey | core.machinekeyキーの設定 |
このパラメーターを使用すると、ONLYOFFICE DocSpace Developerをインストールする際に独自のmachinekeyを指定できます。
/app/onlyoffice/config/appsettings.json設定ファイルに書き込まれます(onlyoffice-studioコンテナ内でパスが指定されています)。例
bash docspace-developer-install.sh -mk yourmachinekey
ONLYOFFICE DocSpace外部ポート
| パラメーター | 説明 | デフォルト |
|---|---|---|
-ep, --externalport | ONLYOFFICE DocSpace外部ポート | 80 |
このパラメーターを使用すると、ONLYOFFICE DocSpaceが実行されるポートを変更できます。デフォルトではポート80が使用されます。
例
bash docspace-developer-install.sh -ep 8080
JWTヘッダーとシークレットの設定
| パラメーター | 説明 |
|---|---|
-jh, --jwtheader | JWTヘッダーの設定 |
-js, --jwtsecret | JWTシークレットキーの設定 |
これらのパラメーターを使用すると、ONLYOFFICE DocSpace Developerをインストールする際にJWTヘッダーと独自のJWTシークレットキーを指定できます。JWTヘッダーはJWTを送信するために使用されるhttpヘッダーを定義します。シークレットキーはJSON Webトークンを署名し、ONLYOFFICE Docsへのリクエスト時にトークンを検証するために使用されます。
- DocSpace用 -
/app/onlyoffice/config/appsettings.json - Document Server用 -
/etc/onlyoffice/documentserver/local.json
例
bash docspace-developer-install.sh -js yoursecret
MySQLサーバー
| パラメーター | 説明 | デフォルト |
|---|---|---|
-mysqlrp, --mysqlrootpassword | MySQLサーバールートパスワード | my-secret-pw |
-mysqlh, --mysqlhost | MySQLサーバーホスト | localhost |
-mysqlport, --mysqlport | MySQLサーバーポート番号 | 3306 |
これらのパラメーターを明示的に指定しない場合、デフォルト値が使用されます。
例
bash docspace-developer-install.sh -mysqlrp new-secret-pw
このコマンドを使用すると、ONLYOFFICE DocSpace Developerのインストール中にMySQLルートアカウントの独自のパスワードを設定できます。
ONLYOFFICE DocSpaceデータベース
| パラメーター | 説明 | デフォルト |
|---|---|---|
-mysqld, --mysqldatabase | ONLYOFFICE DocSpaceデータベース名 | onlyoffice |
-mysqlu, --mysqluser | ONLYOFFICE DocSpaceデータベースユーザー | onlyoffice_user |
-mysqlp, --mysqlpassword | ONLYOFFICE DocSpaceデータベースパスワード | onlyoffice_pass |
これらのパラメーターを使用すると、ONLYOFFICE DocSpaceデータベースを作成する際にカスタムデータベース名、ならびに作成されたデータベースに対するスーパーユーザー権限を持つアカウントのユーザー名とパスワードを指定できます。これらのパラメーターを明示的に指定しない場合、デフォルト値が使用されます。
例
bash docspace-developer-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-developer-install.sh docker --letsencryptmail user@example.com --letsencryptdomain yourdomain.com
これにより、letsencrypt.orgのCA署名付き証明書が自動的に作成され、サーバーにインストールされ、変更が有効になるようにNGINXサービスが再起動されます。
bash docspace-developer-install.sh docker --certfile path --certkeyfile path
これにより、独自のSSL証明書が適用されます。