メインコンテンツへ移動
AIチュートリアル

Turb GPT Register チュートリアル:ローカル登録フローとWebUIの構築

このチュートリアルでは、Turb GPT Registerの用途、ディレクトリ構成、インストール手順を紹介し、WebUIの起動方法、ローカル設定の管理、サードパーティサービスの問題の切り分け、機密データの保護について説明します。

Turb GPT Register チュートリアル:ローカル登録フローとWebUIの構築

プロジェクト概要

Turb GPT Register は、ローカル環境で実行する登録フローツールです。gpt-free-register をベースに整理・拡張されています。メール、プロキシ、登録フローを一元管理でき、プロトコル駆動方式に加えて、ローカルのフィンガープリントブラウザーにも接続できます。

プロジェクトはコマンドラインから起動でき、実行環境の設定やタスク管理に使用するローカルWebUIも提供します。ただし、アカウント、メール、プロキシを提供するものではなく、サードパーティサービスが常に利用できることを保証するものでもありません。

自分に使用権限のある環境でのみ実行し、関連するサービス、メールプロバイダー、プロキシプロバイダーの規則を遵守してください。

主な機能とプロジェクト構成

主な特徴

  • ローカル環境で実行し、設定と結果をローカルに保存します。
  • メールサービス、プロキシ、登録フローを一元管理します。
  • プロトコル駆動の登録コンポーネントに対応します。
  • ローカルのフィンガープリントブラウザーと連携できます。
  • コマンドラインエントリーポイントとローカルWebUIを提供します。
  • コアロジック、設定、ページ、ツール、サードパーティコンポーネントをディレクトリごとに管理します。

ディレクトリの説明

  • core/:メインプログラムとコアロジック。
  • config/:プロジェクト設定。
  • webui/:ローカル管理ページ。
  • tools/:補助スクリプト。
  • vendor/gpt-register-tool/协议:プロトコル登録コンポーネントと関連ファイル。

コードや設定の問題を調査するときは、まず機能に応じて該当するディレクトリを特定すると、通常はリポジトリ全体を検索するより効率的です。

インストール前の準備

プロジェクトではPython 3.11の使用を推奨しています。以下のインストールコマンドはWindows PowerShell向けで、リポジトリをすでにローカルへダウンロードしていることを前提とします。

また、利用可能なメールサービスとプロキシ設定を自分で用意する必要があります。ブラウザードライバーを使用する場合は、追加のブラウザーやプロバイダークライアントのインストールが必要になることもあります。pip installでインストールされるのはPython依存関係のみで、これらの外部プログラムは自動的にインストールされません。

インストールと起動

ステップ1:仮想環境を作成する

リポジトリのルートディレクトリでPowerShellを開き、.venvという名前のPython仮想環境を作成します。

python -m venv .venv

ステップ2:仮想環境を有効化する

.venv\Scripts\Activate.ps1

有効化すると、その後にインストールするPythonパッケージはこのプロジェクトの仮想環境に配置され、システム上の他のPythonプロジェクトに影響しません。

ステップ3:依存関係をインストールする

pip install -r requirements.txt

インストールに失敗した場合は、完全なエラー情報を記録し、Pythonのバージョン、ネットワーク環境、依存関係のインストールログを確認してください。

ステップ4:ローカル設定ファイルを作成する

Copy-Item .env.example .env

.env.exampleは設定例です。コピー後、自分の.envを編集し、実行環境に必要な設定を入力してください。

実際のメール認証情報、プロキシキー、その他の機密情報を.env.exampleに書き戻さないでください。また、実際の認証情報を含む.envをGitにコミットしないでください。

ステップ5:WebUIを起動する

python web.py

プログラムの起動後、ローカルWebUIを開き、ページに表示される設定項目に自分のメールサービスとプロキシ情報を入力して、該当するタスクを管理します。READMEでは固定のページアドレスやフィールド名を保証していないため、プログラムの起動ログと現在のWebUI画面を基準にしてください。

基本的な使用手順

  1. Python 3.11、仮想環境、プロジェクトの依存関係が準備できていることを確認します。
  2. .env.exampleから.envを作成し、自分の実行設定を入力します。
  3. python web.pyでローカル管理ページを起動します。
  4. WebUIで、自分に使用権限のあるメールサービスとプロキシを設定します。
  5. ローカル環境に応じて、プロトコル駆動方式またはブラウザー駆動方式を選択します。
  6. タスクの実行後、結果とログを確認し、メール、プロキシ、ドライバーの各工程が正常か確認します。

