ShimoDocs クイックスタート | セットアップ手順

← ShimoDocs Suite デプロイメント文書

Tip

この記事では、以下の方法を紹介します mdp-installer を使用して、 ShimoDocs Suite.

この記事は以下の対象に向けて書かれています オールインワン単一ノードのオンラインインストール シナリオは、初めてのインストール、製品体験、機能検証、展開プロセスの練習に適しています。この記事を完成させると、 ShimoDocs Suite ビジネスアクセスアドレスと MDP 運用プラットフォームアドレスを取得できます。

ページ上のIPアドレス、インストーラーパッケージ名、 VERSIONおよびディレクトリは例示用です。実際の展開では、現在の環境および提供された資料を参照してください。

1. 展開プロセスの概要

全体のプロセスは以下の7つのステップに分けられます:

ステップ	完了するためのアクション	完了インジケーター
1. サーバーとインストール資料の準備	サーバー、インストーラー、および ShimoDocs Suite 配布パッケージが利用可能であることを確認する	サーバーにログインでき、インストールファイルを見つけられること
2. インストーラーを起動する	インストールノードで `mdp-installer` を実行する	ターミナルにインストーラーアクセスアドレスを表示
3. 配布パッケージをアップロード	ブラウザで ShimoDocs Suite 配布パッケージを選択	ページに配布パッケージが検証に合格したことが表示される
4. デプロイ環境を構成	ドメインまたはIP、デプロイモード、ノードログイン情報、データディレクトリを入力	ノードが正常に検証され、デプロイ概要にアクセス可能
5. 環境チェック	インストーラーがサーバーとデプロイ環境をチェックするまで待機	インストールを妨げる失敗なし
6. インストール開始	チェック結果を確認してデプロイを実行	ページにインストール完了が表示される
7. 配信情報を保存	アクセスアドレスを保存し、ログイン、サービス、機能の確認を完了	ビジネスページおよび MDP オペレーションプラットフォームにアクセス可能

2. デプロイ前準備

1. インストールノードを準備

インストールノードはインストーラーを実行するために使用され、All-in-Oneの単一ノードデプロイの対象サーバーとなる

開始前に確認してください：

使用可能なサーバーが準備され、 SERVER_IPアドレスが取得されている
サーバーにアクセス可能 SSH.
SSH ユーザーは root、またはデプロイ作業を行うために必要な権限を持っている
サーバー CPU アーキテクチャがインストーラーおよび配布パッケージに一致している、例：両方とも x86_64.
サーバーは現在のデプロイ仕様に適合している。Ubuntu 24.04の最小インストールを使用することを推奨 LTS.
ルートパーティションとデータスペースは現在の展開要件を満たしており、データディレクトリが決定されています。
サーバーの時間とタイムゾーンは正しく、時間の同期は正常です。
ブラウザを持つコンピュータはインストールノードのポートにアクセスできます。 18080/TCP インストールノードのポートにアクセスできます。
サーバーは、デプロイメントパッケージやイメージリソースをオンラインでダウンロードするためにインターネットにアクセスできます。
ビジネスアクセスでドメイン名を使用する場合は、事前にドメイン名の解決が完了している必要があります（オプション）。

最小サーバー要件は以下の通りです:

オペレーティングシステム	アーキテクチャ	CPU	メモリ	ディスク
Ubuntu 24.04 LTS	`x86_64`	16コア	32 GB	100 GB SSD

さらに、次のことを確認してください:

パーティションしないでください /root, /var, /tmp 別々に。
インストール前に、Dockerなどの追加コンポーネントを展開しないでください Kubernetes 。
ポート 22/TCP は次の用途に使用されます SSH, 18080/TCP はインストーラーのウェブページに使用されます、 80/TCP および 443/TCP は業務アクセスに使用されます。

正式な展開の前に、実際の同時接続数、ファイルサイズ、および可用性の要件に応じてサーバー仕様を確認することを推奨します。本書での単一ノードプロセスは迅速な展開と検証に適しています。長期運用や高可用性の場合は、対応するクラスタ展開方式を使用してください。

2. インストール材料の準備

インストーラーを入手する

提供されたインストーラーを ShimoDocs にアップロードします /root/ インストールノードのディレクトリ。次のいずれかの方法を選択できます:

方法 1: SSH ツールを介してアップロード. mdp-installer-amd64 にアップロードします /root/ インストールノードのディレクトリにアップロードします。

配布パッケージの取得

