DockerでLocaltonetを実行する
このページの内容 12セクション
公式イメージlocaltonet/localtonetは、コンテナ内でLocaltonetクライアントを実行します。AuthTokenを渡したら、あとは通常どおりダッシュボードでトンネルを作成して開始します。
始める前に #
- 64ビットのホスト上のDocker。イメージは
linux/amd64とlinux/arm64向けに公開されており、Dockerがホストに合ったものを選びます。32ビットARMデバイスでは、代わりにLinux版を使ってください。 - マイトークンのAuthToken。コンテナごとに専用のトークンを使ってください。同じトークンで2つ目のクライアントが接続すると、最初のクライアントは切断されます。
手順 #
-
イメージをプルする #
先にプルしておくと、ホストに残っている古いイメージではなく、最新バージョンを実行できます。
Bashdocker pull localtonet/localtonetイメージはDocker Hubにあります。
latestのほかに、Docker Hubにはバージョンごとのタグがあり、特定のリリースに固定できます。 -
トークンを指定してコンテナを起動する #
イメージ名の後ろに書いたものはすべて、Localtonetクライアントに渡されます。
<YOUR_TOKEN>は自分のAuthTokenに置き換えてください。Bashdocker run localtonet/localtonet --authtoken <YOUR_TOKEN>コンテナは接続状態を表示し、フォアグラウンドで動作し続けます。停止するにはCtrl + Cを押します。
-
トンネルを作成して開始する #
ダッシュボードを開き、コンテナに渡したトークンでトンネルを作成して、開始を選びます。フォームはクイックスタートで確認できます。コンテナ内では
127.0.0.1の意味が異なるため、ローカルIPアドレスを入力する前に、コンテナからサービスに接続するをお読みください。
コンテナの動作 #
イメージはクライアントをヘッドレスモードで起動します。デスクトップ上のクライアントと比べて、次の3点が変わります。
- 質問を一切しません。トークンがない、または形式が正しくない場合、コンテナはエラーを表示して終了コード2で終了します。
- ライブのステータス表の代わりに、通常のログ行を書き出します。
-itで起動した場合も同様です。 - トークンを保存しません。イメージはボリュームを宣言していないため、コンテナを作成するたびにトークンを渡す必要があります。コマンドライン、環境変数、ファイルのいずれかで渡します。
トンネルはコンテナ内では設定しません。ダッシュボードで作成、開始、停止すると、コンテナが接続を通じてそれを受け取ります。
バックグラウンドで実行し、自動的に再起動する #
-dでデタッチし、再起動ポリシーを指定すると、再起動やクラッシュの後にDockerがコンテナをもう一度起動します。
docker run -d \
--name localtonet \
--restart unless-stopped \
localtonet/localtonet --authtoken <YOUR_TOKEN>通常のDockerコマンドで管理できます。
| コマンド | 動作 |
|---|---|
docker ps | 実行中のコンテナを一覧表示します。 |
docker logs -f localtonet | クライアントのログを追跡して表示します。 |
docker stop localtonet | クライアントを停止します。そのトンネルはオフラインになります。 |
docker start localtonet | 同じトークンでもう一度起動します。 |
docker rm -f localtonet | コンテナを削除します。 |
トークンを渡す方法 #
コマンドラインで渡したトークンは、docker inspectやホストのプロセス一覧で見えてしまいます。イメージは、環境変数やファイルからもトークンを読み取ります。
| 渡し方 | 使い方 | 補足 |
|---|---|---|
--authtoken <YOUR_TOKEN> | イメージ名の後ろの引数。 | 最も簡単です。LOCALTONET_AUTH_TOKENより優先されます。 |
LOCALTONET_AUTH_TOKEN | トークンを保持する環境変数。 | --authtoken引数が指定されていない場合に使われます。 |
LOCALTONET_AUTH_TOKEN_FILE | トークンだけが書かれたファイルの、コンテナ内でのパスを保持する環境変数。 | トークンファイルは、直接渡したトークンより常に優先されます。引数--authtoken-file <PATH>でも同じことができます。 |
イメージ自体がLOCALTONET_HEADLESS=1を設定します。自分で設定する必要はありません。
トークンファイルを使うと、トークンをコンテナの定義に含めずに済みます。読み取り専用でマウントします。
printf '%s' '<YOUR_TOKEN>' > auth-token
chmod 600 auth-token
docker run -d \
--name localtonet \
--restart unless-stopped \
-e LOCALTONET_AUTH_TOKEN_FILE=/run/secrets/localtonet_auth_token \
-v "$(pwd)/auth-token:/run/secrets/localtonet_auth_token:ro" \
localtonet/localtonetコンテナを起動する前に、トークンファイルを作成しておいてください。ファイルが存在しないと、Dockerがその名前のディレクトリを作成してしまい、クライアントはそこからトークンを読み取れません。
接続せずにトークンの渡し方を確認するには、--check-configを追加します。クライアントはトークンがあり、形式が正しいこと(33文字で、スペースなし)を確認し、Localtonet headless configuration OK.と表示して終了します。トークンが有効かどうかをサーバーに問い合わせることはしません。
docker run --rm \
-e LOCALTONET_AUTH_TOKEN_FILE=/run/secrets/localtonet_auth_token \
-v "$(pwd)/auth-token:/run/secrets/localtonet_auth_token:ro" \
localtonet/localtonet --check-configDocker Compose #
同じ構成をComposeファイルで書くと次のようになります。トークンは、compose.yamlと同じ場所にあるauth-tokenという名前のファイルに入れます。
services:
localtonet:
image: localtonet/localtonet
restart: unless-stopped
environment:
LOCALTONET_AUTH_TOKEN_FILE: /run/secrets/localtonet_auth_token
volumes:
- ./auth-token:/run/secrets/localtonet_auth_token:rodocker compose up -d
docker compose logs -f localtonet公開したいサービスがLinuxホスト上の同じComposeプロジェクトにある場合は、そのポートをホストに公開し、Localtonetコンテナをホストネットワークで実行します。トンネルのローカルアドレスにはIPアドレスを指定する必要があるため、webのようなComposeのサービス名は使えません。
services:
web:
image: nginx
ports:
- "8080:80"
localtonet:
image: localtonet/localtonet
restart: unless-stopped
network_mode: host
environment:
LOCALTONET_AUTH_TOKEN_FILE: /run/secrets/localtonet_auth_token
volumes:
- ./auth-token:/run/secrets/localtonet_auth_token:roこの例では、トンネルのローカルアドレスを127.0.0.1、ローカルポートを8080に設定します。
NASやHome Assistant向けのテンプレートは、NASとHome Assistantのページにあります。
コンテナからサービスに接続する #
トンネルのローカルIPアドレスとローカルポートは、サービスの場所をクライアントに伝えます。クライアントはコンテナの内側から接続するため、127.0.0.1はお使いのマシンではなくコンテナ自身を指します。IPアドレスを入力してください。クライアントは、host.docker.internalのようなDockerの名前、Composeのサービス名、コンテナ名を名前解決しません。サービスが動作している場所に合った値を使います。
| サービスの動作場所 | 入力するローカルアドレス | ほかに必要なこと |
|---|---|---|
| Dockerホスト上(Linux) | 127.0.0.1 | --network host(Composeではnetwork_mode: host)でコンテナを起動します。これにより、コンテナがホストのネットワークを共有します。 |
| Dockerホスト上で、ホストネットワークを使わない場合(WindowsまたはmacOS上のDocker Desktopを含む) | ホストのLAN IPアドレス(例:192.168.1.10) | サービスは、127.0.0.1だけでなく、コンテナから到達できるアドレスで待ち受ける必要があります。また、ホストのファイアウォールが接続を許可している必要があります。 |
| 別のコンテナ内 | Linuxで--network hostを使う場合は127.0.0.1、それ以外はホストのLAN IPアドレス | そのコンテナのポートをホストに公開し(-p、Composeではports)、公開したポートをトンネルのローカルポートとして使います。 |
| ネットワーク内の別のデバイス上 | そのデバイスのLAN IPアドレス(例:192.168.1.20) | 特にありません。 |
docker run -d \
--name localtonet \
--restart unless-stopped \
--network host \
localtonet/localtonet --authtoken <YOUR_TOKEN>既存のトンネルのアドレスは、設定のローカルアドレスで変更できます。設定リファレンスをご覧ください。
ログを読む #
docker logs -f localtonetを実行すると、変化があるたびに1行が表示されます。最初の行以外は、すべてタイムスタンプで始まります。
| 行 | 意味 |
|---|---|
Localtonet - headless log | クライアントが起動しました。 |
Connection: … | Localtonetへの接続の状態です。状態が変わると新しい行が表示されます。 |
AuthTokenName: … | コンテナがサインインしたトークンの名前です。マイトークンに表示される名前と同じです。 |
OPEN …, ADDED … | このトークンのトンネルです。クライアントの起動時にすでに存在するトンネルにはOPEN、後から追加されたトンネルにはADDEDが使われます。 |
STATUS … | トンネルのステータスが変わりました。 |
CLOSED … | トンネルがこのクライアントから削除されました。 |
Authentication failed: AuthToken was rejected. | Localtonetがトークンを受け付けませんでした。 |
トークン自体がログに書き込まれることはありません。
更新 #
イメージをもう一度プルして、コンテナを再作成します。
docker pull localtonet/localtonet
docker rm -f localtonet
docker run -d --name localtonet --restart unless-stopped localtonet/localtonet --authtoken <YOUR_TOKEN>Composeでは、docker compose pullを実行してからdocker compose up -dを実行します。常に最新のイメージから起動するには、docker runに--pull alwaysを追加します。
レジストリにアクセスできないホスト向けのイメージアーカイブ #
ホストからDocker Hubに接続できない場合は、別のマシンでイメージをTARアーカイブとしてダウンロードし、コピーしてから読み込みます。
| アーキテクチャ | アーカイブ |
|---|---|
| AMD64 | localtonet-docker-amd64.tar |
| ARM64 | localtonet-docker-arm64.tar |
docker load --input localtonet-docker-amd64.tardocker loadは、読み込んだ内容を表示します。名前ではなくイメージIDが表示された場合は、実行する前にイメージに名前を付けてください。
docker tag <IMAGE_ID> localtonet/localtonet
docker run -d --name localtonet --restart unless-stopped localtonet/localtonet --authtoken <YOUR_TOKEN>トラブルシューティング #
コンテナがすぐに終了し、「Invalid Localtonet headless configuration」と表示される
メッセージの全文はInvalid Localtonet headless configuration. Check the token file or environment settings.です。クライアントが使えるトークンを見つけられませんでした。何も渡されていない、値が33文字ではない、途中にスペースや改行が含まれている、またはトークンファイルのパスがコンテナ内に存在しない、のいずれかです。トークンファイルをマウントしている場合は、それがディレクトリではなくファイルであることをホスト上で確認してください。再起動ポリシーを設定していると、トークンを修正するまでコンテナは再起動を繰り返すため、docker logs localtonetを確認してください。
ログに「Authentication failed: AuthToken was rejected.」と表示される
トークンの形式は正しいものの、Localtonetが受け付けていません。マイトークンからもう一度コピーして、コンテナを再作成してください。
トンネルは開始されているが、公開アドレスからサービスに届かない
トンネルのローカルアドレスを確認してください。127.0.0.1が使えるのは、Linuxで--network hostを使う場合だけです。それ以外の場合は、ホストのLAN IPアドレスを使います。host.docker.internalのような名前や、別のコンテナの名前は、このフィールドでは使えません。詳しくはコンテナからサービスに接続するをご覧ください。
コンテナの接続が何度も切れる
同じトークンを使っているクライアントがほかにないことを確認してください。同じトークンで2つ目のクライアントが接続すると、最初のクライアントは切断されます。マイトークンで、コンテナまたはデバイスごとに1つずつトークンを作成してください。