NAS と Home Assistant で Localtonet を実行する
セットアップテンプレート AMD64 と ARM64
このページの内容 7セクション
- テンプレートの内容
- テンプレートに含まれないもの
- 始める前に
- Docker Compose で NAS をセットアップする
- ZIP を展開して nas フォルダーを NAS にコピーする
- トークンファイルを作成する
- compose.yaml はそのままにする
- プロジェクトを開始する
- トンネルを作成して開始する
- Compose テンプレートの内容
- Home Assistant OS または Supervised をセットアップする
- アプリフォルダーをコピーする
- アプリストアを再読み込みして Localtonet をインストールする
- トークンを入力してアプリを開始する
- トンネルを作成して開始する
- サービスに接続する
- ログと更新
- 関連ページ
Localtonet では、Docker に対応した NAS と Home Assistant で、Localtonet クライアントをコンテナーとして実行するためのデプロイテンプレートを提供しています。AuthToken を追加してコンテナーを起動し、その後はダッシュボードでトンネルを管理します。
テンプレートの内容 #
ダウンロードできるのは小さな ZIP アーカイブで、2 つのテンプレート、合計 5 つのファイルが入っています。
| テンプレート | 使用先 | ファイル | 変更する箇所 |
|---|---|---|---|
NAS / Docker Compose(フォルダー nas) | Synology Container Manager、QNAP Container Station、Docker が動くその他の NAS、Home Assistant Container または Core のホスト | nas/compose.yaml と nas/auth-token.example | トークンだけです。auth-token.example を auth-token にコピーし、DUMMY_AUTH_TOKEN をご自身の AuthToken に置き換えます。compose.yaml はそのままにしてください。 |
Home Assistant アプリ(フォルダー home-assistant) | Home Assistant OS と Home Assistant Supervised | home-assistant/localtonet/config.json(ローカルアプリ、以前の名称はアドオンの定義)と home-assistant/repository.json | ファイルの変更は不要です。アプリをインストールした後、Home Assistant でトークンを入力します。ローカルインストールでは repository.json は使いません。 |
5 つ目のファイル README.txt は、このページの手順を短くまとめたテキスト版です。
どちらのテンプレートも、Docker のページで説明しているとおり、プロンプトなしで Localtonet クライアントをコンテナー内で実行します。AMD64(Intel および AMD プロセッサー)と ARM64 向けです。始める前に NAS のプロセッサーを確認してください。32 ビット ARM の NAS では実行できません。
テンプレートに含まれないもの #
- Synology SPK や QNAP QPKG のパッケージではありません。Synology のパッケージセンターにも QNAP の App Center にも表示されません。
- Home Assistant のテンプレートは、公式の Home Assistant ストアに掲載されているものではありません。ローカルアプリとしてインストールします。
- コンテナーイメージは含まれていません。お使いのデバイスが、テンプレートに記載されたイメージ
docker.io/localtonet/localtonetを取得します。これは Docker Hub にある Docker ページのイメージです。 - VPN インターフェースに必要な権限は、コンテナーに付与されません。テンプレートはトンネル用で、VPN 機能は含まれていません。
始める前に #
- Docker と Docker Compose に対応した NAS、または Home Assistant OS / Supervised。
- マイトークンの AuthToken。他のデバイスで使っていないトークンを使ってください。同じトークンで 2 つ目のクライアントが接続すると、1 つ目は切断されます。
- テンプレートの ZIP。ダウンロードは、このページの末尾の一覧とダウンロードページにあります。
Docker Compose で NAS をセットアップする #
-
ZIP を展開して nas フォルダーを NAS にコピーする #
お使いのコンピューターでアーカイブを展開します。
nasフォルダーを、コンテナーマネージャーが使える NAS の共有フォルダーにコピーします。 -
トークンファイルを作成する #
nasフォルダー内で、auth-token.exampleをauth-tokenにコピーします。auth-tokenを開き、DUMMY_AUTH_TOKENをご自身の AuthToken に置き換えます。ファイルには 1 行だけを書き、他の内容は入れないでください。トークンファイルは他人に見せないでください。NAS 上の自分のアカウントだけがアクセスできるようにし、他の人が読める共有フォルダーや同期フォルダーには置かないでください。トークンがあれば、Localtonet クライアントがこのデバイスとして接続できてしまいます。
ファイルはコンテナーを起動する前に存在している必要があります。ない場合、Docker は代わりに
auth-tokenという名前のディレクトリを作成し、コンテナーはそこからトークンを読み取れません。 -
compose.yaml はそのままにする #
compose.yamlを編集する必要はありません。image:の行には、Localtonet のイメージと、この ZIP が作成されたバージョンが記載されています(例:docker.io/localtonet/localtonet:8.6.0)。その他の行については、Compose テンプレートの内容で説明します。 -
プロジェクトを開始する #
compose.yamlをコンテナーマネージャーのプロジェクトとしてインポートし、開始します。- Synology: Container Manager で、
nasフォルダーとそのcompose.yamlからプロジェクトを作成します。 - QNAP: Container Station で、
compose.yamlからアプリケーションを作成します。このファイルは Compose ファイルからの相対パスで./auth-tokenをマウントするため、そのパスでトークンファイルに到達できる必要があります。 - シェルを使える Docker ホスト:
nasディレクトリから、下のコマンドを実行します。
Bashdocker compose up -d画面の詳細は NAS のモデルやバージョンによって異なります。Compose ファイルからプロジェクトを作成する方法は、各ベンダーのドキュメントに従ってください。
- Synology: Container Manager で、
-
トンネルを作成して開始する #
コンテナーが動いたら、ダッシュボードを開き、ファイルに入れたトークンでトンネルを作成して開始を選びます。手順はクイックスタートと同じです。
Compose テンプレートの内容 #
これがファイルのすべてです。image: の行の末尾のタグは、ZIP が作成された Localtonet のバージョンです。8.6.0 は一例です。
services:
localtonet:
image: "docker.io/localtonet/localtonet:8.6.0"
restart: unless-stopped
network_mode: host
environment:
LOCALTONET_HEADLESS: "1"
LOCALTONET_AUTH_TOKEN_FILE: /run/secrets/localtonet_auth_token
volumes:
- ./auth-token:/run/secrets/localtonet_auth_token:ro| 設定 | 動作 |
|---|---|
image | Localtonet のイメージ docker.io/localtonet/localtonet と、実行するバージョン。タグは別のバージョンに移行するときだけ変更してください。ログと更新をご覧ください。 |
restart: unless-stopped | 再起動やクラッシュの後、自分で停止していない限り、Docker がコンテナーを再び起動します。 |
network_mode: host | コンテナーは NAS のネットワークを共有します。そのため、トンネルは NAS 自身のサービスに 127.0.0.1 で、LAN 内の他のデバイスにその LAN アドレスで到達できます。Linux のホストネットワークが必要です。 |
LOCALTONET_HEADLESS | プロンプトなしで、シンプルなログ行を出力してクライアントを実行します。 |
LOCALTONET_AUTH_TOKEN_FILE | クライアントがトークンを読み取るファイルの、コンテナー内でのパス。 |
volumes | auth-token ファイルを、そのパスに読み取り専用でマウントします。 |
Home Assistant OS または Supervised をセットアップする #
Home Assistant OS と Supervised では、Supervisor を通してアプリを実行します。このテンプレートは、デバイスにコピーするローカルアプリです。
-
アプリフォルダーをコピーする #
ZIP を展開します。フォルダー
home-assistant/localtonetを、Home Assistant のローカルアプリのディレクトリにコピーし、/addons/localtonetとなるようにします。このフォルダーにはconfig.jsonというファイルが 1 つ入っています。編集しないでください。このファイルには、アプリ名 Localtonet、イメージdocker.io/localtonet/localtonet、この ZIP が作成されたバージョンが記載されており、authtokenオプションは後で入力できるよう空になっています。 -
アプリストアを再読み込みして Localtonet をインストールする #
Home Assistant でアプリストアを再読み込みしてローカルアプリを認識させ、Localtonet をインストールします。
-
トークンを入力してアプリを開始する #
アプリの Configuration ページを開き、
authtokenオプションに AuthToken を入力して、アプリを開始します。Home Assistant は、この値をパスワードのように隠して表示します。以降、アプリは Home Assistant とともに自動的に起動します。 -
トンネルを作成して開始する #
ダッシュボードでそのトークンのトンネルを作成し、開始を選びます。Home Assistant 自体を公開するには、
127.0.0.1と Home Assistant が待ち受けるポートへの HTTP トンネルを作成します。Home Assistant のデフォルトポートは8123です。Home Assistant には、プロキシ経由で届くリクエストに関する独自の設定があります。拒否される場合は、Home Assistant HTTP のドキュメントをご覧ください。
このアプリはホストネットワークを使うため、Home Assistant やネットワーク内の他のデバイスに直接到達できます。対応する Home Assistant のアーキテクチャは amd64 と aarch64 です。
Home Assistant Container と Core には Supervisor がないため、アプリをインストールできません。これらの環境では、Docker ホスト上で NAS / Docker Compose テンプレートを使ってください。
ファイル home-assistant/repository.json は、コピーするフォルダーの外にあり、ローカルインストールには含まれません。リポジトリ URL とメンテナーのプレースホルダー値(DUMMY)が入っていますが、無視してください。
サービスに接続する #
どちらのテンプレートもホストネットワークを使います。トンネルのローカルIPアドレス欄では、次のようにします。
127.0.0.1は NAS または Home Assistant のホスト自身です。NAS の Web インターフェース、Home Assistant、そのデバイス上の他のサービスに、そのサービスが待ち受けるポートで接続するときに使います。192.168.1.20のような LAN アドレスは、ネットワーク内の別のデバイスに到達します。
開始したトンネルは、インターネットから到達できます。NAS のログインページや Home Assistant を公開する前に、サービス自体で強力なパスワードと二要素認証を設定し、アクセス制御のページにあるオプションも検討してください。
ログと更新 #
コンテナーはシンプルなログ行を出力します。接続状態、サインインに使ったトークンの名前、トンネルが追加された、ステータスが変わった、削除されたときの行です。コンテナーマネージャーのログ表示、Home Assistant のアプリの Log タブ、または次のコマンドで確認できます。
docker compose logs -f localtonetInvalid Localtonet headless configuration. Check the token file or environment settings. という行は、クライアントが使用可能なトークンを見つけられなかったことを意味します。トークンファイルがない、または空である、まだ DUMMY_AUTH_TOKEN のままである、あるいはトークンが 33 文字ではない場合です。Authentication failed: AuthToken was rejected. は、トークンの形式は正しいものの、Localtonet に受け入れられなかったことを意味します。
テンプレートの ZIP は、それぞれ 1 つの Localtonet バージョン用に作られています。Compose ファイルでは image: 行のタグで、Home Assistant アプリでは config.json の version フィールドでバージョンが固定されています。NAS を新しいバージョンに移行するには、タグを Docker Hub に掲載されているイメージのバージョン(Docker をご覧ください)に変更し、docker compose up -d をもう一度実行します(またはコンテナーマネージャーでプロジェクトを更新します)。auth-token ファイルはそのままで構いません。
関連ページ #
NASとHome Assistant
Synology Container Manager、QNAP Container Station、その他のDocker対応NASデバイス向けのDocker Composeテンプレートと、OS / Supervised向けのHome Assistantアプリテンプレート。AMD64およびARM64に対応。
これらはセットアップテンプレートであり、SPK / QPKGインストーラーや公式のHome Assistantストア掲載ではありません。対応するDockerイメージがレジストリで利用可能である必要があります。Home Assistant Container / CoreのユーザーはComposeテンプレートを使用できます。
NASまたはHome Assistantをセットアップ
- ZIPを展開し、
README.txtを読みます。 - NASの場合は、
nas/auth-token.exampleをnas/auth-tokenにコピーし、AuthTokenを入力します。このファイルは非公開にしてください。 nas/compose.yamlのイメージタグを確認し、プロジェクトとしてインポートするか、nasディレクトリでdocker compose up -dを実行します。- Home Assistant OS / Supervisedの場合は、READMEにあるローカルアプリのインストール手順に従い、アプリの設定でトークンを入力します。
テンプレートはLANアクセスにLinuxのホストネットワークを使用します。VPN権限は有効にしません。