メインコンテンツへスキップ

blocklet server

blocklet server コマンドは、Blocklet Server インスタンスのライフサイクルと設定を管理するための主要なツールです。サーバーとそれに実行されているすべての blocklet の初期化、起動、停止、監視を可能にします。これらのコマンドは、Blocklet Server を自己ホスティングしているサーバー管理者や開発者にとって不可欠です。

個々の blocklet の管理(例:作成、開発、デプロイ)については、blocklet コマンドリファレンス を参照してください。

使用法

Basic Usage

bash
blocklet server <command> [options]

グローバルオプション

これらのオプションは、どの blocklet server サブコマンドでも使用できます。

  • -c, --config [node-config] string — Blocklet Server 設定ファイルへのパスを指定します。
  • -y, --yes boolean (default: false) — プロンプトに対して自動的に「yes」と回答します。スクリプトに便利です。

コマンド

init

現在のディレクトリに新しい Blocklet Server 設定を初期化します。このコマンドは、主要な config.yml ファイルを含む、必要なファイルとフォルダを作成します。

使用法

bash
blocklet server init [options]

オプション

  • -f, --force boolean (default: false) — 質問を一切尋ねずに Blocklet Server インスタンスを初期化し、すべてのデフォルト値を受け入れます。
  • -i, --interactive boolean (default: false) — 設定をカスタマイズするためにインタラクティブモードで実行します。--force が使用されている場合は無視されます。
  • --mode string (default: production) — 初期サーバーモードを設定します。許可される値は productiondebug です。
  • --https boolean (default: true) — ダッシュボードと blocklet のデフォルトの HTTPS サポートを有効にします。
  • --no-https boolean — デフォルトの HTTPS サポートを無効にします。
  • --sk string — Blocklet Server にカスタムシークレットキーを提供します。
  • --web-wallet-url string — カスタム Web ウォレットの URL を指定します。
  • --http-port number (default: 80) — サービスゲートウェイの HTTP ポートを設定します。
  • --https-port number (default: 443) — サービスゲートウェイの HTTPS ポートを設定します。
  • --owner-nft-holder string — 所有権 NFT を保持するアカウントの DID。
  • --owner-nft-issuer string — 所有権 NFT を発行したアカウントの DID。
  • --trusted-passport-issuer string — このノードが信頼するパスポート発行者の DID。
  • --disable-passport-issuance boolean (default: false) — このノードによるパスポートの発行を無効にします。

start

現在のディレクトリの設定に基づいて、Blocklet Server をバックグラウンドのデーモンプロセスとして起動します。

使用法

bash
blocklet server start [options]

オプション

  • -u, --update-db boolean — 設定ファイルからの最新の設定で Blocklet Server データベースを更新します。
  • --update-blocklet-env boolean (default: false) — インストールされているすべての blocklet の環境を更新します。
  • -k, --keep-alive boolean (default: false) — サーバーが正常に起動した後、終了せずにコマンドを実行し続けます。
  • -a, --auto-init boolean (default: false) — 設定ディレクトリが存在しない場合、開始前に自動的に初期化します。
  • -m, --force-mode string — 指定されたモード(例:productiondebugmaintenance)でサーバーを強制的に起動します。
  • --force-intranet boolean (default: false) — 外部 IP アドレスを無視して、サーバーをイントラネットモードで強制的に実行します。

stop

実行中の Blocklet Server と関連するすべての blocklet プロセスを正常に停止します。

使用法

bash
blocklet server stop [options]

オプション

  • -f, --force boolean (default: false) — すべての Blocklet Server 関連プロセスを即座に強制停止します。

status

Blocklet Server の現在のステータス(モード、データディレクトリ、インストールされているすべての blocklet のステータスを含む)を確認して表示します。

使用法

bash
blocklet server status [options]

オプション

  • --force-intranet boolean (default: false) — ステータスチェックをイントラネットモードで強制的に使用し、外部 IP アドレスを無視します。

logs

Blocklet Server と個々の blocklet のログファイルへのファイルパスを表示し、簡単なアクセスとデバッグを可能にします。

使用法

bash
blocklet server logs

upgrade

Blocklet Server CLI を npm レジストリから利用可能な最新バージョンにアップグレードします。

使用法

bash
blocklet server upgrade

info

デバッグや問題報告に役立つ環境情報を収集して表示します。これには、OS、バイナリ(Node、npm)、サーバー設定、ネットワーク詳細が含まれます。

使用法

bash
blocklet server info [options]

オプション

  • -C, --clipboard boolean (default: false) — 環境情報を自動的にクリップボードにコピーします。

cleanup

さまざまなサーバーレベルのクリーンアップタスクを実行します。

使用法

bash
blocklet server cleanup [options]

オプション

  • --target string (required) — クリーンアップのターゲットを指定します。利用可能なオプションは cache、maintenance-status、blacklist、blacklist-expired です。

migrate

Blocklet Server データベースをあるシステムから別のシステムに移行します。現在、SQLite から PostgreSQL への移行をサポートしています。

使用法

bash
blocklet server migrate [options]

オプション

  • --dialect string (required) — 移行先のデータベースダイアレクト。利用可能なオプションは sqlite と postgres です。

nginx

Nginx を Blocklet Server のリバースプロキシとして設定します。これは、Nginx が SSL ターミネーションやロードバランシングなどのタスクを処理できる本番環境で役立ちます。

使用法

bash
blocklet server nginx [options]

オプション

  • --setup boolean — Blocklet Server の Nginx 環境をセットアップします。これには通常、sudo 権限が必要です。