Executar o Localtonet em um NAS ou no Home Assistant
Modelos de configuração AMD64 e ARM64
Nesta página 7 seções
- O que são os modelos
- O que eles não são
- Antes de começar
- Configurar um NAS com Docker Compose
- Extraia o ZIP e copie a pasta nas para o NAS
- Crie o arquivo de token
- Deixe o compose.yaml como está
- Inicie o projeto
- Crie e inicie um túnel
- O que o modelo Compose faz
- Configurar o Home Assistant OS ou Supervised
- Copie a pasta do app
- Recarregue a loja de apps e instale o Localtonet
- Informe o seu token e inicie o app
- Crie e inicie um túnel
- Acesse os seus serviços
- Logs e atualizações
- Páginas relacionadas
O Localtonet oferece modelos de implantação que executam o cliente Localtonet como contêiner em um NAS compatível com Docker e no Home Assistant. Você adiciona o seu AuthToken, inicia o contêiner e depois gerencia os túneis no painel.
O que são os modelos #
O download é um pequeno arquivo ZIP com dois modelos, cinco arquivos no total:
| Modelo | Use em | Arquivos | O que você altera |
|---|---|---|---|
NAS / Docker Compose (pasta nas) | Synology Container Manager, QNAP Container Station, qualquer outro NAS que execute Docker e hosts com Home Assistant Container ou Core | nas/compose.yaml e nas/auth-token.example | Apenas o token: copie auth-token.example para auth-token e substitua DUMMY_AUTH_TOKEN pelo seu AuthToken. Deixe o compose.yaml como está. |
App do Home Assistant (pasta home-assistant) | Home Assistant OS e Home Assistant Supervised | home-assistant/localtonet/config.json, a definição de um app local (antes chamado de add-on), e home-assistant/repository.json | Nada nos arquivos. Você informa o token no Home Assistant depois de instalar o app. Uma instalação local não usa o repository.json. |
O quinto arquivo, README.txt, é uma versão curta em texto dos passos desta página.
Os dois modelos executam o cliente Localtonet em um contêiner, sem prompts, do jeito que a página Docker descreve. Eles foram feitos para AMD64 (processadores Intel e AMD) e ARM64. Verifique qual processador o seu NAS tem antes de começar; um NAS ARM de 32 bits não consegue executá-lo.
O que eles não são #
- Eles não são pacotes SPK do Synology nem QPKG do QNAP. Nada aparece no Package Center do Synology nem no App Center do QNAP.
- O modelo do Home Assistant não é uma listagem na loja oficial do Home Assistant. Você o instala como um app local.
- Eles não contêm a imagem do contêiner. O seu dispositivo baixa a imagem que os modelos indicam,
docker.io/localtonet/localtonet, que é a imagem da página Docker no Docker Hub. - Eles não dão ao contêiner os privilégios de que uma interface VPN precisa. Os modelos são para túneis; o recurso de VPN não faz parte deles.
Antes de começar #
- Um NAS com suporte a Docker e Docker Compose, ou Home Assistant OS / Supervised.
- Um AuthToken de Meus tokens. Use um token que nenhum outro dispositivo use: quando um segundo cliente se conecta com o mesmo token, o primeiro é desconectado.
- O ZIP dos modelos. O download está na lista no final desta página e na página Downloads.
Configurar um NAS com Docker Compose #
-
Extraia o ZIP e copie a pasta nas para o NAS #
Extraia o arquivo no seu computador. Copie a pasta
naspara uma pasta compartilhada do NAS que o seu gerenciador de contêineres possa usar. -
Crie o arquivo de token #
Na pasta
nas, copieauth-token.exampleparaauth-token. Abraauth-tokene substituaDUMMY_AUTH_TOKENpelo seu AuthToken, em uma única linha e sem mais nada no arquivo.Mantenha o arquivo de token privado. Restrinja-o à sua própria conta no NAS e não o coloque em uma pasta compartilhada ou sincronizada que outras pessoas possam ler. O token permite que o cliente Localtonet se conecte como este dispositivo.
O arquivo precisa existir antes de o contêiner iniciar. Se ele não existir, o Docker cria um diretório chamado
auth-tokenno lugar, e o contêiner não consegue ler um token dele. -
Deixe o compose.yaml como está #
Você não precisa editar o
compose.yaml. A linhaimage:dele indica a imagem do Localtonet e a versão para a qual este ZIP foi feito, por exemplodocker.io/localtonet/localtonet:8.6.0. As outras linhas são explicadas em O que o modelo Compose faz. -
Inicie o projeto #
Importe o
compose.yamlcomo um projeto no seu gerenciador de contêineres e inicie-o:- Synology: no Container Manager, crie um projeto a partir da pasta
nase docompose.yamldela. - QNAP: no Container Station, crie um aplicativo a partir do
compose.yaml. O arquivo monta./auth-tokenem relação ao arquivo Compose, então o arquivo de token precisa estar acessível nesse caminho. - Qualquer host Docker com shell: execute o comando abaixo no diretório
nas.
Bashdocker compose up -dAs telas exatas variam entre modelos e versões de NAS. Siga a documentação do seu fabricante para criar um projeto a partir de um arquivo Compose.
- Synology: no Container Manager, crie um projeto a partir da pasta
-
Crie e inicie um túnel #
Quando o contêiner estiver em execução, abra o painel, crie um túnel com o token que você colocou no arquivo e selecione Iniciar, como no Início rápido.
O que o modelo Compose faz #
Este é o arquivo inteiro. A tag no fim da linha image: é a versão do Localtonet para a qual o seu ZIP foi feito; 8.6.0 é um exemplo.
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| Configuração | O que faz |
|---|---|
image | A imagem do Localtonet, docker.io/localtonet/localtonet, e a versão a executar. Altere a tag apenas ao mudar para outra versão; veja Logs e atualizações. |
restart: unless-stopped | O Docker inicia o contêiner de novo após uma reinicialização ou uma falha, a menos que você mesmo o tenha parado. |
network_mode: host | O contêiner compartilha a rede do NAS. Assim, um túnel pode alcançar serviços no próprio NAS em 127.0.0.1 e outros dispositivos da sua LAN pelos endereços deles na LAN. Isso exige a rede de host do Linux. |
LOCALTONET_HEADLESS | Executa o cliente sem prompts, com linhas de log simples. |
LOCALTONET_AUTH_TOKEN_FILE | O caminho, dentro do contêiner, do arquivo de onde o cliente lê o token. |
volumes | Monta o seu arquivo auth-token somente leitura nesse caminho. |
Configurar o Home Assistant OS ou Supervised #
O Home Assistant OS e o Supervised executam apps por meio do Supervisor. O modelo é um app local que você copia para o dispositivo.
-
Copie a pasta do app #
Extraia o ZIP. Copie a pasta
home-assistant/localtonetpara o diretório de apps locais do seu Home Assistant, de modo que ela se torne/addons/localtonet. A pasta contém um único arquivo,config.json. Não o edite: ele dá ao app o nome Localtonet, indica a imagemdocker.io/localtonet/localtonete a versão para a qual este ZIP foi feito, e deixa a opçãoauthtokenvazia para você preencher depois. -
Recarregue a loja de apps e instale o Localtonet #
Recarregue a loja de apps no Home Assistant para que ele encontre o app local e depois instale o Localtonet.
-
Informe o seu token e inicie o app #
Abra a página Configuration do app, informe o seu AuthToken na opção
authtokene inicie o app. O Home Assistant oculta o valor como uma senha. A partir daí, o app inicia automaticamente junto com o Home Assistant. -
Crie e inicie um túnel #
Crie um túnel com esse token no painel e selecione Iniciar. Para publicar o próprio Home Assistant, crie um túnel HTTP para
127.0.0.1e a porta em que o seu Home Assistant escuta. A porta padrão do Home Assistant é8123. O Home Assistant tem configurações próprias para requisições que chegam por um proxy; se ele as rejeitar, veja a documentação HTTP do Home Assistant.
O app usa a rede de host, então alcança diretamente o Home Assistant e os outros dispositivos da sua rede. Ele é compatível com as arquiteturas do Home Assistant amd64 e aarch64.
O Home Assistant Container e o Core não têm Supervisor, então não conseguem instalar apps. Nessas instalações, use o modelo NAS / Docker Compose no host Docker.
O arquivo home-assistant/repository.json fica fora da pasta que você copia e não faz parte de uma instalação local. Ele contém valores de exemplo (DUMMY) para a URL de um repositório e um mantenedor; ignore-o.
Acesse os seus serviços #
Os dois modelos usam a rede de host. No campo Endereço IP local de um túnel:
127.0.0.1é o próprio NAS ou o host do Home Assistant. Use-o para a interface web do NAS, o Home Assistant ou qualquer outro serviço nesse dispositivo, com a porta em que o serviço escuta.- Um endereço da LAN, como
192.168.1.20, alcança outro dispositivo da sua rede.
Um túnel iniciado fica acessível pela internet. Antes de publicar uma página de login do NAS ou o Home Assistant, mantenha senhas fortes e login em dois fatores no próprio serviço e considere as opções da página Controle de acesso.
Logs e atualizações #
O contêiner escreve linhas de log simples: o estado da conexão, o nome do token com o qual ele fez login e uma linha sempre que um túnel é adicionado, muda de status ou é removido. Leia-as na visualização de logs do seu gerenciador de contêineres, na aba Log do app no Home Assistant, ou com:
docker compose logs -f localtonetA linha Invalid Localtonet headless configuration. Check the token file or environment settings. significa que o cliente não encontrou nenhum token utilizável: o arquivo de token não existe ou está vazio, ainda contém DUMMY_AUTH_TOKEN, ou o token não tem 33 caracteres. Authentication failed: AuthToken was rejected. significa que o token está bem formado, mas o Localtonet não o aceita.
Cada ZIP de modelos é feito para uma versão do Localtonet: o arquivo Compose a fixa na tag da linha image:, e o app do Home Assistant no campo version do config.json. Para levar um NAS a uma versão mais nova, mude a tag para uma versão que o Docker Hub liste para a imagem (veja Docker) e execute docker compose up -d de novo (ou atualize o projeto no seu gerenciador de contêineres). O seu arquivo auth-token permanece como está.
Páginas relacionadas #
NAS e Home Assistant
Templates do Docker Compose para Synology Container Manager, QNAP Container Station e outros NAS com suporte a Docker, além de um template de app do Home Assistant para OS / Supervised. AMD64 e ARM64.
Estes são templates de configuração, não instaladores SPK / QPKG nem um app oficial da loja do Home Assistant. Uma imagem Docker compatível precisa estar disponível no registry. Usuários do Home Assistant Container / Core podem usar o template do Compose.
Configure seu NAS ou Home Assistant
- Extraia o ZIP e leia o
README.txt. - Em um NAS, copie
nas/auth-token.exampleparanas/auth-tokene informe seu AuthToken. Mantenha este arquivo privado. - Verifique a tag da imagem em
nas/compose.yamle depois importe-o como projeto ou executedocker compose up -dno diretórionas. - No Home Assistant OS / Supervised, siga as instruções de instalação do app local no README e informe o token na configuração do app.
Os templates usam a rede do host Linux para acesso à LAN. Eles não ativam privilégios de VPN.