Implementar el cliente de Relay

Instala e inicia el cliente de Relay en una máquina de tu red para establecer el túnel saliente a Test Cloud. Antes de comenzar, configura un grupo de Relays y ten lista la cadena de configuración del cliente.

Requisitos previos

Requisitos de hardware

Perfil	vCPU	RAM	Grupos de Relay	Puntos finales por grupo	Use case
Estándar	1	2 GB	Hasta 10	Hasta 50	La mayoría de las implementaciones
Grande	2	4 GB	10+	Hasta 50	Entornos de alto rendimiento o a gran escala

Estos son los requisitos mínimos para el proceso de cliente de Relay. Si la máquina ejecuta otras cargas de trabajo, aprovisiona recursos adicionales en consecuencia.

Requisitos del disco

Perfil	Disco libre mínimo
Estándar (1-10 grupos)	200 MB
Grande (más de 10 grupos)	1 GB

Sistemas operativos compatibles

Arquitectura	Linux	Ventanas
x86_64 (amd64)	Compatible	Compatible
ARM64 (aarch64)	Compatible	Compatible

Requisitos de red

El cliente de Relay requiere conectividad solo de salida. No se necesitan reglas de firewall entrantes.

Comenzando con el cliente de Relay 26.4.2, las nuevas configuraciones del cliente de Relay pueden conectarse al túnel persistente a través de la URL estándar de Automation Cloud, cloud.uipath.com. Estas configuraciones no requieren una lista de permisos de nombres de host de Relay específica de la región para el túnel.

Configuración del cliente de Relay	Protocolo	Puerto	Destination	Se requiere paso de TLS	Propósito
Cliente de Relay 26.4.2 o posterior	HTTPS/WSS	443	cloud.uipath.com	No es necesario	Autenticación, registro de Relay y túnel persistente
Versiones de cliente de Relay anteriores a 26.4.2	TLS	443	<region>-relay.uipath.com	Obligatorio	Túnel persistente

Las versiones de cliente de Relay anteriores a 26.4.2 siguen funcionando con nombres de host de Relay regionales. Mantenga esos nombres de host en la lista de permitidos hasta que pase al cliente de Relay 26.4.2 o posterior y se conecte a través de cloud.uipath.com.

Para las versiones de cliente de Relay anteriores a 26.4.2, reemplace <region> por la región de su tenant de Test Cloud.

Región	Nombre de host del servidor de Relay
EE. UU.	us-relay.uipath.com
UE	eu-relay.uipath.com
Canadá	ca-relay.uipath.com
Suiza	ch-relay.uipath.com
Australia	au-relay.uipath.com
Singapur	sg-relay.uipath.com
Japón	jp-relay.uipath.com
Corea del Sur	kr-relay.uipath.com
EAU	ae-relay.uipath.com
Reino Unido	uk-relay.uipath.com
GXP de la UE	gxp-eu-relay.uipath.com
GXP EE. UU.	gxp-us-relay.uipath.com

Nota:

Ponte en contacto con el soporte de UiPath para confirmar el nombre de host del servidor de retransmisión si la región de tu tenant no aparece en la lista anterior.

Elige la región que coincida con tu región de tenant de UiPath Cloud, no la ubicación física del nodo de Relay. Por ejemplo, si tu tenant está aprovisionado en la región de EE. UU. us-relay.uipath.com utiliza incluso si el propio Relay se ejecuta en una geografía diferente. Las configuraciones del cliente de Relay 26.4.2 que se conectan a través de cloud.uipath.com no utilizan este nombre de host regional.

Latency considerations

Consideraciones de latencia: debido a que el tráfico atraviesa UiPath Cloud → servidor de retransmisión → nodo de retransmisión → servicio local, colocar el nodo de retransmisión geográficamente cerca de la región de tu tenant minimiza el tiempo de ida y vuelta y mejora el rendimiento general.

Relay client 26.4.2 configurations

For Relay client 26.4.2 configurations that connect through cloud.uipath.com, configure firewalls and proxies to allow HTTPS traffic and WebSocket upgrades to cloud.uipath.com:443.

If a proxy inspects TLS for cloud.uipath.com, install the proxy's signing CA in the OS trust store used by the Relay client, and make sure the proxy allows WebSocket upgrades.

Versiones de cliente de Relay anteriores a 26.4.2

For Relay client versions earlier than 26.4.2, configure your firewall and any TLS-inspecting proxy or DLP appliance to allow TLS passthrough for <region>-relay.uipath.com:443; TLS inspection on the regional relay hostname breaks the relay tunnel.

La máquina que ejecuta el cliente de Relay también debe tener acceso directo a la red a todos los servicios locales que planea exponer. Planifique la ubicación del cliente de Relay en consecuencia.

