Localtonetをサービスとして実行する
このページの内容 8セクション
Localtonet クライアントをバックグラウンドサービスとしてインストールすると、デバイスとともに起動し、ログアウト後も動き続け、ターミナルを開いておく必要がなくなります。1 つのコマンドで、Windows のサービス、macOS の launchd、Linux の systemd に登録されます。
始める前に #
- コンソールクライアントがデバイスにインストールされていること: Windows、macOS、Linux。
- マイトークンで取得した、このデバイス用の AuthToken。
- 管理者権限。Windows では管理者として実行で開いたターミナル、macOS と Linux では
sudoです。 - Linux では、systemd を使うディストリビューション。Termux には対応していません。Termux ではAndroidアプリを使ってください。
DEB や RPM パッケージ、OpenWrt、Docker でインストールした場合は?これらには、起動時に開始するための独自の方法があります。このページではなく、DEB と RPM パッケージ、OpenWrt、Dockerをご覧ください。
サービスをインストールする #
--install-service とトークンを指定して、クライアントを 1 回実行します。<YOUR_TOKEN> をご自身の AuthToken に置き換えてください。このコマンドでは必ず --authtoken を指定してください。サービスは、インストール時に指定したトークンで接続します。
Windows #
localtonet があるフォルダーで、コマンド プロンプトまたは PowerShell を管理者として開き、次を実行します。
localtonet --install-service --authtoken <YOUR_TOKEN>クライアントが自動開始の Windows サービスを作成し、開始します。サービスは services.msc で、説明 Localtonet Service として表示されます。サービスが失敗した場合、Windows が 1 分後に再起動します。
macOS
sudo localtonet --install-service --authtoken <YOUR_TOKEN>クライアントが /Library/LaunchDaemons/<SERVICE_NAME>.plist に launchd のジョブを書き込み、読み込んで開始します。ジョブは起動時に開始し、エラーで終了した場合は launchd が再び起動します。
Linux
sudo localtonet --install-service --authtoken <YOUR_TOKEN>クライアントが /etc/systemd/system/<SERVICE_NAME>.service に systemd ユニットを書き込み、有効にして開始します。ユニットは起動時に開始し、失敗した場合は systemd が 5 秒後に再起動します。
sudo が localtonet を見つけられない場合は、パスを指定して実行してください。たとえば、そのファイルがあるフォルダーで sudo ./localtonet を実行します。
成功すると、クライアントはサービスの名前を出力します。
[CLI] Installed service 'Localtonet_AbCdEfGhI'インストールするとサービスも開始されるため、別途開始コマンドは不要です。これで、ダッシュボードでこのトークンのトンネルを作成して開始できます。
サービス名 #
サービス名は、Localtonet_ の後にトークンの最初の 9 文字が続く形式です。たとえば Localtonet_AbCdEfGhI です。このページではこれを <SERVICE_NAME> と表記します。名前はトークンから決まるため、同じデバイスにトークンごとに 1 つずつサービスをインストールできます。また、管理コマンドはすべて、サービスを見つけるために同じトークンが必要です。
サービスが実行するもの #
サービスは、インストールコマンドで指定したオプションを付けて、同じ場所にある同じ localtonet ファイルを起動します。そのため、次の 2 点に注意してください。
- ファイルを移動したり削除したりしないでください。サービスの定義にはファイルのフルパスが含まれています。Linux では、ファイルが
/rootの中にある場合、インストーラーがそれを/usr/local/lib/<SERVICE_NAME>/にコピーし、サービスはそのコピーを実行します。 - その他のオプションは保持されます。インストールコマンドに付けた
--netと--ipや--proxy envなどのオプションはサービスに保存され、起動のたびに使われます。CLIリファレンスをご覧ください。
サービスを管理する #
同じトークンを指定して、次のいずれかのオプションを使います。macOS と Linux では、先頭に sudo を付けます。Windows では、状態の確認以外はすべて管理者のターミナルで行います。
| コマンド | 動作 | 成功時の出力 |
|---|---|---|
localtonet --status-service --authtoken <YOUR_TOKEN> | サービスの状態を表示します。 | [CLI] Service '<SERVICE_NAME>' status: Running |
localtonet --stop-service --authtoken <YOUR_TOKEN> | サービスを停止します。トンネルはオフラインになります。次回の起動時に再び開始されます。 | [CLI] Stopped service '<SERVICE_NAME>'. |
localtonet --start-service --authtoken <YOUR_TOKEN> | 停止中のサービスを開始します。 | [CLI] Started service '<SERVICE_NAME>'. |
localtonet --remove-service --authtoken <YOUR_TOKEN> | サービスを停止し、登録を削除します。localtonet ファイル自体は残ります。 | [CLI] Removed service '<SERVICE_NAME>'. |
状態は、次のいずれかの値です。
| 状態 | 意味 |
|---|---|
Running | サービスは実行中です。 |
Stopped | サービスはインストールされていますが、実行されていません。 |
Installing | サービスを開始しています。 |
NotFound | このトークンのサービスはインストールされていません。 |
Paused | Windows のみ: サービスが一時停止されました。 |
Error | サービスが失敗したか、状態を読み取れませんでした。 |
Unknown | サービスマネージャーが、クライアントが認識できない状態を返しました。 |
サービス名を指定して、オペレーティングシステムのツールを使うこともできます。
Windows #
services.msc を開いて <SERVICE_NAME> を探すか、管理者のターミナルで sc を使います。
sc query <SERVICE_NAME>
sc stop <SERVICE_NAME>
sc start <SERVICE_NAME>macOS
sudo launchctl print system/<SERVICE_NAME>Linux
systemctl status <SERVICE_NAME>
sudo systemctl restart <SERVICE_NAME>サービスの登録先とログの場所 #
| システム | 登録先 | ログ |
|---|---|---|
| Windows | <SERVICE_NAME> という名前の Windows サービス。スタートアップの種類は自動で、LocalSystem アカウントで実行されます。 | サービスにはコンソールウィンドウがなく、インストーラーはログファイルを設定しません。サービスの状態と、ダッシュボードでデバイスとそのトンネルを確認してください。 |
| macOS | /Library/LaunchDaemons/<SERVICE_NAME>.plist。システム全体の launchd ジョブです。 | /var/log/<SERVICE_NAME>.out.log と /var/log/<SERVICE_NAME>.err.log |
| Linux | /etc/systemd/system/<SERVICE_NAME>.service。multi-user.target に対して有効です。 | systemd ジャーナル: journalctl -u <SERVICE_NAME> -f |
サービスは、ターミナルでクライアントが表示するトンネルの表を出力しません。デバイスとそのトンネルの状態は、ダッシュボードで確認してください。
トークンを変更する #
デバイスのトークンを変更するには、古いトークンでサービスを削除し、新しいトークンでもう一度インストールします。
sudo localtonet --remove-service --authtoken <OLD_TOKEN>
sudo localtonet --install-service --authtoken <NEW_TOKEN>知っておくべきこと #
- トークン 1 つにつきクライアントは 1 つ。サービスの実行中は、このデバイスでも別のデバイスでも、同じトークンで別の Localtonet クライアントを起動しないでください。同じトークンで 2 つ目のクライアントが接続すると、1 つ目は切断されます。
- クライアントの更新。サービスは、定義が指しているファイルを実行し続けます。サービスを停止し、そのファイルを新しいバージョンに置き換えて、サービスをもう一度開始してください。
- プロキシのパスワードは保存されません。インストールコマンドは、パスワードを含むプロキシ URL と
--proxy-userオプションを受け付けません。--proxy envでインストールし、サービスの環境にプロキシの変数を設定してください。 - デバイスターミナル。デバイスで Localtonet をサービスとして実行している場合は、サービスがその結果を使えるように、管理者のターミナルから、または
sudoを付けてlocaltonet --terminal enableを実行してください。デバイスターミナルをご覧ください。
トラブルシューティング #
| メッセージ | 原因と対処 |
|---|---|
[CLI] Install failed: '…' requires elevated (admin/root) privileges. | コマンドが管理者権限なしで実行されました。Windows ではターミナルを管理者として開き、macOS と Linux では sudo を使ってください。Windows と Linux では、開始、停止、削除でも同じメッセージが表示されます。 |
[CLI] Install failed: に続いて Service '<SERVICE_NAME>' already exists.(Windows)、Systemd unit already exists for …(Linux)、または Plist already exists for …(macOS) | このトークンのサービスはすでにインストールされています。--start-service で開始するか、もう一度インストールしたい場合は、先に --remove-service を実行してください。 |
Service installation cannot persist proxy passwords. Use --proxy env and supply credentials in the service's runtime environment. | インストールコマンドに --proxy-user またはパスワード付きのプロキシ URL が含まれていました。代わりに --proxy env を使ってください。 |
Windows でインストール直後に [CLI] Start failed: … | インストールするとサービスが開始されるため、サービスはすでに実行中です。--status-service で確認してください。 |
状態が NotFound | 指定したトークンのサービスが存在しません。サービスをインストールしたときのトークンであることを確認してください。 |
状態は Running なのに、ダッシュボードでデバイスがオフライン | トークンを確認してください。マイトークンからもう一度コピーし、サービスを削除して、もう一度インストールします。また、同じトークンを使っている他のクライアントがないことも確認してください。 |