追加のスクリプトパラメーターを使用して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ドメイン名が使用されます。
上記のコマンドでは、
"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ルートアカウントのパスワードを独自に設定できます。
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 ウェブトークンの署名と、ONLYOFFICE Docs へのリクエスト時のトークンの検証に使用されます。
- Community Server 用 -
/var/www/onlyoffice/WebStudio/web.appsettings.config - Document Server 用 -
/etc/onlyoffice/documentserver/local.json
例
bash workspace-install.sh -jwt yoursecret