コンテンツにスキップ

Cloudflare Tunnel

ローカルエンジンに公開HTTPS URLを付与し、TomoriBotに保存できるようにします。PC上でエンジンと cloudflared を実行すると、ホストされたボットがそのトンネルを通じて直接接続します。

Cloudflare TunnelはFreeプランで利用可能です。Cloudflare上で有効なドメインが必要であり、ドメイン登録やエンジンのアップストリームサービスには別途費用がかかる場合があります。

セットアップガイドに従ってエンジンを起動し、127.0.0.1 にバインドした状態を維持します。同じコンピューターに cloudflared をインストールします:

Terminal window
winget show --id Cloudflare.cloudflared --exact
winget install --id Cloudflare.cloudflared --exact
cloudflared --version

engine.example.com など、ご自身のCloudflareドメイン配下のホスト名を1つ決めます。このガイド全体を通じて、ご自身のホスト名に置き換えてください。

Terminal window
cloudflared tunnel login
cloudflared tunnel create home-engine

最初のコマンドはドメインを認可するためにブラウザーを開きます。2番目のコマンドはトンネルUUIDを表示し、認証情報JSONを作成します。そのファイルとアカウント証明書は非公開で保管してください。

.cloudflared フォルダー内に config.yml を作成します:

OSフォルダー認証情報ファイルの例
Windows%USERPROFILE%\.cloudflaredC:\Users\LOCAL_ACCOUNT\.cloudflared\TUNNEL_UUID.json
Linux~/.cloudflared/home/LOCAL_ACCOUNT/.cloudflared/TUNNEL_UUID.json
macOS~/.cloudflared/Users/LOCAL_ACCOUNT/.cloudflared/TUNNEL_UUID.json

CLIProxyAPI用のこの例を貼り付けます。UUID、絶対JSONパス、およびホスト名を置き換えてください。Windowsのバックスラッシュがそのまま解釈されるよう、認証情報パスはシングルクォートで囲んでください。

config.yml
tunnel: TUNNEL_UUID
credentials-file: 'ABSOLUTE_PATH_TO_TUNNEL_JSON'
ingress:
- hostname: engine.example.com
path: ^/v1/(models|chat/completions)$
service: http://127.0.0.1:8317
- service: http_status:404

別のエンジンの場合は、対応するタブを使用して path と service のみを置き換えます。パスルールによりTomoriBotのAPIルートが公開され、一致しないパスは404を返します。

path: ^/v1/(models|chat/completions)$
service: http://127.0.0.1:8317

実際のポートを使用してください。デフォルトはCLIProxyAPIが8317、ChatMockが8000、KoboldCPPが5001です。このプロファイルは他のOpenAI互換テキストエンジンもサポートしています。管理APIやモデルのアンロード操作は除外されます。

複数のエンジンを公開するには、末尾の404ルールの前にそれぞれのホスト名ルールを追加します。それぞれに固有のホスト名とループバックポートを割り当ててください。1つのトンネルですべてを処理できます。

config.yml が含まれるフォルダーでターミナルを開き、設定を検証します:

Terminal window
cloudflared tunnel --config ./config.yml ingress validate

次に、DNSを公開してトンネルを実行します:

Terminal window
cloudflared tunnel route dns home-engine engine.example.com
cloudflared tunnel --config ./config.yml run home-engine

複数のホスト名がある場合は、ホスト名ごとに route dns を1回ずつ実行してください。エンジンとコネクタを実行したままにしておきます。ルーターのポートフォワーディングやインバウンドのファイアウォール例外は不要です。テスト後は、自動起動のためにCloudflareのサービス手順を使用し、サービスアカウント用に設定ファイルと認証情報の明示的なパスを指定してください。

サーバー内で接続を共有する場合は /providers を、自分専用の接続を使う場合は /personal providers を開きます:

エンジンAPI互換性エンドポイントURL
CLIProxyAPI、ChatMock、KoboldCPP、その他のテキストエンジンOpenAI互換https://engine.example.com/v1
ComfyUIComfyUIhttps://engine.example.com
ローカルTTSラッパーtts-clonehttps://engine.example.com

エンジンがクライアントキーを要求する場合は、そのキーを認証トークンとして使用してください。そうでない場合は空欄のままにします。CLIProxyAPIは access.api-keys 配下のキーを使用します。KoboldCPPのテキストAPIは設定されたパスワードを使用します。TomoriBot側だけに任意のトークンを入力しても、エンジン側の認証は有効になりません。

保存した接続の下にモデルを追加し、対応する機能で選択して、小規模なリクエストをテストします。ComfyUIでは、参照画像のアップロード、出力のダウンロード、およびキャンセルもテストしてください。TTSでは、再生可能な音声になることを確認してください。エンジン側の管理機能は無効のままにしてください。

エンジンが認証を強制している場合は、保護されたリクエストがキーの欠落や誤りを拒否することを確認してください。認証がない場合は、以下の「既知のリスク」で残存する公開範囲を確認してください。AccessとCaddyによる任意の追加保護も利用できます。

症状確認事項
502エンジンが起動しているか、ループバックポートが正しいか、コネクタが同じPC上にあるか
1033またはトンネル切断コネクタプロセス、アウトバウンドのポート7844、ネットワーク接続、およびPCのスリープ
401エンジンのクライアントキーまたはパスワードがTomoriBotの認証トークンと一致しているか
403またはHTMLログインページ既存のAccessアプリケーションが直接のAPI呼び出しをブロックしている可能性があります。使用している場合は任意のAccessセットアップを参照してください
404正しいエンジンプロファイルとURLか。テキストでは /v1 を1つだけ使用してください
ストリーム切断または524エンジンやアップストリームの状態、PCのスリープ、およびCloudflareタイムアウト
大きなアップロードの失敗Cloudflareアップロード制限とボット・エンジン側の制限(base64によりペイロードサイズが増加します)

生成されたメディアはAPI経由でバイト列として返してください。ホストされたボットは、お使いのPCのローカルファイルパスやループバックダウンロードURLを読み取れません。本番エンドポイントには公開HTTPSと公開DNS応答が必要です。TLS検証とSSRFチェックは有効のままにしてください。

TomoriBotは、プロバイダーパネルを使用する際に以下のリスクをすでに軽減しています:

リスク既存の軽減策
一般メンバーがパネルに保存されたエンドポイントを読み取るパネルはエフェメラル表示です。サーバープロバイダー設定には サーバー管理 権限が必要であり、個人設定は実行したユーザー自身の構成のみを読み込みます。
プロバイダーエラーでチャットにURLやキーが露出する公開エラーにはローカライズされた説明が使用されます。生のテキストエラー詳細は、サーバー認証情報の場合はサーバー管理者に、個人認証情報の場合は所有者にのみ表示が制限されます。メディアツールの失敗は分類されたメッセージを返します。
ComfyUIの出力リンクからエンジンURLが判明するTomoriBotが出力をダウンロードしてDiscordにアップロードします。
ポートを開放するとPCが直接公開されるエンジンはループバック上にとどまり、cloudflared がアウトバウンド接続を行うため、公開インバウンドエンジンポートは不要です。