Перейти к содержимому
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 внутри контейнера означает совсем другое.

Как работает контейнер #

Образ запускает клиент в режиме без интерфейса (headless). По сравнению с клиентом на настольном компьютере это меняет три вещи:

  • Он никогда ничего не спрашивает. Если токен отсутствует или имеет неверный формат, контейнер выводит ошибку и завершается с кодом 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)IP-адрес хоста в локальной сети, например 192.168.1.10Сервис должен прослушивать адрес, доступный контейнеру, а не только 127.0.0.1, а брандмауэр хоста должен разрешать подключение.
В другом контейнере127.0.0.1 с --network host в Linux, иначе IP-адрес хоста в локальной сетиОпубликуйте порт этого контейнера на хосте (-p, Compose: ports) и используйте опубликованный порт как локальный порт туннеля.
На другом устройстве в вашей сети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 выводит, что именно он загрузил. Если вместо имени выводится ID образа, задайте образу имя, прежде чем запускать его:

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. В остальных случаях используйте IP-адрес хоста в локальной сети. Имя вроде host.docker.internal или имя другого контейнера в этом поле не работает, как описано в разделе Доступ к вашему сервису из контейнера.

Контейнер постоянно теряет соединение

Убедитесь, что тот же токен не использует другой клиент. Второй клиент, подключившийся с токеном, отключает первый. Создайте по одному токену на каждый контейнер или устройство в разделе Мои токены.

Поддержка