PowerShellでの完全な起動例は次のとおりです。

python -m venv .venv
.venv\Scripts\Activate.ps1
pip install -r requirements.txt
Copy-Item .env.example .env
python web.py

プロトコル登録コンポーネントを単独で使用する

プロトコル登録コンポーネントはvendor/gpt-register-tool/协议にあります。メインWebUIから分離して単独で実行する場合は、このディレクトリに移動し、コンポーネント自身の説明を読んで、指定された依存関係をインストールしてください。

このディレクトリのコンポーネントには、それぞれ独立した上流の出典、ライセンス、著作権表示がある場合があります。使用前に、メインプロジェクトのインストール方法やライセンスがすべてをカバーすると決めつけず、コンポーネント固有のドキュメントとライセンスファイルも確認してください。

高度な使用方法とメンテナンスのヒント

まずログと設定から問題を調査する

登録フローは、メールプロバイダー、プロキシサービス、ブラウザー環境に依存します。いずれかがインターフェースを変更したり、ネットワークが不安定になったり、クライアントの動作が変わったりすると、フローが失敗する可能性があります。問題が発生した場合は、次の順序で確認できます。

  1. 完全なログを確認し、最初に発生したエラーを特定します。
  2. .envとWebUIの設定を照合します。
  3. メールサービスに引き続きアクセスできるか確認します。
  4. プロキシ認証情報、ネットワーク接続、安定性を確認します。
  5. ブラウザードライバーを使用している場合は、ブラウザーまたはプロバイダークライアントが正しくインストールされ、実行されていることを確認します。
  6. プロトコルコンポーネントを使用している場合は、そのディレクトリ内の依存関係と上流の説明を確認します。

ローカル実行データを保護する

メールプール、プロキシ認証情報、アカウントデータベース、ブラウザープロファイル、ログ、エクスポートファイルは、すべてローカル実行データです。これらのファイルには機密情報が含まれる可能性があるため、公開または共有リポジトリにコミットしないでください。

プロジェクトの.gitignoreでは一般的なデータファイルが除外されていますが、コードをコミットする前に、コミット対象の一覧を必ず自分でも確認してください。認証情報の保護をファイル名や無視ルールだけに依存しないでください。

有効な問題報告を作成する

プロジェクトにIssueやPull Requestを提出する必要がある場合は、十分な診断情報を添付してください。

  • エラー内容の全文または重要な部分。
  • OS、Pythonのバージョン、関連する実行環境。
  • 再現可能な手順。
  • プロトコル駆動方式とブラウザー駆動方式のどちらを使用したか。
  • パスワード、トークン、プロキシ認証情報を隠した必要な設定内容。

実際の認証情報を公開して貼り付けないでください。明確な環境情報と再現手順があれば、「使えない」とだけ説明するよりも問題を特定しやすくなります。

サードパーティ依存関係の変更に注意する

メールインターフェース、プロキシネットワーク、ブラウザープロバイダーのクライアントは、それぞれ独自に変化する可能性があります。プロジェクトではこれらの要素を設定とドライバーに分離しており、自分の環境に合わせて調整しやすくなっていますが、この設計によってサードパーティの変更に起因するエラーがなくなるわけではありません。アップグレードや変更の前に、現在使用できている設定を保持し、各工程を個別に検証することを推奨します。

ライセンスと使用範囲

メインプロジェクトはxiaoguzuiniu/gpt-free-registerをベースに改修され、MIT Licenseのもとで公開されています。詳細はリポジトリ内のLICENSEを確認してください。

vendor/gpt-register-tool/协议内のコンポーネントには、それぞれ上流のライセンスと著作権表示が適用されます。これらのコンポーネントを配布、変更、デプロイする前に、各コンポーネントのライセンス要件を個別に確認してください。

まとめ

Turb GPT Registerは、メール、プロキシ、プロトコルコンポーネント、ブラウザードライバーをローカルワークフローに統合し、WebUIを通じて一元管理できるようにします。使用時は、まずPython 3.11環境、依存関係、.envの設定を完了し、自分に適法な権限のある環境に応じてドライバー方式を選択してください。問題が発生した場合は、まずログ、設定、サードパーティサービスの状態を確認し、すべてのローカル認証情報と実行データを適切に保護してください。