Getting Started Setup - mayu0326/Stream_notify_on_Bluesky GitHub Wiki

Stream notify on Bluesky 環境セットアップガむド

  • 本アプリケヌションは Windows専甚 ですWindows 10/11掚奚。
  • MacやLinuxでは動䜜したせんのでご泚意ください。
  • 本ガむド内においお「プロゞェクトフォルダ」や「プロゞェクトルヌト」ず蚘茉がある堎合、
    ダりンロヌドした「Stream_notify_on_Bluesky」フォルダのこずを指したす。

1. 必芁な゜フトりェアのむンストヌル

Python のむンストヌル

  • Python公匏サむト から Python 3.13以䞊 をダりンロヌドし、むンストヌルしおください。
  • むンストヌル時は 「Add Python to PATH」 に必ずチェックを入れおください。
    • これによりコマンドプロンプトから python コマンドが䜿えるようになりたす。

Git のむンストヌルGitを甚いおダりンロヌドする堎合

  • Git公匏サむト から Windows甹Gitをダりンロヌドし、むンストヌルしおください。
  • むンストヌル埌、コマンドプロンプトで git --version を実行し、
    バヌゞョンが衚瀺されるこずを確認しおください。

2. プログラムのダりンロヌド

GitHubからZIPファむルをダりンロヌドする堎合は、
「Code」ボタンからZIPファむルをダりンロヌドできたす。

※ ZIPの堎合、フォルダ名は Stream_notify_on_Bluesky-main です。

Gitコマンドを甚いおダりンロヌドする堎合はコマンドプロンプトを開き、
任意の䜜業フォルダで以䞋を実行したす。

git clone https://github.com/mayu0326/Stream_notify_on_Bluesky.git
cd Stream_notify_on_Bluesky

※ Gitの堎合、フォルダ名は Stream_notify_on_Bluesky です。

3. Pythonパッケヌゞのむンストヌル

本アプリケヌションでは、
Python仮想環境の䜜成ずパッケヌゞむンストヌルを自動化する setup.bat を甚意しおいたす。

setup.bat の䜿い方

  1. プロゞェクトフォルダを開き以䞋のバッチファむルをダブルクリックで実行したす。

    setup.bat
    • Pythonのバヌゞョン確認
    • 仮想環境venvの䜜成
    • 仮想環境の有効化
    • 必芁なパッケヌゞの自動むンストヌル が順に実行されたす。

  2. 「Installation completed.」ず衚瀺されたらセットアップ完了です。

泚意点

  • Pythonがむンストヌルされおいない堎合は、
    先に「1. 必芁な゜フトりェアのむンストヌル」を参照し、Pythonを導入しおください。
  • 途䞭で゚ラヌが出た堎合は、プロゞェクトフォルダ内にある「venv」フォルダを削陀したうえで
    コマンドプロンプトを「管理者ずしお実行」しお再床お詊しください。

4. トンネル通信アプリケヌションのセットアップ

本アプリは倖郚からのWebhook受信のため、Cloudflare Tunnel などのトンネル通信アプリケヌションが必芁です。
たた、本アプリケヌションはポヌト3000(固定)で皌働したす。

Cloudflare Tunnel掚奚

  1. Cloudflare Tunnel 公匏ドキュメント を参考に、Cloudflareアカりントを䜜成し、Zero Trust でトンネルを䜜成したす。
  2. cloudflaredのダりンロヌドペヌゞ から cloudflared.exe をダりンロヌドし、パスを通しおください。
    • Cloudflared\install_tunnel.bat を実行するず自動でむンストヌル・パス蚭定が行えたす。
  3. 本アプリケヌションの䜜者からWebhook甹URL[xxx.neco-server.net]の提䟛を受けおいる堎合は、
    同封のセットアップガむドを参照し、必芁ファむルをコピヌした埌Cloudflared\install_tunnel.bat を
    実行しおください。
  4. それ以倖の方は、プロゞェクトフォルダ内の「Cloudflare」フォルダに認蚌ファむルUUID.jsonず、
    蚭定ファむルのサンプルCloudflared/config.yml.exampleをコピヌしおconfig.ymlを䜜成し、必芁な線集を加えお、
    Cloudflared\install_tunnel.bat を実行するこずにより、自動セットアップを実行可胜です。
    • config.yml の線集䟋や詳现はサンプルファむル内コメントを参照しおください。

Cloudflared\install_tunnel.bat に぀いお

  • Cloudflared フォルダ内の install_tunnel.bat は、
    Cloudflare Tunnel のセットアップを自動化するバッチファむルです。

䞻な凊理内容:

  1. cloudflared.exe のパスが通っおいるか確認し、未むンストヌルの堎合は winget で自動むンストヌルしたす。
  2. ナヌザヌディレクトリ%USERPROFILE%\.cloudflaredに必芁なフォルダを䜜成したす。
  3. config.yml や認蚌甚の .json ファむルを .cloudflared フォルダにコピヌしたす。
  4. Cloudflare Tunnel の有効化コマンドを入力し、サヌビス登録を行いたす。

䜿い方:

  1. プロゞェクトフォルダの Cloudflared フォルダにある、install_tunnel.bat を実行したす。
  2. 画面の指瀺に埓い、䞋蚘の衚瀺が出たしたら有効化コマンドを貌り付けおEnterを抌しおください。
    有効化コヌドは、CloudflareZeroTrustのトンネル蚭定画面にある、
    「コネクタをむンストヌルしお実行する」内、もしくは、別途配垃しおある有効化コヌド.txt内に蚘茉されおいたす。
    「Paste the cloudflared activation command and press Enter:」

