インストールから起動、Windows サービスとしての常駐運用まで。所要は 5 分ほどです。
ダッシュボードで canal を作成し、canal 詳細の「セットアップ」タブから接続ファイル wirecanal.json をダウンロードします(スクリーンショットつきの手順は ① canal を作成する)。 このファイルにはその canal 用の接続キーが入っています。
エージェントを置きたいフォルダ(例 C:\wirecanal)で PowerShell を開き、次の 1 行を実行します。 そのフォルダに wirecanal.exe が配置され、バージョン表示まで自動で確認されます。
irm https://download.wirecanal.com/install.ps1 | iexダウンロードした wirecanal.json を wirecanal.exe と同じフォルダに置いて、起動します。
.\wirecanal.exe -config wirecanal.json起動ログに「canal <ID>: https://<ホスト名> へのアクセスをローカルの転送先 <転送先> に届けます」と出れば開通です。 ダッシュボードの canal 詳細でも「接続されました!」に切り替わります。
上の起動方法は、ターミナルを閉じたりログオフしたりすると止まります。 サーバーとして常駐させるなら、Windows のサービスとして登録します(エージェント v0.16.0 以降)。 管理者として開いた PowerShell で、エージェントのフォルダから 1 回だけ実行してください。
.\wirecanal.exe service install -config wirecanal.json.\wirecanal.exe service status、停止・開始は service stop / service start。.\wirecanal.exe service uninstall(停止して登録を解除)。wirecanal.json と同じフォルダの .wirecanal-state\wirecanal-service.log に書き出されます。以前からタスクスケジューラに wirecanal.exe を直接登録して常駐させている場合、タスクの既定設定「タスクを停止するまでの時間: 3 日間」により、起動から 72 時間でエージェントが終了し、次の起動トリガーまで復帰しません。 上のサービス登録への乗り換えをおすすめします(実行時間の制限がなく、止まっても約 5 秒で自動再起動します)。 タスクスケジューラを使い続ける場合は、タスクのプロパティでこの設定を必ず「なし」に変更してください。
エージェントは新しい版が出ると自動で入れ替わります(配布物の署名を検証してから適用・更新に失敗しても直前の版へ自動で戻ります)。 止めたい場合だけ wirecanal.json に "auto_update": false を書いてください。
wirecanal.json に "proxy_url": "http://proxy.example.co.jp:8080" のように 1 行足すだけで、外向きの接続がそのプロキシを経由します (環境変数のプロキシ設定は参照しません=設定した値だけで動く、予測しやすい挙動です)。
表示を英語にしたいときは wirecanal.json に "lang": "en" を 1 行足します。 うまくつながらないときは -verbose を付けて起動すると詳しい記録が出ます。接続キーの失効・再発行はダッシュボードからいつでもできます。これらを含む全オプション(複数 canal・タイムアウト・操作記録など)の解説は wirecanal.json 設定リファレンス にまとめています。