Importante:

El nodo de Relay debe poder resolver el nombre de host y abrir una conexión al puerto registrado para cada punto final en su grupo de Relay en runtime. La ruta de enrutamiento es flexible: una ruta de red directa, un proxy de salida corporativo o un host de salto son aceptables, siempre que la conexión se realice correctamente desde el nodo de retransmisión. Planifica la ubicación para que todos los puntos finales del grupo sigan siendo accesibles.

Ancho de banda

El canal de control (latidos y autenticación) utiliza aproximadamente 1-2 KB/minuto cuando está inactivo. El tráfico de datos escala con el volumen de solicitudes que tus servicios en la nube envían a los puntos finales locales: el Relay actúa como un túnel transparente sin sobrecarga adicional más allá de TLS y la estructura ligera de WebSocket para las conexiones cloud.uipath.com .

Verificar conectividad

Antes de instalar el cliente de Relay, confirme que el tráfico saliente en el puerto 443 está permitido a los destinos necesarios para su configuración.

Linux

nc -zv cloud.uipath.com 443

# Required only for Relay client versions earlier than 26.4.2
nc -zv <region>-relay.uipath.com 443

Windows (PowerShell)

Test-NetConnection -ComputerName cloud.uipath.com -Port 443

# Required only for Relay client versions earlier than 26.4.2
Test-NetConnection -ComputerName <region>-relay.uipath.com -Port 443

Un resultado correcto muestra TcpTestSucceeded : True en Windows y succeeded en Linux. Si una comprobación necesaria falla, revisa las reglas de tu cortafuegos. Para las configuraciones del cliente de Relay 26.4.2 que se conectan a través de cloud.uipath.com, confirme que se permiten las actualizaciones de WebSocket; para las versiones de cliente de Relay anteriores a 26.4.2, confirma que el paso de TLS está configurado para el nombre de host del servidor de Relay.

Configurar un proxy (si corresponde)

Si tu red enruta el tráfico saliente a través de un proxy, establece las siguientes variables de entorno antes de ejecutar relay start. El cliente de Relay aplica el proxy a todas las conexiones salientes.

Variable	Propósito
HTTPS_PROXY / https_proxy	URL de proxy (marcada en primer lugar)
HTTP_PROXY / http_proxy	URL de proxy (alternativa)
NO_PROXY / no_proxy	Hosts o dominios separados por comas que omiten el proxy

La URL del proxy debe utilizar uno de estos esquemas: http://, https://, socks5:// o ntlm://. Formato: scheme://[user:password@]host:port.

Para https:// : el cliente de Relay valida el certificado TLS del proxy con el almacén de confianza del sistema operativo. Si tu proxy utiliza una CA corporativa o autofirmada, añade esa CA al almacén de confianza de la máquina cliente de Relay antes de iniciar el Relay; de lo contrario, el protocolo de enlace TLS falla con un error de verificación de certificado.

For Relay client 26.4.2 configurations that connect through cloud.uipath.com, configure your proxy to allow long-lived HTTPS connections and WebSocket upgrades to cloud.uipath.com:443. If the proxy inspects TLS for cloud.uipath.com, install the proxy's signing CA in the OS trust store used by the Relay client.

For Relay client versions earlier than 26.4.2, configure your proxy to bypass TLS inspection for <region>-relay.uipath.com:443. PAC files, WPAD auto-discovery, and proxy chaining are not supported — set the proxy URL explicitly. When a proxy is detected, the prerequisite checks show via proxy in the output.

Seguridad: el cliente de Relay redacta las contraseñas de proxy en los registros. Sin embargo, las credenciales establecidas en las variables de entorno pueden ser visibles en los listados de procesos y los archivos de unidad systemd. Utiliza credenciales de servicio dedicadas y restringe el acceso al nodo de Relay en consecuencia.

Configurar IP de confianza (si corresponde)

Si tu organización restringe el acceso por dirección IP, entra en Administración de UiPath y añade la IP NAT de la máquina que ejecuta el cliente de Relay a la lista de IP de confianza. El tráfico saliente del cliente de Relay llega a Test Cloud desde esta dirección IP, por lo que debe estar permitido explícitamente.

Para obtener instrucciones, consulta Añadir rangos de IP de confianza.

Aceptar el acuerdo de licencia

Antes de iniciar el cliente de Relay, debe aceptar el acuerdo de licencia. Elige uno de los siguientes métodos:

Opción 1 (Variable de entorno) : establece la variable de entorno LICENSE_AGREEMENT para aceptar:

Linux

export LICENSE_AGREEMENT=accept

Ventanas

$env:LICENSE_AGREEMENT=accept

Opción 2 (parámetro en línea) : anexa --accept-license-agreement al comando relay start :

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

