追加のスクリプトパラメータを使用したONLYOFFICE Workspace Communityのインストール
はじめに
ONLYOFFICE Workspace Community は、ドキュメント、プロジェクト、顧客関係、メールのやり取りを一元管理するために開発された無料のコラボレーションシステムです。
ONLYOFFICE Workspace Community は、DockerがインストールされたLinuxオペレーティングシステム用の自動インストールスクリプトとして提供されます。このスクリプトは、ONLYOFFICE Workspace Community の正しい動作に必要なすべてのコンポーネントを含むDockerコンテナをセットアップし、簡単に実行、管理、更新することができます。
ONLYOFFICE Workspace Community のインストールスクリプトをダウンロードした後、例えば各コンポーネントを別のマシンにインストールしたい場合など、追加のパラメータを指定して実行する必要があるかもしれません。利用可能なスクリプトパラメータの一覧を表示するには、次のコマンドを使用します。
bash workspace-install.sh -h
これらのパラメータの簡単な説明と使用例を以下に示します。
イメージ名
| パラメータ | 説明 |
|---|---|
-ci, --communityimage | ONLYOFFICE Community Server のイメージ名 |
-di, --documentimage | ONLYOFFICE Docs のイメージ名 |
-mi, --mailimage | ONLYOFFICE Mail のイメージ名 |
-cpi, --controlpanelimage | ONLYOFFICE Control Panel のイメージ名 |
これらのパラメータは、コンテナを開始するためのイメージ名を指定するために使用できます。指定されたイメージは、Docker Hubの公式公開リポジトリに保存されている必要があります。
例
bash workspace-install.sh -ims false -di onlyoffice/documentserver -ics true -icp true
これにより、リポジトリに保存されている指定された ONLYOFFICE Docs イメージからコンテナが実行され、ONLYOFFICE Community Server および ONLYOFFICE Control Panel のコンテナも実行されます。
コンポーネントバージョン
| パラメータ | 説明 |
|---|---|
-cv, --communityversion | ONLYOFFICE Community Server のバージョン |
-dv, --documentversion | ONLYOFFICE Docs のバージョン |
-mv, --mailversion | ONLYOFFICE Mail のバージョン |
-cpv, --controlpanelversion | ONLYOFFICE Control Panel のバージョン |
これらのパラメータは、リポジトリで利用可能な最新バージョンをインストールしたくない場合に特定のコンポーネントバージョンをインストールするために使用できます。デフォルトでは、各コンポーネントコンテナを実行するために latest としてタグ付けされたイメージが使用されます。
例
ブラウザでDocker Hubリポジトリを開き、必要なコンポーネントを選択し、Tags タブに移動してリポジトリで利用可能なすべてのタグを表示します。必要なコンポーネントのインストールしたいバージョンを指定します。
bash workspace-install.sh -ics true -cv 8.9.0.150 -ids false -icp true -cpv 1.6.0.52 -ims true -md "yourdomain.com"
これにより、ONLYOFFICE Community Server の8.9.0.150バージョン、ONLYOFFICE Control Panel の1.6.0.52バージョン、および ONLYOFFICE Mail の最新バージョンがインストールされます。ONLYOFFICE Mail のバージョンは明示的に指定されていません。
サーバーIP
| パラメータ | 説明 |
|---|---|
-dip, --documentserverip | ONLYOFFICE Docs のIPアドレス |
-mip, --mailserverip | ONLYOFFICE Mail のIPアドレス |
-mdbip, --mailserverdbip | ONLYOFFICE Mail データベースのIPアドレス |
これらのパラメータは、コンポーネントを別のマシンにインストールする場合にそれらを接続するために使用できます。
例
bash workspace-install.sh -ics true -icp true -ids false -ims false -dip 192.168.3.202 -es false
これにより、ONLYOFFICE Community Server と ONLYOFFICE Control Panel がインストールされ、別のマシンにインストールされた ONLYOFFICE Docs と接続されます。このマシンのIPアドレスは 192.168.3.202 です。
ONLYOFFICE Mailドメイン名
| パラメータ | 説明 |
|---|---|
-md, --maildomain | ONLYOFFICE Mail のドメイン名 |
このパラメータを使用して、ONLYOFFICE Mail で使用する独自のドメイン名を指定できます。
例
bash workspace-install.sh -md "yourdomain.com"
これにより、ONLYOFFICE Workspace Community のすべてのコンポーネントがインストールされ、ONLYOFFICE Mail には指定された yourdomain.com ドメイン名が使用されます。
メールのやり取りを維持するために使用されるドメインは有効で、このマシンに対して設定されている必要があります（つまり、ONLYOFFICE Mail がインストールされているマシンのIPアドレスにドメイン名を指す適切な Aレコード がDNS設定にある必要があります）。
上記のコマンドでは、"yourdomain.com" パラメータは ONLYOFFICE Mailのサービスドメイン として理解される必要があります。通常、メールのやり取りを維持するために使用されるドメインの MXレコード に指定されます。通常、"yourdomain.com" は mx1.onlyoffice.com のようになります。
コンポーネントの更新
| パラメータ | 説明 | 値 | デフォルト |
|---|---|---|---|
-u, --update | 既存のコンポーネントを更新するために使用 | true|false | false |
このパラメータを使用すると、マシンにインストールされている対応するコンポーネントが古い場合に、古いコンポーネントの最新バージョンをインストールできます。
例
bash workspace-install.sh -u true
これにより、更新が必要なコンテナが停止され、削除され、その後、対応する ONLYOFFICE Workspace コンポーネントの最新バージョンが実行されます。現在のバージョンが利用可能な最新バージョンと一致するコンテナは影響を受けません。前回のインストール中にスキップされたコンポーネントもスキップされます。ポータルのデータは自動的に保持されます。
認証情報
| パラメータ | 説明 |
|---|---|
-un, --username | dockerhubのユーザー名 |
-p, --password | dockerhubのパスワード |
これらのパラメータは、テストリポジトリにアクセスするための認証情報を提供する場合に使用され、そこに保存されているイメージからコンテナを実行できるようにします。
例
bash workspace-install.sh -md "yourdomain.com" -un username -p password
コンポーネントのインストール
| パラメータ | 説明 | 値 | デフォルト |
|---|---|---|---|
-ics, --installcommunityserver | ONLYOFFICE Community Server をインストール | true|false|pull | true |
-ids, --installdocumentserver | ONLYOFFICE Docs をインストール | true|false|pull | true |
-ims, --installmailserver | ONLYOFFICE Mail をインストール | true|false|pull | true |
-icp, --installcontrolpanel | ONLYOFFICE Control Panel をインストール | true|false|pull | true |
これらのパラメータは、特定のコンポーネントをインストールするかどうかを指定するために使用されます。各コンポーネントを別々のマシンにインストールしたい場合に使用できます。
- コンポーネントをインストールするには
trueを使用します。 - コンポーネントのインストールをスキップするには
falseを使用します。 - コンポーネントをインストールせずにダウンロードするには
pullを使用します。
例
bash workspace-install.sh -ims false
これにより、ONLYOFFICE Mail を除くすべての ONLYOFFICE Workspace コンポーネントがインストールされます。
bash workspace-install.sh -ics false -ids true -icp false -ims false -es true
これにより、ONLYOFFICE Mail、ONLYOFFICE Community Server、および ONLYOFFICE Control Panel のインストールがスキップされ、ONLYOFFICE Docs のみがインストールされます。
インストールタイプ
| パラメータ | 説明 | 値 | デフォルト |
|---|---|---|---|
-it, --installation_type | インストールタイプ | WORKSPACE|WORKSPACE_ENTERPRISE | WORKSPACE_ENTERPRISE |
このパラメータは、指定されたソリューションをインストールするために使用されます：ONLYOFFICE Workspace または ONLYOFFICE Workspace エンタープライズ版。
例
bash workspace-install.sh -it GROUPS
これにより、ONLYOFFICE Community Server と ONLYOFFICE Control Panel コンポーネントを含む ONLYOFFICE Workspace ソリューションがインストールされます。
コンポーネントを外部サーバーとして使用する
| パラメータ | 説明 | 値 | デフォルト |
|---|---|---|---|
-es, --useasexternalserver | 外部サーバーとして使用 | true|false | false |
このパラメータは、コンポーネントを別々のマシンにインストールする場合に使用されます。
- ONLYOFFICE Docs と ONLYOFFICE Mail を別々のマシンにインストールする場合は
trueを使用します。 - ONLYOFFICE Community Server と ONLYOFFICE Control Panel を一緒に別のマシンにインストールする場合は
falseを使用します。
例
bash workspace-install.sh -ics false -ids false -icp false -ims true -md "yourdomain.com" -es true
これにより、ONLYOFFICE Docs、ONLYOFFICE Community Server、および ONLYOFFICE Control Panel のインストールがスキップされ、ONLYOFFICE Mail のみがインストールされます。
bash workspace-install.sh -ics true -icp true -ids false -ims false -dip 192.168.3.202 -es false
これにより、ONLYOFFICE Community Server と ONLYOFFICE Control Panel がインストールされ、別のマシンにインストールされた ONLYOFFICE Docs と接続されます。
スワップファイルの作成
| パラメータ | 説明 | 値 | デフォルト |
|---|---|---|---|
-ms, --makeswap | スワップファイルを作成 | true|false | false |
このパラメータは、6 GBのスワップファイルを作成するために使用されます。デフォルトでは true が指定されているため、スクリプトを実行する際にこのパラメータを指定する必要はありません。スワップファイルは自動的に作成されます。
例
bash workspace-install.sh -ms false
スワップファイルが既に存在する場合、インストール中に新しいスワップファイルが作成されないようにこのコマンドを使用できます。
スクリプトを再度実行する際に -ms パラメータを指定しない場合、onlyoffice_swapfile が存在するかどうかを確認します。スワップファイルが既に存在する場合、スクリプトは再度スワップファイルを作成しません。
MySQLサーバー
| パラメータ | 説明 | デフォルト |
|---|---|---|
-mysqlh, --mysqlhost | MySQL サーバーホスト | localhost |
-mysqlprt, --mysqlport | MySQL サーバーポート | 3306 |
-mysqlru, --mysqlrootuser | MySQL サーバールートユーザー | root |
-mysqlrp, --mysqlrootpassword | MySQL サーバールートパスワード | my-secret-pw |
これらのパラメータを明示的に指定しない場合は、デフォルト値が使用されます。
例
bash workspace-install.sh -mysqlru root -mysqlrp new-secret-pw
このコマンドは、ONLYOFFICE Workspace のインストール中に MySQL のrootアカウントにカスタムパスワードを設定します。
ONLYOFFICE Community Serverデータベース
| パラメータ | 説明 | デフォルト |
|---|---|---|
-mysqld, --mysqldatabase | ONLYOFFICE Community Server のデータベース名 | onlyoffice |
-mysqlu, --mysqluser | ONLYOFFICE Community Server のデータベースユーザー | onlyoffice_user |
-mysqlp, --mysqlpassword | ONLYOFFICE Community Server のデータベースパスワード | onlyoffice_pass |
これらのパラメータを使用すると、カスタム名の ONLYOFFICE Community Server データベースと、スーパーユーザー権限を持つアカウントのユーザー名とパスワードを作成できます。これらのパラメータを明示的に指定しない場合は、デフォルト値が使用されます。
例
bash workspace-install.sh -mysqld communitydatabase -mysqlu username -mysqlp password
ONLYOFFICE Mailデータベース
| パラメータ | 説明 | デフォルト |
|---|---|---|
-mysqlmd, --mysqlmaildatabase | ONLYOFFICE Mail のデータベース名 | onlyoffice_mailserver |
-mysqlmu, --mysqlmailuser | ONLYOFFICE Mail のデータベースユーザー | mail_admin |
-mysqlmp, --mysqlmailpassword | ONLYOFFICE Mail のデータベースパスワード | Isadmin123 |
これらのパラメータを使用すると、カスタムのデータベース名と、作成されたデータベースに対するスーパーユーザー権限を持つアカウントのユーザー名とパスワードを指定して ONLYOFFICE Mail データベースを作成できます。これらのパラメータを明示的に指定しない場合は、デフォルト値が使用されます。
例
bash workspace-install.sh -md "mx.yourdomain.com" -mysqlmd maildatabase -mysqlmu username -mysqlmp password
ONLYOFFICE Community Serverポート
| パラメータ | 説明 | デフォルト |
|---|---|---|
-cp, --communityport | ONLYOFFICE Community Server のポート | 80 |
このパラメータは、ONLYOFFICE Community Server が実行されるポートを変更します。デフォルトのポートは80です。
例
bash workspace-install.sh -cp 8080
core.machinekeyの設定
| パラメータ | 説明 |
|---|---|
-mk, --machinekey | core.machinekeyキーの設定 |
このパラメータを使用すると、ONLYOFFICE Workspace Communityのインストール時にカスタムのmachinekeyを指定できます。
このパラメータは、/app/onlyoffice/CommunityServer/data/.private/machinekey 設定ファイルに書き込まれます。
例
bash workspace-install.sh -mk yourmachinekey
JWTシークレットの設定
| パラメータ | 説明 |
|---|---|
-jwt, --jwtsecret | JWTシークレットキーの設定 |
このパラメータを使用すると、ONLYOFFICE Workspace Community のインストール時にカスタムのJWTシークレットキーを指定できます。シークレットキーは、JSON Webトークンに署名し、ONLYOFFICE Docsへのリクエスト時にトークンを検証するために使用されます。
このパラメータは、次の設定ファイルに書き込まれます（パスはコンテナ内で指定されています）。
- Community Serverの場合 -
/var/www/onlyoffice/WebStudio/web.appsettings.config - Document Serverの場合 -
/etc/onlyoffice/documentserver/local.json
例
bash workspace-install.sh -jwt yoursecret