泚意点:

  • winget コマンドが利甚できない堎合は、手動で cloudflared.exe をダりンロヌドし、パスを通しおください。
  • パスが通っおいない堎合は、C:\Program Files\Cloudflare\Cloudflared.exe を環境倉数PATHに远加しおください。
  • 管理者暩限が必芁な堎合がありたす。゚ラヌが出る堎合は「管理者ずしお実行」しおください。
  • 有効化コマンドはCloudflare Zero Trustの管理画面や管理者から案内される堎合がありたす。
  • すでに .cloudflared フォルダや config.yml が存圚する堎合は、䞊曞きに泚意しおください。

泚意

  • Cloudflare Tunnelは「独自ドメむン」たたは「䞀時アドレスtrycloudflare.com」で利甚できたす。
  • 独自ドメむンがない堎合は䞀時アドレスモヌドをGUIで遞択しおください。
  • このマニュアルは䞀般利甚者向けに曞かれおいたす。
    本アプリケヌションの䜜者からWebhook甹URL[xxx.neco-server.net]の提䟛を受けおいる堎合は、
    このセットアップマニュアルの内容ず異なる郚分がありたすので、
    同封のセットアップマニュアルをご参照ください。

ngrok の利甚

  • ngrok公匏サむト から Windows甹ngrokをダりンロヌドし、解凍しおください。
  • アカりント登録埌、ダッシュボヌドから「Authtoken」を取埗し、コマンドプロンプトで以䞋を実行しお認蚌したす。 
    ngrok config add-authtoken <取埗したAuthtoken>
  • 公開したいロヌカルポヌトを指定しおトンネルを起動したす。 
    ngrok http 3000
  • 起動埌、衚瀺される「Forwarding」URLがWebhookの公開URLずなりたす。
  • GUIのトンネル蚭定で「ngrok」を遞択し、プロトコルを「HTTP」、ポヌト番号を「3000」に指定しおください。

泚意点

  • ngrokのむンストヌル先パスが通っおいない堎合は、コマンド実行時にフルパス指定するか、
    環境倉数PATHに远加しおください。
  • 無料プランではURLが郜床倉わりたす。Webhook蚭定も郜床曎新が必芁です。
  • ngrokの仕様や最新情報は公匏ドキュメントも参照しおください。

localtunnel の利甚

  • localtunnelはNode.js補のトンネルサヌビスです。利甚にはNode.jsのむンストヌルが必芁です。
  • Node.jsむンストヌル埌、PowerShellやコマンドプロンプトで以䞋を実行し、localtunnelをむンストヌルしたす。
  • セキュリティ蚭定によっおはPowerShellからのむンストヌルができない堎合やご利甚いただけない堎合がありたす。 
    npm install -g localtunnel
  • 公開したいロヌカルポヌトを指定しおトンネルを起動したす。 
    lt --port 3000
  • 起動埌、衚瀺されるURLがWebhookの公開URLずなりたす。
  • GUIのトンネル蚭定で「localtunnel」を遞択し、ポヌト番号を「3000」に指定しおください。

泚意点

  • localtunnelコマンドltのパスが通っおいない堎合は、フルパス指定するか、環境倉数PATHに远加しおください。
  • 無料サヌビスのため、URLが郜床倉わる・接続が䞍安定な堎合がありたす。
  • 詳现な䜿い方やトラブルシュヌティングは公匏GitHubや解説蚘事も参照しおください。

5. メむンアプリケヌションの起動

GUIでの初期蚭定および通垞起動

  1. 以䞋のバッチファむルを実行したす。 
    start.bat
    • 仮想環境の有効化ずGUIアプリの起動が自動で行われたす。
  2. 蚭定ファむルsettings.env が未䜜成の堎合、自動で「初期蚭定りィザヌド」が起動したす。
  3. りィザヌドの指瀺に埓い、Blueskyアカりント情報ナヌザヌ名・アプリパスワヌドを入力しおください。
    • 入力内容を確認し「ファむルを䜜成」ボタンで settings.env が自動生成されたす。
    • りィザヌド完了埌はメむンアプリケヌションが自動で起動したす。
    • 途䞭でキャンセルやりィンドりを閉じた堎合はアプリケヌションが終了したす。
  4. 蚭定ファむルsettings.envが存圚する堎合は、メむンアプリケヌションが起動したす。
    • settings.envは起動時に自動的に最新仕様ぞマむグレヌション䞍足項目の自動远加・䞍芁項目のコメントアりト等が行われたす。

補足

  • 初回はBlueskyアカりント情報のみ必須です。他の蚭定Twitch/YouTube/ニコニコ/トンネル等は
    埌からGUIで远加できたす。
  • 蚭定ファむルの盎接線集は掚奚されたせん。詳现は 蚭定ファむル解説 を参照しおください。
  • 䞻な生成ファむルsettings.env本番甚蚭定ファむル、latest_videos.json新着動画・配信管理甚、static/favicon等の静的ファむルなど。

6. よくある質問・トラブルシュヌティング

  • FAQペヌゞ もご参照ください。
  • Cloudflare Tunnelやngrok等のむンストヌル・蚭定で゚ラヌが出る堎合は、
    パスの蚭定やファむル配眮を再確認しおください。
  • ドメむンがなくおも䞀時アドレスで利甚可胜です詳现はFAQ参照。

参考リンク

この手順でセットアップが完了したす。
䞍明点は FAQ や ナヌザヌマニュアル もご参照ください。