Implantação do cliente de Relay

Instale e inicie o cliente de Relay em uma máquina dentro de sua rede para estabelecer o túnel de saída para o Test Cloud. Antes de começar, configure um grupo de Relay e tenha a string de configuração do cliente pronta.

Pré-requisitos

Requisitos de Hardware

Perfil	vCPU	BATER	Grupos de Relay	Endpoints por grupo	Use case
Padrão	1	2 GB	Até 10	Até 50	A maioria das implantações
Grande	2	4GB	10+	Até 50	Ambientes de alta taxa de transferência ou grande escala

Esses são requisitos mínimos para o processo do cliente de Relay. Se a máquina executar outras cargas de trabalho, provisione recursos adicionais conforme necessário.

Requisitos do disco

Perfil	Mínimo de disco livre
Padrão (1 a 10 grupos)	200 MB
Grande (mais de 10 grupos)	1 GB

Sistemas operacionais compatíveis

Arquitetura	Linux	Windows
x86_64 (amd64)	Suportado	Suportado
ARM64 (aarch64)	Suportado	Suportado

Requisitos de rede

O cliente de Relay requer conectividade apenas de saída. Nenhuma regra de firewall de entrada é necessária.

Protocol	Porta	Destino	Passagem TLS necessária	Finalidade
Https	443	cloud.uipath.com	Não é necessário	Autenticação e registro de relay
TCP	443	<region>-relay.uipath.com	Required	Túnel persistente para o servidor de relay ( TCP bruto encapsulado em TLS )

Substitua <region> pela Região de seu tenant do Test Cloud.

Região	Nome do host do servidor de relay
NÓS	us-relay.uipath.com
UE	eu-relay.uipath.com
Canadá	ca-relay.uipath.com
Suíça	ch-relay.uipath.com
Austrália	au-relay.uipath.com
Singapura	sg-relay.uipath.com
Japão	jp-relay.uipath.com
Coreia do Sul	kr-relay.uipath.com
Emirados Árabes Unidos	ae-relay.uipath.com
Reino Unido	uk-relay.uipath.com
GXP UE	gxp-eu-relay.uipath.com
GXP EUA	gxp-us-relay.uipath.com

Observação:

Entre em contato com o suporte da UiPath para confirmar o nome do host do servidor de relay se a região do seu tenant não estiver listada acima.

Escolha a região que corresponde à sua região de tenant do UiPath Cloud, não a localização física do nó de relay. Por exemplo, se seu tenant for provisionado na região dos EUA, use us-relay.uipath.com que o próprio relay seja executado em uma geografia diferente.

Considerações sobre latência: como o tráfego atravessa o UiPath Cloud → Servidor de Relay → nó de Relay → serviço no local, colocar o nó de relay geograficamente próximo da região do seu tenant minimiza o tempo de ida e volta e melhora a taxa de transferência geral.

Configure seu firewall e qualquer proxy de inspeção TLS ou dispositivo DLP para permitir a passagem do TLS para <region>-relay.uipath.com:443. A inspeção TLS nesse destino interrompe o túnel de relay.

A máquina que executa o cliente de Relay também deve ter acesso de rede direto a todos os serviços locais que você planeja expor. Planeje o posicionamento do cliente de Relay corretamente.

Importante:

O nó de relay deve ser capaz de resolver o nome do host e abrir uma conexão com a porta registrada para cada ponto de extremidade em seu grupo de relay no runtime. O caminho de roteamento é flexível — uma rota de rede direta, proxy de saída corporativo ou jump host são aceitáveis — desde que a conexão seja bem-sucedida a partir do nó de relay. Planeje o posicionamento para que todos os pontos de extremidade no grupo permaneçam acessíveis.

largura de banda

O canal de controle (pulsação e autenticação) usa aproximadamente 1–2 KB/minuto quando inativo. O tráfego de dados escala com o volume de solicitações que seus serviços de nuvem enviam para endpoints locais — o relay atua como um túnel transparente sem sobrecarga adicional além do framework TLS.