Guías de configuración

Para las implementaciones de producción, consulta la guía de la plataforma de tu sistema operativo, que cubre la estructura de directorios, la gestión de servicios, la configuración del marco de seguridad y los procedimientos de desinstalación:

Plataforma	Guía
Linux	Implementar el cliente de Relay en Linux
Ventanas	Implementar el cliente de Relay en Windows
Contenedor	Implementar el cliente de Relay como contenedor

Operaciones

Resiliencia de la conexión

El cliente de Relay mantiene el túnel automáticamente:

• Latidos cada 30 segundos de forma predeterminada (configurable a través de --heartbeat-interval, mínimo 10 segundos). El tiempo de espera del túnel es 3 veces el intervalo de latido. Reduce el intervalo si tu cortafuegos, proxy o NAT descarta las conexiones TCP inactivas antes de 30 segundos:

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

• Reconectarse automáticamente al desconectarse, utilizando la escala de retroceso exponencial a intervalos de 20 segundos.
• Reinicio automático del servicio si el proceso falla, gestionado por systemd en Linux y el Gestor de control de servicios de Windows en Windows.
• Servicio de inicio automático al reiniciar el sistema.

Reconexión proactiva

Algunas redes, detrás de un proxy corporativo, un equilibrador de carga o un firewall con un tiempo de espera de conexión inactiva, finalizan de forma silenciosa las conexiones TLS de larga duración. La reconexión proactiva restablece la conexión de control en una programación fija para evitarlo.

Habilítelo con el marcador --reconnect-interval :

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

El mínimo efectivo es de 1800 segundos (30 minutos). Establece el intervalo en aproximadamente la mitad del tiempo de espera de inactividad de tu dispositivo de red; por ejemplo, 1800 segundos para un tiempo de espera del cortafuegos de 60 minutos. Dejar deshabilitado en redes estables sin un tiempo de espera de conexión inactiva.

• Drenaje elegante. Cuando transcurre el intervalo, el cliente de Relay deja de aceptar nuevos trabajos y espera a que se completen las conexiones en tránsito (hasta un tiempo de espera de drenaje de 300 segundos) antes de cerrar la conexión antigua y abrir una nueva. Las solicitudes que aún estén en vuelo cuando se alcance el tiempo de espera de drenaje se cancelarán.

• Alta disponibilidad. Cuando se implementan varios clientes de Relay en el mismo grupo, se coordinan para que solo se agote un cliente a la vez. El grupo continúa sirviendo tráfico a lo largo de cada ciclo de reconexión.

• Señales de que se necesita una reconexión proactiva: los registros muestran errores unexpected EOF periódicos o desconexiones silenciosas a pesar de una red subyacente estable, generalmente causadas por un tiempo de inactividad de 30 a 60 minutos en un firewall, proxy o equilibrador de carga.

Volver a cargar la configuración

relay reload <id>

Vuelve a obtener la configuración del proxy de Test Cloud y la aplica sin reiniciar. Los cambios en la nube (nuevos puntos finales y actualizaciones de las rutas de comprobación de estado) se envían automáticamente a un cliente de Relay que se está ejecutando y normalmente no hay que recargarlos. Usa este comando como alternativa solo si un punto final recién añadido devuelve 404.

Registro

Configuración	Valor
Nivel predeterminado	info
Rotación	Diario
Retención	7 días
archivo de registro .etl	relay.log (actual), relay.YYYYMMDD-HHMMSS.log (rotado)

Anula el nivel de registro predeterminado con --log-level trace/debug/info/warn/error. En el cliente de Relay 26.4.2 o posterior, anule la retención de registros rotados con --log-retention-days <days> en relay start o relay restart; la retención mínima es de 7 días.

Referencia de los comandos

Inicio de relé

Aprovisione un nuevo cliente de Relay e inícielo como servicio en segundo plano.

Configuración (se requiere una)

• -c, --config <string> — cadena de configuración codificada en base64 en línea.
• --config-file <path> — ruta a un archivo que contiene la cadena de configuración. Recomendado: mantiene el secreto fuera del historial de shell.

Ajuste (opcional)

• --heartbeat-interval <sec> — intervalo de latido del túnel. Predeterminado 30. Mínimo 10. El tiempo de espera del túnel es 3 veces este valor. Baje si su firewall, NAT o proxy descarta el TCP inactivo antes de 30 segundos.
• --reconnect-interval <sec> — intervalo de reconexión proactiva. Predeterminado 0 (deshabilitado); mínimo efectivo 1800 (30 minutos) cuando se establece.
• --log-level <level> — trace, debug, info, warn o error. Predeterminado info.
• --log-retention-days <days> : número de días para conservar los archivos de registro rotados. Predeterminado 7. Mínimo 7. Requiere el cliente de Relay 26.4.2 o posterior.
• -d, --detach=false : se ejecuta en primer plano en lugar de como un servicio en segundo plano. Útil para depurar incidencias de inicio.

