Перейти до вмісту
Localtonet Localtonet Панель керування

Запуск Localtonet на NAS або в Home Assistant

Шаблони налаштування AMD64 і ARM64

Допомога зі сторінкою
На цій сторінці 7 розділів
  1. Що це за шаблони
  2. Чим вони не є
  3. Перш ніж почати
  4. Налаштування NAS через Docker Compose
  5. Розпакуйте ZIP і скопіюйте папку nas на NAS
  6. Створіть файл токена
  7. Залиште compose.yaml без змін
  8. Запустіть проєкт
  9. Створіть і запустіть тунель
  10. Що робить шаблон Compose
  11. Налаштування Home Assistant OS або Supervised
  12. Скопіюйте папку застосунку
  13. Перезавантажте магазин застосунків і встановіть Localtonet
  14. Введіть токен і запустіть застосунок
  15. Створіть і запустіть тунель
  16. Доступ до ваших сервісів
  17. Журнали та оновлення
  18. Пов’язані сторінки

Localtonet надає шаблони розгортання, які запускають клієнт Localtonet як контейнер на NAS із підтримкою Docker і в Home Assistant. Ви додаєте свій AuthToken, запускаєте контейнер, а потім керуєте тунелями на панелі керування.

Що це за шаблони #

Завантаження — це невеликий ZIP-архів із двома шаблонами, разом п'ять файлів:

ШаблонДе використовуватиФайлиЩо змінити
NAS / Docker Compose (папка nas)Synology Container Manager, QNAP Container Station, будь-який інший NAS із Docker, а також хости Home Assistant Container або Corenas/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 Supervisedhome-assistant/localtonet/config.json, опис локального застосунку (раніше — додатка, add-on), і home-assistant/repository.jsonУ файлах нічого. Токен ви вводите в Home Assistant після встановлення застосунку. Локальне встановлення не використовує repository.json.

П'ятий файл, README.txt, — це коротка текстова версія кроків із цієї сторінки.

Обидва шаблони запускають клієнт Localtonet у контейнері без запитів, як описано на сторінці Docker. Вони розраховані на AMD64 (процесори Intel і AMD) та ARM64. Перед початком перевірте, який процесор у вашому NAS: 32-бітний ARM NAS їх запустити не може.

Чим вони не є #

  • Це не пакети Synology SPK і не пакети QNAP QPKG. У Synology Package Center і 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 #

  1. Розпакуйте ZIP і скопіюйте папку nas на NAS #

    Розпакуйте архів на своєму комп'ютері. Скопіюйте папку nas у спільну папку на NAS, яку може використовувати ваш менеджер контейнерів.

  2. Створіть файл токена #

    У папці nas скопіюйте auth-token.example у auth-token. Відкрийте auth-token і замініть DUMMY_AUTH_TOKEN своїм AuthToken в одному рядку, без будь-чого іншого у файлі.

    Тримайте файл токена в таємниці. Обмежте доступ до нього лише власним обліковим записом на NAS і не кладіть його в спільну чи синхронізовану папку, яку можуть читати інші люди. Токен дає змогу клієнту Localtonet підключатися як цей пристрій.

    Файл має існувати до запуску контейнера. Якщо його немає, Docker замість нього створить каталог із назвою auth-token, і контейнер не зможе прочитати з нього токен.

  3. Залиште compose.yaml без змін #

    Редагувати compose.yaml не потрібно. Рядок image: у ньому вказує образ Localtonet і версію, для якої створено цей ZIP, наприклад docker.io/localtonet/localtonet:8.6.0. Решту рядків пояснено в розділі Що робить шаблон Compose.

  4. Запустіть проєкт #

    Імпортуйте compose.yaml як проєкт у своєму менеджері контейнерів і запустіть його:

    • Synology: у Container Manager створіть проєкт із папки nas та її compose.yaml.
    • QNAP: у Container Station створіть застосунок із compose.yaml. Файл монтує ./auth-token відносно файлу Compose, тож файл токена має бути доступний за цим шляхом.
    • Будь-який хост Docker з оболонкою: виконайте наведену нижче команду з каталогу nas.
    Bash
    docker compose up -d

    Точні екрани відрізняються залежно від моделі та версії NAS. Дотримуйтеся документації виробника щодо створення проєкту з файлу Compose.

  5. Створіть і запустіть тунель #

    Коли контейнер працює, відкрийте панель керування, створіть тунель із токеном, який ви помістили у файл, і виберіть Запустити, як у Швидкому старті.

Що робить шаблон Compose #

Це весь файл. Тег наприкінці рядка image: — це версія Localtonet, для якої створено ваш ZIP; 8.6.0 — приклад.

nas/compose.yaml
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-stoppedDocker знову запускає контейнер після перезавантаження або збою, якщо ви не зупинили його самі.
network_mode: hostКонтейнер використовує мережу NAS. Тоді тунель може звертатися до сервісів на самому NAS за адресою 127.0.0.1, а до інших пристроїв у вашій локальній мережі — за їхніми локальними адресами. Для цього потрібна мережа хоста Linux.
LOCALTONET_HEADLESSЗапускає клієнт без запитів, зі звичайними рядками журналу.
LOCALTONET_AUTH_TOKEN_FILEШлях усередині контейнера до файлу, з якого клієнт читає токен.
volumesМонтує ваш файл auth-token за цим шляхом лише для читання.

Налаштування Home Assistant OS або Supervised #

Home Assistant OS і Supervised запускають застосунки через Supervisor. Шаблон — це локальний застосунок, який ви копіюєте на пристрій.

  1. Скопіюйте папку застосунку #

    Розпакуйте ZIP. Скопіюйте папку home-assistant/localtonet у каталог локальних застосунків вашого Home Assistant, щоб вийшло /addons/localtonet. У папці один файл, config.json. Не редагуйте його: він називає застосунок Localtonet, образ docker.io/localtonet/localtonet і версію, для якої створено цей ZIP, а параметр authtoken залишає порожнім, щоб ви заповнили його пізніше.

  2. Перезавантажте магазин застосунків і встановіть Localtonet #

    Перезавантажте магазин застосунків у Home Assistant, щоб він знайшов локальний застосунок, а потім встановіть Localtonet.

  3. Введіть токен і запустіть застосунок #

    Відкрийте сторінку Configuration застосунку, введіть свій AuthToken у параметр authtoken і запустіть застосунок. Home Assistant приховує значення, як пароль. Відтоді застосунок запускається автоматично разом із Home Assistant.

  4. Створіть і запустіть тунель #

    Створіть на панелі керування тунель із цим токеном і виберіть Запустити. Щоб опублікувати сам 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 або командою:

Bash
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
  1. Розпакуйте ZIP і прочитайте README.txt.
  2. Для NAS скопіюйте nas/auth-token.example у nas/auth-token і впишіть свій AuthToken. Нікому не показуйте цей файл.
  3. Перевірте тег образу в nas/compose.yaml, потім імпортуйте його як проєкт або виконайте docker compose up -d у папці nas.
  4. Для Home Assistant OS / Supervised виконайте інструкції зі встановлення локального застосунку з README і введіть токен у конфігурації застосунку.

Шаблони використовують мережу хоста Linux для доступу до LAN. Вони не надають привілеїв VPN.

Підтримка