Verificar conectividade

Antes de instalar o cliente de Relay, confirme se o tráfego de saída na porta 443 é permitido para ambos os destinos necessários.

Linux

nc -zv cloud.uipath.com 443
nc -zv <region>-relay.uipath.com 443

Windows (PowerShell)

Test-NetConnection -ComputerName cloud.uipath.com -Port 443
Test-NetConnection -ComputerName <region>-relay.uipath.com -Port 443

Um resultado bem-sucedido mostra TcpTestSucceeded : True no Windows e succeeded no Linux. Se alguma verificação falhar, revise suas regras de firewall e confirme se a senha TLS está configurada para o nome do host do servidor de relay.

Configure um proxy (se aplicável)

Se sua rede rotear o tráfego de saída por meio de um proxy, defina as seguintes variáveis de ambiente antes de relay start. O cliente de Relay aplica o proxy a todas as conexões de saída.

Variável	Finalidade
HTTPS_PROXY / https_proxy	URL do proxy (verificado primeiro)
HTTP_PROXY / http_proxy	URL do proxy (retorno)
NO_PROXY / no_proxy	Hosts ou domínios separados por vírgulas que ignoram o proxy

O URL do proxy deve usar um desses esquemas: http://, https://, socks5:// ou ntlm://. Formato: scheme://[user:password@]host:port.

Para proxies https:// : o cliente de Relay valida o certificado TLS do proxy contra o armazenamento de confiança do SO. Se seu proxy usar uma CA corporativa ou autoassinada, adicione essa CA ao armazenamento de confiança da máquina cliente de Relay antes de iniciar o relay; caso contrário, o handshake do TLS falhará com um erro de verificação de certificado.

Configure seu proxy para ignorar a inspeção TLS para <region>-relay.uipath.com:443. Arquivos PAC, descoberta automática de WPAD e encadeamento de proxy não são compatíveis — defina o URL do proxy explicitamente. Quando um proxy é detectado, as verificações de pré-requisitos mostram via proxy na saída.

Segurança: o cliente de Relay edita senhas de proxy em logs. No entanto, as credenciais definidas em variáveis de ambiente podem ser visíveis em listagens de processos e arquivos de unidade do systemd. Use credenciais de serviço dedicadas e restrinja o acesso ao nó de relay adequadamente.

Configurar IPs confiáveis (se aplicável)

Se sua organização restringir o acesso por endereço IP, adicione o IP NAT da máquina que executa o cliente de Relay à lista de IPs Confiáveis na UiPath Administration. O tráfego de saída do cliente de Relay chega ao Test Cloud a partir desse endereço IP, portanto, você deve permiti-lo explicitamente.

Para obter instruções, consulte Adicionar intervalos de IP confiáveis.

Aceite o contrato de licença

Antes de iniciar o cliente de Relay, você deve aceitar o contrato de licença. Escolha um dos seguintes métodos:

Opção 1 (variável de ambiente) — Defina a variável de ambiente LICENSE_AGREEMENT para aceitar:

Linux

export LICENSE_AGREEMENT=accept

Windows

$env:LICENSE_AGREEMENT=accept

Opção 2 (parâmetro incorporado) — Acrescentar --accept-license-agreement ao comando relay start :

./relay start --config "<your-config>" --accept-license-agreement

Guias de configuração

Para implantações de produção, consulte o guia de plataforma do seu sistema operacional — ele abrange a estrutura de diretório, gerenciamento de serviços, configuração da estrutura de segurança e procedimentos de desinstalação:

Plataforma	Guia
Linux	Implantação do cliente de Relay no Linux
Windows	Implantando o cliente de Relay no Windows
Contêiner	Deploying the Relay client as a container

Operações

Resiliência da conexão

O cliente de Relay mantém o túnel automaticamente:

• Pulsações a cada 30 segundos por padrão (configurável via --heartbeat-interval, mínimo 10 segundos). O tempo limite do túnel é 3 × o intervalo de pulsação. Reduza o intervalo se seu firewall, proxy ou NAT descartar conexões TCP ociosas antes de 30 segundos:

  relay start --config "<config>" --heartbeat-interval 10
  relay restart <id> --heartbeat-interval 10
  

• Reconexão automática ao desconectar, usando o dimensionamento de espera exponencial para intervalos de 20 segundos.
• Reinicialização automática do serviço se o processo falhar, gerenciada pelo systemd no Linux e pelo Gerenciador de Controle de Serviços do Windows no Windows.
• Início automático do serviço na reinicialização do sistema.

Reconexão proativa

Algumas redes — por trás de um proxy corporativo, balanceador de carga ou firewall com um tempo limite de conexão ociosa — encerram silenciosamente conexões TLS de longa duração. A reconexão proativa restaura a conexão de controle em um cronograma fixo para evitar isso.

Habilite-o com o sinalizador --reconnect-interval :

relay start --config "<config>" --reconnect-interval 1800

O mínimo efetivo é de 1800 segundos (30 minutos). Defina o intervalo para aproximadamente metade do tempo limite ocioso de seu dispositivo de rede — por exemplo, 1800 segundos para um tempo limite de firewall de 60 minutos. Deixe desabilitado em redes estáveis sem um tempo limite de conexão ociosa.

Descarga suave. Quando o intervalo transcorre, o cliente de Relay para de aceitar novo trabalho e aguarda as conexões em andamento serem concluídas — até um tempo limite de drenagem de 300 segundos — antes de fechar a conexão antiga e abrir uma nova. As solicitações ainda em andamento quando o tempo limite de drenagem é atingido são encerradas.

Alta disponibilidade. Quando vários clientes do Relay são implantados no mesmo grupo, eles se coordenam para que apenas um cliente seja drenado de cada vez. O grupo continua atendendo o tráfego ao longo de cada ciclo de reconexão.

Indica que a reconexão proativa é necessária: os logs mostram erros unexpected EOF ou desconexões silenciosas apesar de uma rede subjacente estável — normalmente causados por um tempo limite ocioso de 30 a 60 minutos em um firewall, proxy ou balanceador de carga.

Recarregar configuração

relay reload <id>

Busca novamente a configuração de proxy do Test Cloud e a aplica sem reiniciar. Alterações no lado da nuvem — novos pontos de extremidade, caminhos de verificação de integridade atualizados — chegam automaticamente a um cliente Relay em execução e normalmente não exigem recarregamento.Use esse comando como fallback apenas se um ponto de extremidade recém-adicionado retornar 404.

Geração de logs

Configuração	Valor
Nível padrão	info
Rotação	Daily
Retenção	7 dias
arquivo de log	relay.log (atual), relay.YYYYMMDD-HHMMSS.log (rotacionado)

Substitua o nível de log padrão por --log-level trace/debug/info/warn/error.

Comandos de gerenciamento

Ação	Linux	Windows (Administrador PowerShell)
Listar clientes do Relay	relay list	.\relay.exe list
Lista (saída JSON)	relay list --json	.\relay.exe list --json
Exibir logs	relay logs <id>	.\relay.exe logs <id>
Logs de stream	relay logs <id> --follow	.\relay.exe logs <id> --follow
Recarregar configuração	relay reload <id>	.\relay.exe reload <id>
Parar	sudo relay stop <id>	.\relay.exe stop <id>
Reiniciar	sudo relay restart <id>	.\relay.exe restart <id>
Excluir	sudo relay delete <id>	.\relay.exe delete <id>
Forçar exclusão	sudo relay delete <id> --force	.\relay.exe delete <id> --force
Versão	relay version	.\relay.exe version

Use --force em excluir quando as credenciais estiverem ilegíveis — por exemplo, após um clone ou reimagem de uma VM — ou quando o grupo de relay do lado da nuvem já tiver sido excluído.

Referência de comando

relay start

Provisione um novo cliente de Relay e inicie-o como um serviço em segundo plano.

Configuração (uma necessária)