配布パッケージの準備 ShimoDocs Suite このデプロイメントのための配布パッケージを準備します。配布パッケージはウェブインストールページにアップロードされ、ファイル名とバージョンは実際の納品に従う必要があります。

ファイル名の例: co1.8.20260711.3286-drive-release.tar.gz

部材表は以下の通りです:

ファイル	説明
`mdp-installer` インストーラー	サーバーアーキテクチャに応じて対応するファイルを選択してください。例: `mdp-installer-amd64`.
ShimoDocs Suite 配布パッケージ	ファイル名とバージョンは実際の納品に従う必要があります。例: `co1.8.20260711.3286-drive-release.tar.gz`.

インストーラーおよび関連するインストール資料は、後で簡単に取得および保管できるよう、同じ作業ディレクトリに置くことを推奨します。配布パッケージを使用する前に、ファイルが完全であり、転送ツールによって破損していないことを確認してください。

3. インストーラーの起動

1. インストールノードにログイン

インストールノードにログインし、 SSH インストーラーがあるディレクトリに移動します。例:

ssh root@<INSTALL_NODE_IP>
cd /root

2. 実行権限の追加

インストーラーにまだ実行権限がない場合は、次を実行してください:

chmod +x ./mdp-installer-amd64

コマンド内のファイル名は、実際のインストーラー名に置き換える必要があります。

3. ウェブインストールページの起動

次を実行します:

./mdp-installer-amd64 server

現在のターミナルを終了した後もインストーラーを実行し続ける必要がある場合は、次を使用できます:

nohup ./mdp-installer-amd64 server > nohup.out 2>&1 &

正常に起動すると、ターミナルには2つのアドレスが表示されます:

Local: インストールノード自体でのみ使用します。
Network: 同じネットワーク上の他のコンピューターからアクセス可能です。

バックグラウンドモードで起動した場合、次のコマンドを実行してインストーラーの出力を確認できます:

cat nohup.out

開く Network ブラウザのターミナルに表示されるアドレス、例えば：

http://<INSTALL_NODE_IP>:18080/

インストール中は、インストーラーのプロセスを実行したままにしてください。インストーラーのプロセスを閉じたり、現在のサービスを停止したりしないでください。

4. アップロード ShimoDocs Suite リリースパッケージ

1. リリースパッケージを選択

インストールページにアクセスした後：

クリック デプロイを開始 またはページ上のリリースパッケージ選択項目。
選択 ShimoDocs Suite .tar.gz このデプロイメントで使用するリリースパッケージ。
ファイルのアップロードおよび検証が完了するまで待ちます。

2. 検証結果の確認

検証が通過した後、ページにはリリースパッケージ名とデプロイメント構成項目が表示されます。

次の情報が正しいことを確認してください：

パッケージ名が今回配布されたバージョンと一致していること。
リリースパッケージが ShimoDocs Suite 製品に属していること。
ページにファイル破損、形式エラー、スキーマ不一致が表示されていないこと。

確認後、クリック続行デプロイメント構成に進む。

検証に失敗した場合、配布パッケージが完全か、ファイルタイプが正しいか、配布パッケージがサーバーの CPU アーキテクチャに一致しているか再確認してください。

5. デプロイメント環境の構成

1. ネットワークアドレスの確認

ページに表示されるホスト名またはIPアドレスを確認してください。このアドレスはユーザーが通常アクセスできるインストールノードのアドレスである必要があります。

入力しないでください 127.0.0.1、現在のコンピュータからのみアクセス可能な一時的なアドレスは使用しないでください。ドメイン名を使用してアクセスする場合は、ドメイン名が正しいサービスエントリに解決されていることを確認してください。

2. オールインワン単一ノードモードを選択

選択 オールインワン単一ノード 展開モードまたはターゲット環境で（ページに表示される実際の名前は現在のバージョンにより異なる場合があります）。

このモードでは、インストールノードがこの展開の制御役割と業務役割の両方を同時に担うため、製品体験、機能検証、単一ノード計画のための軽量環境に適しています。

3. ノードの構成 SSH

インストーラはターゲットノードに接続し SSH 展開タスクを実行します。次の情報を入力してください：

NODE_IPアドレス。
SSH ユーザー、通常 root.
SSH ポート、通常 22 デフォルトで。
PASSWORD または秘密鍵認証情報。

入力が完了したら、クリックしてください確認して接続が成功したことを確認します。 SSH

SSH 資格情報は、管理された環境でのみ使用および保存する必要があります。公開文書、スクリーンショット、またはチャット記録に書き込まないでください。 PASSWORD

4. データディレクトリおよびその他の設定を行う

