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

Запуск Localtonet у Docker

Допомога зі сторінкою
На цій сторінці 12 розділів
  1. Перш ніж почати
  2. Кроки
  3. Завантажте образ
  4. Запустіть контейнер зі своїм токеном
  5. Створіть і запустіть тунель
  6. Як працює контейнер
  7. Запуск у фоновому режимі й автоматичний перезапуск
  8. Способи передати токен
  9. Docker Compose
  10. Доступ до вашого сервісу з контейнера
  11. Читання журналу
  12. Оновлення
  13. Архіви образів для хостів без доступу до реєстру
  14. Усунення несправностей
  15. Пов’язані сторінки

Офіційний образ localtonet/localtonet запускає клієнт Localtonet у контейнері. Передайте свій AuthToken, а потім створюйте й запускайте тунелі в панелі керування як зазвичай.

Перш ніж почати #

  • Docker на 64-бітному хості. Образ опубліковано для linux/amd64 і linux/arm64, і Docker обирає той, що відповідає вашому хосту. Для 32-бітного пристрою ARM натомість використовуйте збірку Linux.
  • AuthToken із розділу Мої токени. Дайте кожному контейнеру власний токен: коли другий клієнт підключається з тим самим токеном, перший відключається.

Кроки #

  1. Завантажте образ #

    Попереднє завантаження гарантує, що ви запускаєте поточну версію, а не старіший образ, який досі є на хості.

    Bash
    docker pull localtonet/localtonet

    Образ розміщено на Docker Hub. Окрім latest, Docker Hub показує тег для кожної версії, якщо ви хочете зафіксувати випуск.

  2. Запустіть контейнер зі своїм токеном #

    Усе після назви образу передається клієнту Localtonet. Замініть <YOUR_TOKEN> своїм AuthToken.

    Bash
    docker run localtonet/localtonet --authtoken <YOUR_TOKEN>

    Контейнер виводить стан підключення й працює на передньому плані. Натисніть Ctrl + C, щоб зупинити його.

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

    Відкрийте панель керування, створіть тунель із токеном, який ви дали контейнеру, і виберіть Запустити. Форму показано в розділі Швидкий старт. Перш ніж заповнювати Локальна IP-адреса, прочитайте Доступ до вашого сервісу з контейнера, бо 127.0.0.1 усередині контейнера означає щось інше.

Як працює контейнер #

Образ запускає клієнт у режимі без інтерфейсу. Порівняно з клієнтом на настільному комп’ютері це змінює три речі:

  • Він ніколи не ставить запитань. Якщо токен відсутній або має неправильний формат, контейнер виводить помилку й завершується з кодом 2.
  • Він записує прості рядки журналу замість живої таблиці стану, навіть якщо ви запускаєте його з -it.
  • Він не зберігає токен. Образ не оголошує томів, тому передавайте токен щоразу, коли створюється контейнер: у командному рядку, у змінній середовища або у файлі.

Тунелі в контейнері не налаштовуються. Ви створюєте, запускаєте й зупиняєте їх у панелі керування, а контейнер підхоплює їх через своє з’єднання.

Запуск у фоновому режимі й автоматичний перезапуск #

Використайте -d, щоб відокремити контейнер від терміналу, і політику перезапуску, щоб Docker знову запускав контейнер після перезавантаження або збою:

Bash
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. Вам не потрібно задавати це самостійно.

З файлом токена токен не потрапляє в опис контейнера; змонтуйте файл лише для читання:

Bash
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. і завершується. Він не запитує в сервера, чи токен дійсний.

Bash
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-config

Docker Compose #

Те саме налаштування як файл Compose. Покладіть токен у файл auth-token поруч із compose.yaml:

compose.yaml
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:ro
Bash
docker compose up -d
docker compose logs -f localtonet

Коли сервіс, який ви хочете опублікувати, перебуває в тому самому проєкті Compose на хості з Linux, опублікуйте його порт на хості й запустіть контейнер Localtonet із мережею хоста. Локальною адресою тунелю має бути IP-адреса, тому назву сервісу Compose, як-от web, використати не можна:

compose.yaml
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-адресу: клієнт не розв’язує імена Docker, як-от host.docker.internal, ім’я сервісу Compose чи ім’я контейнера. Використайте значення, що відповідає місцю, де працює сервіс:

Де працює сервісЯку локальну адресу вводитиЩо ще потрібно
На хості Docker, Linux127.0.0.1Запустіть контейнер із --network host (Compose: network_mode: host). Тоді контейнер використовує мережу хоста.
На хості Docker без мережі хоста (зокрема Docker Desktop у Windows або macOS)LAN IP-адреса хоста, наприклад 192.168.1.10Сервіс має слухати адресу, до якої може дістатися контейнер, а не лише 127.0.0.1, а брандмауер хоста має дозволяти це підключення.
В іншому контейнері127.0.0.1 з --network host у Linux, інакше LAN IP-адреса хостаОпублікуйте порт того контейнера на хості (-p, Compose: ports) і використайте опублікований порт як локальний порт тунелю.
На іншому пристрої у вашій мережіLAN IP-адреса цього пристрою, наприклад 192.168.1.20Нічого.
Linux, сервіс на хості
docker run -d \
  --name localtonet \
  --restart unless-stopped \
  --network host \
  localtonet/localtonet --authtoken <YOUR_TOKEN>

Адресу наявного тунелю можна змінити в його налаштуваннях у полі Локальна адреса. Дивіться довідник налаштувань.

Читання журналу #

docker logs -f localtonet показує по одному рядку на кожну зміну. Кожен рядок, окрім першого, починається з позначки часу:

РядокЗначення
Localtonet - headless logКлієнт запустився.
Connection: …Стан підключення до Localtonet. Новий рядок з’являється, коли він змінюється.
AuthTokenName: …Назва токена, з яким контейнер увійшов, як її показано в розділі «Мої токени».
OPEN …, ADDED …Тунель цього токена. OPEN використовується для тунелів, що існують на момент запуску клієнта, ADDED — для тунелів, що з’являються пізніше.
STATUS …Стан тунелю змінився.
CLOSED …Тунель вилучено з цього клієнта.
Authentication failed: AuthToken was rejected.Localtonet не прийняв токен.

Сам токен ніколи не записується в журнал.

Оновлення #

Завантажте образ знову й перестворіть контейнер:

Bash
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. Щоб завжди починати з найновішого образу, додайте --pull always до docker run.

Архіви образів для хостів без доступу до реєстру #

Якщо хост не має доступу до Docker Hub, завантажте образ як архів TAR на іншому комп’ютері, скопіюйте його й завантажте:

АрхітектураАрхів
AMD64localtonet-docker-amd64.tar
ARM64localtonet-docker-arm64.tar
Bash
docker load --input localtonet-docker-amd64.tar

docker load виводить, що саме завантажено. Якщо він виводить ідентифікатор образу замість назви, дайте образу назву, перш ніж його запускати:

Bash
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 працює лише з --network host у Linux. В інших випадках використовуйте LAN IP-адресу хоста. Ім’я на кшталт host.docker.internal або назва іншого контейнера в цьому полі не працює, як описано в розділі Доступ до вашого сервісу з контейнера.

Контейнер постійно втрачає з’єднання

Переконайтеся, що жоден інший клієнт не використовує той самий токен. Другий клієнт, що підключається з токеном, відключає перший. Створіть по одному токену на кожен контейнер або пристрій у розділі Мої токени.

Підтримка