Rutas de instalación no predeterminadas (opcional)

• --data-dir <path> — directorio de configuración.
• --logs-dir <path> — directorio de archivos de registro.
• --bin-dir <path> — directorio de instalación binario.

Solo Linux

• --user-mode — instalar como servicio de usuario de systemd (no se requiere sudo , utiliza rutas XDG).

Solo en Windows

• --service-account <DOMAIN\user> : ejecuta el servicio de Windows bajo una cuenta específica. El valor predeterminado es LocalSystem.
• --service-account-password <password> : contraseña para --service-account.

reinicio del relé

Stop and restart the Relay client service. Detects updated binaries and applies service definition changes.

The following flags can be overridden at restart time (all default to unchanged unless noted):

• --config / --config-file : reemplaza la configuración del cliente.
• --accept-license-agreement : acepta el acuerdo de licencia durante el reinicio, útil al actualizar un servicio instalado más antiguo que no persistía en la aceptación de la licencia.
• --log-level : cambia el nivel de registro.
• --logs-dir <path> — reubica el directorio de registro del servicio instalado. Requiere el cliente de Relay 26.4.2 o posterior.
• --log-retention-days <days> : cambiar la retención de registros rotados. Mínimo 7; introduzca -1 para dejarlo sin cambios. Requiere el cliente de Relay 26.4.2 o posterior.
• --heartbeat-interval : cambia el intervalo de latidos. Mínimo 10; introduzca 0 para dejarlo sin cambios.
• --reconnect-interval : cambia el intervalo de reconexión proactiva. Mínimo 1800 (30 minutos) cuando se establece. Pulse 0 para deshabilitar, o -1 para dejarlo sin cambios.

registros de Relay

Mostrar salida de registro para un cliente de Relay.

• -f, --follow : transmite nuevas líneas de registro continuamente.
• -n, --lines <N> : número de líneas desde el final. Predeterminado 50.

lista de retransmisión

Mostrar todos los clientes de Relay en esta máquina con el estado, la versión, las marcas de tiempo de creación y actualización y el nombre del grupo cuando esté disponible. Los nombres de grupo largos se truncan en la salida de la tabla.

• --json : emiten salida JSON para automatización y creación de scripts, incluidos los nombres completos de los grupos.

Describir el Relay (Cliente de Relay 26.4.2 o posterior)

Muestra información detallada para un cliente de Relay, incluidos el ID y el nombre del grupo, el ID del secreto, el estado, la versión, el modo de servicio y la ruta ejecutable, los latidos configurados y los intervalos de reconexión, el nivel de registro, las rutas locales y las marcas de tiempo.

• --json : emiten una salida JSON para la automatización y la creación de scripts.

recargar el repetidor

Vuelve a obtener la configuración del proxy de Test Cloud y aplícala sin reiniciar. Úsalo como alternativa si un punto final recién añadido devuelve 404.

parada de relé

Detén el servicio de cliente de Relay. La configuración y las credenciales se conservan: el cliente de Relay se puede reiniciar más tarde.

Eliminar retransmisión

Detén el servicio, anula el registro de Test Cloud y elimina toda la configuración y credenciales locales.

• -f, --force : eliminar localmente sin cancelar el registro de Cloud. Utilízalo cuando las credenciales sean ilegibles o los recursos en la nube ya se hayan eliminado.

paquete de soporte de Relay [id]

Recopila un archivo anonimizado de configuración, registros y metadatos del sistema para un ticket de soporte de UiPath. Omite [id] para agrupar todos los clientes de Relay de la máquina. Las credenciales y las claves de cifrado nunca se incluyen. Para obtener más información, consulta Solución de problemas del Relay.

versión de Relay

Imprima la versión del cliente de Relay, la fecha de compilación y el hash de confirmación de Git.

Seguridad antivirus y de puntos finales

If your organization runs endpoint protection software, add exclusions for the relay binary and its data directory to prevent the Relay client from being blocked or quarantined. For Relay client 26.4.2 configurations that connect through cloud.uipath.com, allow cloud.uipath.com:443.

For Relay client versions earlier than 26.4.2, configure TLS-inspecting proxies, DLP appliances, and IDS/IPS systems to bypass inspection for <region>-relay.uipath.com:443.

Destination	Puerto	Protocolo	Acción
cloud.uipath.com	443	Https	Allow
<region>-relay.uipath.com	443	TLS	Permitir + omitir la inspección TLS para versiones de cliente de Relay anteriores a 26.4.2