ページの指示に従って次の設定を入力または確認してください:

構成項目	説明
ACCESS_DOMAIN / IP	ユーザーがアクセスするためのアドレス ShimoDocs Suite; IPを使用する場合は、実際にアクセス可能なアドレスを入力してください。
デプロイモード	All-in-One単一ノードモードを選択します。
ノードデータディレクトリ	デプロイデータを保存するために使用します。ディスクに十分な空き容量があり、読み書き権限があることを確認してください。
オフラインリポジトリ	このガイドはオンラインインストール用です。ページ上のデフォルト値はそのまま使用してください。
サードパーティミドルウェア	このガイドではデフォルトの展開を使用しています。外部ミドルウェアが必要かどうかは、現在の納品要件に従って確認してください。

特別な構成要件がない場合は、オフラインリポジトリおよびサードパーティミドルウェアのデフォルト値を保持できます。確認後、クリックしてください。 展開の初期化 ページ下部にあります。

6. 展開概要の確認

展開概要は、正式なチェック前にインストール構成を検証するために使用されます。

次の点に特に注意してください:

リリースパッケージのバージョンと製品名が正しいことを確認してください。
ACCESS_DOMAIN または IP が正しいこと、誤っていないことを確認してください。 127.0.0.1.
展開モードは All-in-One 単一ノードです。
NODE_IP、 SSH ユーザーおよびポートが正しいことを確認してください。
データディレクトリが正しく、ディスク容量が十分であることを確認してください。
オフラインリポジトリおよびサードパーティミドルウェアの構成は現在の環境と一致しています。

エラーがないことを確認した後、クリックして続行環境チェックに進んでください。

7. 環境チェックの実行

インストーラーはノードと展開環境をチェックします。チェック処理には数分かかる場合がありますので、ページを開いたままにしてください。

1. ノード概要の表示

ノード概要には、以下のチェック進行状況が表示されます: SSH 接続性、システムとパフォーマンス、ストレージとディスク、ネットワーク、および展開環境。

特定のチェックの詳細結果を表示するには、該当するチェック項目または詳細エントリをクリックしてください。

2. 詳細チェック結果を表示する

詳細結果には通常以下が含まれます:

SSH 接続および実行ユーザー権限。
オペレーティングシステム、 CPU アーキテクチャ、およびコア数。
メモリ容量、ディスク容量、およびディレクトリ権限。
タイムゾーンおよび時間同期の状態。
ネットワーク、イメージリソース、および外部サービスへの接続。
展開に影響を与える可能性のあるサーバー上の環境残留物。

3. チェックステータスの理解

ステータス	意味	次のアクション
成功	現在のチェック項目は展開要件を満たしています	他の項目の完了を待ち続ける
警告	展開を直接ブロックすることはありませんが、現在の計画に沿っているか確認が必要です	詳細を開き、影響を確認した後に続行
失敗	現在の問題はインストールや製品の動作に影響する可能性があります	まず問題を修正してから再スキャン
進行中	インストーラーがチェックを実行しています	チェックが完了するまで待ち、繰り返し操作を行わない

項目が長時間「進行中」の場合は、まず現在のディスクまたはリモートチェックが完了するのを待ってから、再スキャンするかどうかを決定できます。

4. 警告および失敗の対処

ページに警告が表示された場合:

該当チェック項目の詳細説明を開く。
警告が現在の展開計画に沿っているか確認する。
不明な場合は、ページとインストーラーログを保存してから、実施担当者または運用担当者に確認する。

ページが表示できない場合:

プロンプトに従って、 SSH、権限、リソース、ディスク、ネットワーク、またはミドルウェアの問題を修正してください。
クリック 再スキャン.
失敗した項目が消えていることを確認してください。

デプロイを妨げる失敗がなく、すべての警告が確認されたことを確認した後、クリックしてください続行.

8. インストールを開始

1. インストール計画を確認

ページにインストール計画と実行されるタスクが表示されます。正しいことを確認した後、クリックしてください デプロイを開始.

ページに「インストール開始を確認」プロンプトが表示される場合があります。開始すると、インストールタスクは予定通り実行されます。構成を調整する必要がある場合は、クリックしてください キャンセル 前のステップに戻ります。

2. デプロイ進行状況の確認

デプロイを開始した後、ページには現在のタスク状況、リアルタイムログ、および実行時間が表示されます。単一ノードのデプロイには通常約10分かかり、実際の時間はサーバーの性能やネットワーク帯域幅によって影響を受けます。

インストール中、以下に注意してください：