• -c, --config <string> — string de configuração codificada base64 embutida.
• --config-file <path> — caminho para um arquivo que contém a string de configuração. Recomendado — mantém o segredo fora do histórico do shell.

Ajuste (opcional)

• --heartbeat-interval <sec> intervalo de pulsação do túnel. Padrão 30. O tempo limite do túnel é 3 × esse valor. Menor se seu firewall, NAT ou proxy eliminar o TCP ocioso antes de 30 segundos.
• --reconnect-interval <sec> — intervalo de reconexão proativo. Padrão 0 (desabilitado); mínimo efetivo 1800 (30 minutos) quando definido.
• --log-level <level> — trace, debug, info, warn ou error. Padrão info.
• -d, --detach=false — executado em primeiro plano em vez de como um serviço em segundo plano. Útil para depurar problemas de inicialização.

Caminhos de instalação não padrão (opcional)

• --data-dir <path> — diretório de configuração.
• --logs-dir <path> — diretório do arquivo de log.
• --bin-dir <path> — diretório de instalação binário.

Apenas Linux

• --user-mode — instale como um serviço de usuário do sistema (sem sudo necessário, usa caminhos XDG).

Windows apenas

• --service-account <DOMAIN\user> execute o serviço do Windows em uma conta específica. O padrão é LocalSystem.
• --service-account-password <password> — senha para --service-account.

relay restart <id>

Interrompa e reinicie o serviço do cliente de Relay. Detecta binários atualizados e aplica alterações na definição do serviço. Os seguintes sinalizadores podem ser substituídos no momento da reinicialização (todos padrão para inalterados):

• --config / --config-file — substitua a configuração do cliente.
• --log-level altere o nível de log.
• --heartbeat-interval altere o intervalo de pulsação. Transmita 0 para deixar inalterado.
• --reconnect-interval altere o intervalo de reconexão proativo. Mínimo de 1800 (30 minutos) quando definido. Transmita 0 para desabilitar.

relay logs <id>

Mostre a saída de log para um cliente de Relay.

• -f, --follow — transmita novas linhas de log continuamente.
• -n, --lines <N> — número de linhas do final. Padrão 50.

relay list

Mostra todos os clientes de Relay nesta máquina com status, ID de grupo, carimbo de data/hora de criação e modo de serviço.

• --json emita a saída JSON para automação e script.

relay reload <id>

Busque novamente a configuração de proxy do Test Cloud e aplique-a sem reiniciar. Use como fallback se um ponto de extremidade recém-adicionado retornar 404.

relay stop <id>

Interrompa o serviço ao cliente do Relay. A configuração e as credenciais são preservadas — o cliente de Relay pode ser reiniciado mais tarde.

relay delete <id>

Interrompa o serviço, cancele o registro do Test Cloud e remova todas as configurações e credenciais locais.

• -f, --force — remover localmente sem cancelamento de registro na nuvem. Use quando as credenciais forem ilegíveis ou os recursos do lado da nuvem já tiverem sido excluídos.

relay support-bundle [id]

Colete um arquivo redigido de configuração, logs e metadados do sistema para um tíquete de suporte da UiPath. Omita [id] para agrupar todos os clientes de Relay na máquina.As credenciais e chaves de criptografia nunca são incluídas. Consulte Solução de problemas de Relay para obter todos os detalhes.

relay version

Visualize a versão do cliente de Relay, a data de compilação e o hash de confirmação do git.

Segurança de antivírus e ponto de extremidade

Se sua organização executar um software de proteção de ponto de extremidade, adicione exclusões para o binário de relay e seu diretório de dados para evitar que o cliente de Relay seja bloqueado ou colocado em quarentena. Configure proxies de inspeção TLS, dispositivos DLP e sistemas IDS/IPS para ignorar a inspeção de <region>-relay.uipath.com:443.

Destino	Porta	Protocol	Ação
cloud.uipath.com	443	Https	Permitir
<region>-relay.uipath.com	443	TLS	Permitir + ignorar inspeção TLS