追加のスクリプトパラメータを使用したONLYOFFICE Workspaceエンタープライズ版のインストール
はじめに
ONLYOFFICE Workspace エンタープライズ版は、ドキュメント、プロジェクト、顧客関係、メール対応を一元管理するために開発された有料のコラボレーションシステムです。
ONLYOFFICE Workspace エンタープライズ版は、DockerがインストールされたLinuxオペレーティングシステム向けの自動インストールスクリプトとして提供されます。このスクリプトは、ONLYOFFICE Workspace エンタープライズ版の正しい動作に必要なすべてのコンポーネントを含むDockerコンテナをセットアップし、簡単に実行、管理、更新できます。
ONLYOFFICE Workspace エンタープライズ版のインストールスクリプトをダウンロードした後、各コンポーネントを別のマシンにインストールしたい場合など、追加のパラメータを指定して実行する必要があるかもしれません。利用可能なスクリプトパラメータのリストを表示するには、以下のコマンドを使用してください：
bash workspace-enterprise-install.sh -h
これらのパラメータの簡単な説明と使用例を以下に示します。
イメージ名
| パラメータ | 説明 |
|---|---|
-ci, --communityimage | ONLYOFFICE Community Serverのイメージ名または.tar.gzファイルパス |
-di, --documentimage | ONLYOFFICE Docsのイメージ名または.tar.gzファイルパス |
-mi, --mailimage | ONLYOFFICE Mailのイメージ名または.tar.gzファイルパス |
-cpi, --controlpanelimage | ONLYOFFICE Control Panelのイメージ名または.tar.gzファイルパス |
これらのパラメータは、コンテナを開始するためのイメージ名を指定するために使用できます。指定されたイメージは、Docker Hubの公式公開リポジトリに保存されている必要があります。ダウンロードページから .tar.gz アーカイブをダウンロードした場合は、お使いのマシンに保存されているこの .tar.gz ファイルへのパスを指定することもできます。
例
bash workspace-enterprise-install.sh -ims false -di onlyoffice/documentserver-ee -ics true -icp true
これにより、リポジトリに保存されている指定されたONLYOFFICE Docsイメージからコンテナが実行され、ONLYOFFICE Community ServerおよびONLYOFFICE Control Panelコンテナも実行されます。
bash workspace-enterprise-install.sh -ims false -ics true -ci "/home/user/CommunityServer-12.5.2.tar.gz" -ids false -icp true
これにより、指定されたローカル .tar.gz ファイルに含まれるONLYOFFICE Community Serverイメージからコンテナが実行され、Docker Hubリポジトリに保存されているイメージから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-enterprise-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の最新バージョンがインストールされます（バージョンが明示的に指定されていないため）。
サーバーIP
| パラメータ | 説明 |
|---|---|
-dip, --documentserverip | ONLYOFFICE DocsのIPアドレス |
-mip, --mailserverip | ONLYOFFICE MailのIPアドレス |
-mdbip, --mailserverdbip | ONLYOFFICE MailデータベースのIPアドレス |
これらのパラメータは、コンポーネントを別々のマシンにインストールする場合に接続するために使用できます。
例
bash workspace-enterprise-install.sh -ics true -icp true -ids false -ims false -dip 192.168.3.202 -es false
これにより、ONLYOFFICE Community ServerとONLYOFFICE Control Panelがインストールされ、192.168.3.202のIPアドレスを持つ別のマシンにインストールされたONLYOFFICE Docsと接続されます。
ONLYOFFICE Mail ドメイン名
| パラメータ | 説明 |
|---|---|
-md, --maildomain | ONLYOFFICE Mailのドメイン名 |
このパラメータを使用して、ONLYOFFICE Mailに使用する独自のドメイン名を指定できます。
例
bash workspace-enterprise-install.sh -md "yourdomain.com"
これにより、ONLYOFFICE Workspace エンタープライズ版のすべてのコンポーネントがインストールされ、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-enterprise-install.sh -u true
これにより、更新が必要なコンテナが停止され、削除された後、対応するONLYOFFICE Workspace エンタープライズ版コンポーネントの最新バージョンが実行されます。現在のコンポーネントバージョンが最新の利用可能なバージョンと一致する場合、そのコンテナは影響を受けません。前回のインストール時にいくつかのコンポーネントをスキップした場合、それらもスキップされます。ポータルのデータは自動的に引き継がれるはずです。
認証情報
| パラメーター | 説明 |
|---|---|
-un, --username | dockerhub ユーザー名 |
-p, --password | dockerhub パスワード |
これらのパラメーターは、テストリポジトリにアクセスするための認証情報を提供する場合に使用され、そこに保存されているイメージからコンテナを実行できます。
例
bash workspace-enterprise-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を使用します。
ONLYOFFICE Community Serverをインストールする際にONLYOFFICE Control Panelのインストールをスキップしないでください。そうしないと、インストール完了後にライセンスキーを入力したり、例えばONLYOFFICE MailをONLYOFFICE Workspace エンタープライズ版インスタンスに追加したりすることができなくなります。
例
bash workspace-enterprise-install.sh -ims false
これにより、ONLYOFFICE Mailを除くすべてのONLYOFFICE Workspace エンタープライズ版コンポーネントがインストールされます。
bash workspace-enterprise-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 CommunityまたはONLYOFFICE Workspace エンタープライズ版。
例
bash workspace-enterprise-install.sh -it WORKSPACE
これにより、ONLYOFFICE Community ServerとONLYOFFICE Control Panelコンポーネントがインストールされます。
コンポーネントを外部サーバーとして使用
| パラメーター | 説明 | 値 | デフォルト |
|---|---|---|---|
-es, --useasexternalserver | 外部サーバーとして使用 | true|false | false |
このパラメーターは、コンポーネントを別のマシンにインストールする場合に使用されます。
- ONLYOFFICE DocsとONLYOFFICE Mailを別のマシンにインストールする場合は
trueを使用します。 - ONLYOFFICE Community ServerとONLYOFFICE Control Panelを別のマシンにインストールする場合は
falseを使用します。
例
bash workspace-enterprise-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-enterprise-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-enterprise-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-enterprise-install.sh -mysqlru root -mysqlrp new-secret-pw
このコマンドを使用すると、ONLYOFFICE Workspace エンタープライズ版のインストール中にMySQLルートアカウントのパスワードを設定できます。
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-enterprise-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-enterprise-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-enterprise-install.sh -cp 8080
core.machinekey の設定
| パラメータ | 説明 |
|---|---|
-mk, --machinekey | core.machinekey キーの設定 |
このパラメータを使用すると、ONLYOFFICE Workspace エンタープライズ版のインストール時に独自の machinekey を指定できます。
このパラメータは、/app/onlyoffice/CommunityServer/data/.private/machinekey 設定ファイルに書き込まれます。
例
bash workspace-enterprise-install.sh -mk yourmachinekey
JWT シークレットの設定
| パラメータ | 説明 |
|---|---|
-jwt, --jwtsecret | JWT シークレットキーの設定 |
このパラメータを使用すると、ONLYOFFICE Workspace エンタープライズ版のインストール時に独自の JWT シークレットキーを指定できます。このシークレットキーは、JSON Web トークンの署名と、ONLYOFFICE Docs へのリクエスト時のトークンの検証に使用されます。
このパラメータは、次の設定ファイルに書き込まれます（パスはコンテナ内で指定されています）：
- Community Server 用 -
/var/www/onlyoffice/WebStudio/web.appsettings.config - Document Server 用 -
/etc/onlyoffice/documentserver/local.json
例
bash workspace-enterprise-install.sh -jwt yoursecret