インストーラープロセスを閉じないでください。
インストールノードを再起動しないでください。
インストールタスクを更新、戻る、再送信しないでください。
タスクが失敗した場合、まず対応するタスクログ内の最初のエラーを確認し、プロンプトに従って処理してください。

ページに表示されたら インストール完了 または デプロイ納品 ページに入ると、インストールタスクが完了したことを示します。

9. 納品情報を保存

インストール完了ページには、このデプロイメントのアクセス情報とチェック項目が表示されます。次の操作を直ちに完了してください：

インストール後のサービスチェックを実行し、チェック結果を確認してください。
デプロイメント配信ページのアクセス情報を使用して、 ShimoDocs Suite ビジネスページを開き、ログイン確認を完了してください。
次を記録してください： ShimoDocs Suite ビジネスアクセスアドレスと MDP オペレーションプラットフォームのアドレス。
初期アカウントおよび一時パスワードを保存してください。 PASSWORD、そして最初のログイン後すぐに初期の PASSWORD を変更してください。
クラスタノードとアプリケーションのステータスを確認してください MDP オペレーションプラットフォーム。

納品情報にはアクセスアドレスと初期認証情報が含まれます。スクリーンショットを撮って配布しないでください。公開ナレッジベースにアップロードしないでください。また、管理されていないチャネルで送信しないでください。

10. デプロイ結果の確認

インストール完了後、以下の順序で受け入れ検証を行うことを推奨します:

1. インストール後サービスの確認

インストール完了ページでインストール後の確認を行い、サービスのテストケースが合格するか、または結果が現在の環境の期待に沿っていることを確認します。

確認が失敗した場合や部分的にしか合格しなかった場合、検査タスクを再提出できます。 MDP オペレーションプラットフォーム。

2. 確認 MDP 操作プラットフォーム

にログインし、 MDP オペレーションプラットフォームに移動して システムサービス → クラスター管理を開き、クラスターのノードおよびアプリケーションの稼働状況が正常であることを確認します。

3. 機能の検証 ShimoDocs Suite

にログインし、 ShimoDocs Suite フロントエンドページで、少なくとも以下の機能を確認してください：

テストファイルまたはスイートを作成する。
コンテンツを編集して保存する。
ファイルをエクスポートする。
ファイルをインポートする。

上記のすべてのチェックが正常に完了した場合、このクイックデプロイが完了したことを示します。将来的に長期運用、スケーリング、または高可用性が必要な場合は、実際の規模に応じて対応するデプロイメントプランに切り替え、ライセンスおよび業務設定を完了してください。

11. よくある質問

1. ブラウザでインストールページを開けない

順番に確認してください：

インストーラープロセスがまだ実行中かどうか。
アクセスアドレスが、インストールノードの実際のIPまたは名前解決可能なドメイン名を使用しているかどうか。
ポート 18080/TCP 開かれているか。
ブラウザのあるコンピュータとインストールノード間のネットワークが接続されているかどうか。

2. 配布パッケージの検証に失敗

確認してください：

アップロードされたファイルが完全な .tar.gz リリースパッケージであるかどうか。
ファイル名と製品タイプが今回の配布と一致しているかどうか。
リリースパッケージがサーバーと一致しているかどうか CPU アーキテクチャに一致しているか再確認してください。
アップロードまたは転送中にファイルが破損していないかどうか。

3. SSH 認証に失敗

確認してください：

かどうか NODE_IPおよび SSH ポートが正しいかどうか。
かどうか SSH ユーザー、 PASSWORD、またはプライベートキーが正しいかどうか。
デプロイに必要な権限を SSH ユーザーが持っているか。
ファイアウォールまたはセキュリティグループが接続を許可しているかどうか。 SSH 接続。

4. 環境チェックの警告

警告は直接的に展開を防ぐものではありませんが、影響を確認するために詳細を開く必要があります。ディスク性能、時刻同期、設定残留、または外部サービスが関わる場合は、続行するかどうかを決定する前に、現在の展開計画と一致するかを最初に確認してください。

5. 環境チェックの失敗

失敗項目はまず修正する必要があります。チェックを回避して直接インストールを開始しないでください。修正後、 再スキャン をクリックして失敗項目が通過したことを確認してください。

6. インストールタスクの失敗

失敗したタスクの実行ログを開きます。
最初に表示されたエラーメッセージを探します。
インストーラーログ、失敗したタスク名、発生時刻を保存します。
該当するネットワーク、ディスク、イメージ、ミドルウェア、または Kubernetes 問題に対処した後、実際の復旧方法に従って続行します。