Запуск Localtonet на NAS и в Home Assistant
Шаблоны настройки AMD64 и ARM64
На этой странице 7 разделов
- Что это за шаблоны
- Чем они не являются
- Перед началом
- Настройка NAS с Docker Compose
- Распакуйте ZIP и скопируйте папку nas на NAS
- Создайте файл токена
- Оставьте compose.yaml как есть
- Запустите проект
- Создайте и запустите туннель
- Что делает шаблон Compose
- Настройка Home Assistant OS или Supervised
- Скопируйте папку приложения
- Обновите магазин приложений и установите Localtonet
- Введите токен и запустите приложение
- Создайте и запустите туннель
- Доступ к вашим сервисам
- Журналы и обновления
- Связанные страницы
Localtonet предоставляет шаблоны развёртывания, которые запускают клиент Localtonet как контейнер на NAS с поддержкой Docker и в Home Assistant. Вы добавляете свой AuthToken, запускаете контейнер, а затем управляете туннелями в панели управления.
Что это за шаблоны #
Загрузка — это небольшой ZIP-архив с двумя шаблонами, всего пять файлов:
| Шаблон | Где использовать | Файлы | Что нужно изменить |
|---|---|---|---|
NAS / Docker Compose (папка nas) | Synology Container Manager, QNAP Container Station, любой другой NAS с Docker, а также хосты 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. |
Пятый файл, README.txt, — краткая текстовая версия шагов с этой страницы.
Оба шаблона запускают клиент Localtonet в контейнере без запросов, так, как описано на странице Docker. Они рассчитаны на AMD64 (процессоры Intel и AMD) и ARM64. Перед началом проверьте, какой процессор в вашем NAS: на 32-разрядном ARM он работать не будет.
Чем они не являются #
- Это не пакеты Synology SPK и не пакеты QNAP QPKG. В Центре пакетов Synology и в QNAP App Center ничего не появляется.
- Шаблон Home Assistant не является записью в официальном магазине Home Assistant. Вы устанавливаете его как локальное приложение.
- Они не содержат образ контейнера. Ваше устройство загружает образ, указанный в шаблонах, —
docker.io/localtonet/localtonet, то есть образ со страницы Docker на Docker Hub. - Они не дают контейнеру привилегий, которые нужны интерфейсу VPN. Шаблоны предназначены для туннелей; функция VPN в них не входит.
Перед началом #
- NAS с поддержкой Docker и Docker Compose либо Home Assistant OS / Supervised.
- AuthToken из раздела Мои токены. Используйте токен, которым не пользуется никакое другое устройство: когда второй клиент подключается с тем же токеном, первый отключается.
- ZIP-архив с шаблонами. Загрузка есть в списке в конце этой страницы и на странице Загрузки.
Настройка NAS с Docker Compose #
-
Распакуйте ZIP и скопируйте папку nas на NAS #
Распакуйте архив на компьютере. Скопируйте папку
nasв общую папку на NAS, доступную вашему менеджеру контейнеров. -
Создайте файл токена #
В папке
nasскопируйтеauth-token.exampleвauth-token. Откройтеauth-tokenи заменитеDUMMY_AUTH_TOKENсвоим AuthToken в одной строке, без чего-либо ещё в файле.Храните файл токена в тайне. Ограничьте доступ к нему своей учётной записью на 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. Файл монтирует./auth-tokenотносительно файла Compose, поэтому файл токена должен быть доступен по этому пути. - Любой хост Docker с оболочкой: выполните приведённую ниже команду из каталога
nas.
Bashdocker compose up -dТочный вид экранов зависит от модели и версии NAS. Как создать проект из файла Compose, смотрите в документации производителя.
- Synology: в Container Manager создайте проект из папки
-
Создайте и запустите туннель #
Когда контейнер запущен, откройте панель управления, создайте туннель с токеном, который вы поместили в файл, и нажмите Запустить, как в Быстром старте.
Что делает шаблон Compose #
Это весь файл целиком. Тег в конце строки image: — версия Localtonet, для которой создан ваш ZIP; 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, а к другим устройствам в вашей локальной сети — по их адресам в ней. Для этого нужна сетевая модель host в 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. Не редактируйте его: в нём указаны приложение Localtonet, образdocker.io/localtonet/localtonetи версия, для которой создан этот ZIP, а параметрauthtokenоставлен пустым, чтобы вы заполнили его позже. -
Обновите магазин приложений и установите Localtonet #
Обновите магазин приложений в Home Assistant, чтобы он нашёл локальное приложение, затем установите Localtonet.
-
Введите токен и запустите приложение #
Откройте страницу Configuration приложения, введите свой AuthToken в параметр
authtokenи запустите приложение. Home Assistant скрывает значение, как пароль. Дальше приложение запускается автоматически вместе с Home Assistant. -
Создайте и запустите туннель #
Создайте в панели управления туннель с этим токеном и нажмите Запустить. Чтобы опубликовать сам Home Assistant, создайте HTTP-туннель на
127.0.0.1и порт, который слушает ваш Home Assistant. Порт Home Assistant по умолчанию —8123. У Home Assistant есть собственные настройки для запросов, приходящих через прокси; если он их отклоняет, см. документацию Home Assistant по HTTP.
Приложение использует сеть хоста, поэтому напрямую обращается к Home Assistant и другим устройствам вашей сети. Оно поддерживает архитектуры Home Assistant amd64 и aarch64.
В Home Assistant Container и Core нет Supervisor, поэтому приложения на них установить нельзя. В таких установках используйте шаблон NAS / Docker Compose на хосте Docker.
Файл home-assistant/repository.json находится вне копируемой папки и не входит в локальную установку. В нём стоят значения-заглушки (DUMMY) для URL репозитория и сопровождающего; игнорируйте его.
Доступ к вашим сервисам #
Оба шаблона используют сеть хоста. В поле Локальный IP-адрес туннеля:
127.0.0.1— это сам NAS или хост Home Assistant. Используйте его для веб-интерфейса NAS, Home Assistant или любого другого сервиса на этом устройстве, с портом, который слушает сервис.- Адрес в локальной сети, например
192.168.1.20, ведёт к другому устройству вашей сети.
Запущенный туннель доступен из интернета. Прежде чем публиковать страницу входа NAS или Home Assistant, используйте на самом сервисе надёжные пароли и двухфакторный вход и рассмотрите варианты на странице Контроль доступа.
Журналы и обновления #
Контейнер пишет простые строки журнала: состояние подключения, имя токена, с которым выполнен вход, и строку при каждом добавлении, смене статуса или удалении туннеля. Читайте их в просмотре журнала вашего менеджера контейнеров, на вкладке Log приложения в Home Assistant или командой:
docker compose logs -f localtonetСтрока Invalid Localtonet headless configuration. Check the token file or environment settings. означает, что клиент не нашёл пригодного токена: файл токена отсутствует или пуст, всё ещё содержит DUMMY_AUTH_TOKEN либо токен не состоит из 33 символов. Authentication failed: AuthToken was rejected. означает, что токен имеет правильный формат, но Localtonet его не принимает.
Каждый ZIP с шаблонами создан для одной версии Localtonet: Compose-файл фиксирует её в теге строки image:, приложение Home Assistant — в поле version файла config.json. Чтобы перевести NAS на более новую версию, замените тег версией, которую Docker Hub показывает для образа (см. Docker), и снова выполните docker compose up -d (или обновите проект в менеджере контейнеров). Ваш файл auth-token остаётся прежним.
Связанные страницы #
NAS и Home Assistant
Шаблоны Docker Compose для Synology Container Manager, QNAP Container Station и других NAS с поддержкой Docker, а также шаблон приложения Home Assistant для OS / Supervised. 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, затем импортируйте файл как проект или выполнитеdocker compose up -dв папкеnas. - Для Home Assistant OS / Supervised следуйте инструкции по установке локального приложения из README и укажите токен в настройках приложения.
Шаблоны используют сетевой режим host в Linux для доступа к локальной сети. Привилегии для VPN они не включают.