UiPath Documentation
test-cloud
latest
false
Test Cloud-Administratorhandbuch
Wichtig :
Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

Bereitstellen des Relay-Clients unter Linux

Stellen Sie den Relay-Client als systemd-Dienst unter Linux bereit, um einen ausgehenden Tunnel zwischen Ihrem Netzwerk und Test Cloud zu erstellen.

This page covers production setup details specific to Linux. For cross-platform prerequisites and network requirements, see Deploying the Relay client.

Anforderungen des Betriebssystems

Der Relay-Client erfordert systemd 229 oder höher. Zu überprüfen: systemctl --version.

VerteilungMindestversion
Ubuntu20.04 LTS (Fokal)
Deian10 (Buser)
Red Hat Enterprise Linux8
Amazon Linux2023
SVerwenden Sie Linux Enterprise Server15
Oracle Linux8

Es wird erwartet, dass jede Linux-Distribution mit systemd 229+ funktioniert. Für Umgebungen ohne systemd kann der Relay-Client im Vordergrundmodus (--detach=false) ausgeführt werden, aber Sie sind für die Prozessverwaltung, den Autostart und die Wiederherstellung verantwortlich.

Erforderliche Berechtigungen: sudo -Stammzugriff ist erforderlich, um systemd-Dienste (/etc/systemd/system/) zu installieren, Standarddaten- und Protokollverzeichnisse zu erstellen und die Binärdatei nach /usr/local/bin/ zu kopieren. Informationen zu stammlosen Installationen finden Sie unter Benutzermodus.

Voraussetzungen

System

  • Unterstützte Linux-Distribution mit Systemd 229+
  • sudo -Zugriff (Stamm) – oder Sie planen die Verwendung --user-mode
  • Mindestens 200 MB freier Speicherplatz
  • If you use a supported TCP-based connection that requires the on-prem executor:

Netzwerk

  • Für den Relay-Client 26.4.2 oder höher ist ausgehendes HTTPS (Port 443) nach cloud.uipath.com zulässig, einschließlich WebSocket-Upgrades
  • Für Relay-Client-Versionen vor 26.4.2 ist ausgehendes TLS (Port 443) zu <region>-relay.uipath.com zulässig und TLS-Password ist konfiguriert
  • Relay host can resolve and connect to every registered HTTP or HTTPS endpoint, and to the host and port of each supported TCP-based endpoint

Sicherheit

  • konfigurierte SELinux-/AppARMor-/fapolicyd-Ausnahmen (falls zutreffend) – siehe Sicherheitsframeworks
  • If you use the on-prem executor: an administrator-owned dependencies directory and Java installation that no unprivileged account can write. The executor loads code from both, with the privileges of the Relay service account

Konfiguration

Validate prerequisites

Führen Sie die folgenden Befehle aus:

# Check systemd version (must be 229+)
systemctl --version

# Verify sudo access
sudo -v

# Check available disk space
df -h /var/lib

# Check Java version (must be 21+), only when using the on-prem executor
java -version
# Check systemd version (must be 229+)
systemctl --version

# Verify sudo access
sudo -v

# Check available disk space
df -h /var/lib

# Check Java version (must be 21+), only when using the on-prem executor
java -version

Installieren

1. Herunterladen und Extrahieren

Laden Sie das Relay-Client-Archiv für Ihre Architektur (x86_64 oder ARM64) aus dem UiPath Customer Portal herunter.

unzip relay_linux_amd64.zip && chmod +x relay
unzip relay_linux_amd64.zip && chmod +x relay

Starting with Relay client 26.4.3, the archive also contains onprem-executor.jar. Leave it next to the relay binary in the extracted directory, and run installation or upgrade commands from that directory.

2. Starten

Sie können die Client-Konfigurationszeichenfolge (über die UiPath-Verwaltung – siehe Konfigurieren einer Relay-Gruppe) auf zwei Arten bereitstellen:

Option A – Inline. Übergeben Sie die Konfigurationszeichenfolge direkt. Keine Datei zum Erstellen oder Bereinigen:

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

Option B – Datei. Speichern Sie die Konfiguration in einer Datei und verweisen Sie dann darauf. Empfohlen – hält das Geheimnis aus dem Shell-Verlauf heraus:

sudo ./relay start --config-file /path/to/config.txt --accept-license-agreement
sudo ./relay start --config-file /path/to/config.txt --accept-license-agreement

For a supported TCP-based connection that requires the on-prem executor, stage the connector libraries first, as described in Add connector dependencies, then start the client with a single command.

Add connector dependencies

Some connectors require third-party libraries that are not included with the Relay client. Obtain them from the connector vendor and place them all in a dedicated directory on the Relay host. The Relay client stores the directory path but does not copy the libraries.

Wichtig:

The on-prem executor loads and executes these libraries with the permissions of the Relay service account. Keep the directory, its parents, and every file in it owned and writable only by root, with read access for the service account. Anyone who can modify its contents can run code with those permissions.

For installations without root access, see On-prem executor in user mode.

For SAP BAPI, obtain the SAP JCo 3 libraries from SAP and place these files in the dependency directory:

Required fileZweck
sapjco3.jarSAP JCo Java library
sapidoc3.jarSAP IDoc Java library
libsapjco3.soSAP JCo Linux native library matching the Java runtime architecture

For another supported connector, place the vendor libraries listed in that connector's documentation in the same directory.

Start with the on-prem executor

Create the dependency directory, copy the libraries into it, and start the Relay client with the executor enabled. Point --onprem-executor-java-home at a Java 21 or later runtime, using an absolute path, so the executor uses the runtime you intend:

sudo ./relay start --config-file /path/to/config.txt \
  --accept-license-agreement \
  --enable-onprem-executor \
  --onprem-executor-java-home /usr/lib/jvm/java-21-openjdk \
  --onprem-executor-dep-dir /opt/uipath/relay/executor-deps
sudo ./relay start --config-file /path/to/config.txt \
  --accept-license-agreement \
  --enable-onprem-executor \
  --onprem-executor-java-home /usr/lib/jvm/java-21-openjdk \
  --onprem-executor-dep-dir /opt/uipath/relay/executor-deps
Hinweis:

Die Flags --config und --config-file schließen sich gegenseitig aus. Um im Vordergrund statt als Hintergrunddienst ausgeführt zu werden (nützlich für das Debuggen), übergeben Sie --detach=false.

Der Relay-Client validiert die Verbindung, authentifiziert sich bei OAuth, registriert sich bei der Test Cloud, lädt die Proxykonfiguration herunter, verschlüsselt Anmeldeinformationen und installiert einen systemd-Dienst – alles in einem einzigen Befehl.

Erwartete Ausgabe:

Running prerequisite checks...
  ✓ Directory permissions: OK
  ✓ Cloud portal connectivity: OK
✓ All prerequisite checks passed
Waiting for service to start...
  ✓ Service is running

✓ Relay is now running in the background.
Check status: systemctl status relay-<id>
Running prerequisite checks...
  ✓ Directory permissions: OK
  ✓ Cloud portal connectivity: OK
✓ All prerequisite checks passed
Waiting for service to start...
  ✓ Service is running

✓ Relay is now running in the background.
Check status: systemctl status relay-<id>
Hinweis:

Während des Starts kopiert der Relay-Client automatisch die Binärdatei nach /usr/local/bin/relay. Alle Relay-Gruppen auf der Maschine teilen sich diese einzelne Binärdatei. Überschreiben Sie das Installationsverzeichnis mit --bin-dir.

3. Überprüfen

relay list
relay list

Ein fehlerfreier Client zeigt ● running in der Spalte Status an. Der angezeigte ID -Wert wird in allen nachfolgenden Befehlen verwendet (relay stop <id>, relay logs <id> usw.). Sie finden sie auch in der UiPath-Verwaltung auf der Seite mit den Details zur Relay-Gruppe.

Bestätigen Sie, dass der Tunnel eingerichtet ist, indem Sie die Protokolle auf login to server success überprüfen:

sudo relay logs <id> -f
sudo relay logs <id> -f

If the on-prem executor is enabled, confirm its configuration:

sudo relay describe <id>
sudo relay describe <id>

The On-Prem Executor section reports Enabled: true with the listen port, runtime version, runtime path, Java home, and dependencies directory it is using. Check that the Java home and dependencies directory are the ones you intended.

Then confirm that the executor started. Its log contains a Started OnPremRuntimeApplication entry once it is ready:

sudo grep "Started OnPremRuntimeApplication" /var/log/uipath-relay/logs/<id>/onprem-executor.log
sudo tail -n 20 /var/log/uipath-relay/logs/<id>/onprem-executor.log
sudo grep "Started OnPremRuntimeApplication" /var/log/uipath-relay/logs/<id>/onprem-executor.log
sudo tail -n 20 /var/log/uipath-relay/logs/<id>/onprem-executor.log

If you configured a custom log directory, use its onprem-executor.log path instead. Then run a test call from the connector that uses this endpoint, to confirm the full path works.

Verwalten

Liste

Zeigt alle installierten Relay-Gruppen auf dieser Maschine mit Status, Version und Gruppenname an, wenn verfügbar. Erfordert nicht sudo.

relay list
relay list --json
relay list
relay list --json

Beschreiben

Hinweis:

Verfügbar mit Relay-Client 26.4.2 und höher. Führen Sie relay version aus, um Ihre installierte Version zu überprüfen.

Shows detailed information for one relay group, including service settings, configured paths, status, version, and group name when available. Does not require sudo. For a system service with the on-prem executor enabled, run it with sudo to include the executor version, which is read from the root-owned onprem-executor.jar.

relay describe <id>
relay describe <id> --json
relay describe <id>
relay describe <id> --json

Stoppen

Stoppt den Relay-Dienst. Konfiguration und Protokolle werden beibehalten – der Relay-Dienst kann später neu gestartet werden.

sudo relay stop <id>
sudo relay stop <id>

Neustart und Upgrade

Startet den Relay-Dienst neu und ruft die neueste Proxykonfiguration aus der Test Cloud ab.

sudo relay restart <id>
sudo relay restart <id>

Upgrade: extract the new Relay client archive. Keep the new relay binary and matching onprem-executor.jar together, then run sudo ./relay restart <id> from the extracted directory. The restart command updates the installed binary and, when the executor is enabled, its JAR.

To enable the executor on a service that is already installed, run sudo ./relay restart <id> --enable-onprem-executor from the extracted archive directory, so the matching onprem-executor.jar is available.

SzenarioBefehl
In der Test Cloud hinzugefügte oder entfernte Endpunktesudo relay restart <id>
Rotation des geheimen Clientschlüssels – inlinesudo relay restart --config "<new-config>"
Rotation des geheimen Clientschlüssels – Dateisudo relay restart --config-file /path/to/new-config.txt
Änderung der Protokollebenesudo relay restart <id> --log-level debug
Änderung des Protokollverzeichnisses oder der Aufbewahrungsudo relay restart <id> --logs-dir /opt/mycompany --log-retention-days 30
Enable the on-prem executorsudo ./relay restart <id> --enable-onprem-executor
Disable the on-prem executorsudo relay restart <id> --disable-onprem-executor
Relay client upgradeExtract the new archive, then run sudo ./relay restart <id>
Hinweis:

Wenn --config oder --config-file angegeben ist, ist das <id> -Argument optional – es wird aus der Konfiguration extrahiert.

Löschen

Stoppt den Dienst, meldet sich von der Test Cloud ab und entfernt alle lokalen Konfigurations- und Protokolldateien.

sudo relay delete <id>
sudo relay delete <id>

So erzwingen Sie die lokale Bereinigung ohne Cloud-Deregistrierung – z. B. wenn Anmeldeinformationen verloren gehen oder die cloudseitige Relay-Gruppe bereits gelöscht wurde:

sudo relay delete <id> --force
sudo relay delete <id> --force

Version

relay version
relay version
Hinweis:

There is no auto-upgrade. Extract the new archive and run sudo ./relay restart <id> from its directory for each group.

Verzeichnisstruktur

Alle Verzeichnisse werden bei der ersten Ausführung automatisch erstellt.

/usr/local/bin/
  relay                                      # Shared binary (755)

/var/lib/uipath-relay/                       # Data root (755)
  groups/<id>/
    client_config                            # OAuth credentials (encrypted, 600)
    metadata.json                            # State, PID, install timestamps (644)
    .credentials.key                         # AES-256-GCM encryption key (600)
    onprem-executor.jar                      # Executor runtime when enabled (600)

/var/log/uipath-relay/                       # Logs root (755)
  logs/<id>/
    relay.log                                # Current log (644)
    relay.YYYYMMDD-HHMMSS.log                # Rotated logs (644)
    onprem-executor.log                      # Executor log when enabled

/etc/systemd/system/
  relay-<id>.service                         # Systemd unit file
/usr/local/bin/
  relay                                      # Shared binary (755)

/var/lib/uipath-relay/                       # Data root (755)
  groups/<id>/
    client_config                            # OAuth credentials (encrypted, 600)
    metadata.json                            # State, PID, install timestamps (644)
    .credentials.key                         # AES-256-GCM encryption key (600)
    onprem-executor.jar                      # Executor runtime when enabled (600)

/var/log/uipath-relay/                       # Logs root (755)
  logs/<id>/
    relay.log                                # Current log (644)
    relay.YYYYMMDD-HHMMSS.log                # Rotated logs (644)
    onprem-executor.log                      # Executor log when enabled

/etc/systemd/system/
  relay-<id>.service                         # Systemd unit file

Dateiberechtigungen

PfadModeGrund
Verzeichnisse755Relay-Lese-/Schreibzugriff
client_config600Enthält verschlüsselte OAuth-Anmeldeinformationen
.credentials.key600AES-256-GCM-Verschlüsselungsschlüssel
metadata.json644Dienstmetadaten (Status, PID, Installationszeitstempel)
onprem-executor.jar600Executor runtime copied into protected service storage
relay.log644Für Fehlerbehebung lesbar
Binär755Ausführbar von systemd
Dependencies directory (executor only)755, owned by rootYou create it; the executor loads JARs and native libraries from it as code
Files in the dependencies directory644, owned by rootWrite access to any of them is code execution as the service account

The Relay client creates and maintains every path in this table except the dependencies directory. That one is yours to create and maintain: keep it, and everything in it, owned by root and writable only by root.

Benutzerdefinierte Pfade

Überschreiben Sie die Standardverzeichnisse beim Installieren des Relay-Clients.

sudo ./relay start --config-file /path/to/config.txt \
  --accept-license-agreement \
  --bin-dir /opt/mycompany/bin \
  --data-dir /opt/mycompany \
  --logs-dir /opt/mycompany
sudo ./relay start --config-file /path/to/config.txt \
  --accept-license-agreement \
  --bin-dir /opt/mycompany/bin \
  --data-dir /opt/mycompany \
  --logs-dir /opt/mycompany
MarkierenStandardBeschreibung
--bin-dir/usr/local/binVerzeichnis für die freigegebene Binärdatei
--data-dir/var/libStamm für Konfigurationsdaten
--logs-dir/var/logStamm für Protokolldateien; kann mit geändert werden restart

Der Relay-Client fügt uipath-relay/ unter den benutzerdefinierten Daten- und Protokollstammsätzen an:

--bin-dir  /opt/mycompany/bin  =>  /opt/mycompany/bin/relay
--data-dir /opt/mycompany      =>  /opt/mycompany/uipath-relay/groups/<id>/
--logs-dir /opt/mycompany      =>  /opt/mycompany/uipath-relay/logs/<id>/
--bin-dir  /opt/mycompany/bin  =>  /opt/mycompany/bin/relay
--data-dir /opt/mycompany      =>  /opt/mycompany/uipath-relay/groups/<id>/
--logs-dir /opt/mycompany      =>  /opt/mycompany/uipath-relay/logs/<id>/
Hinweis:

--bin-dir und --data-dir werden nur vom Befehl start akzeptiert. --logs-dir wird von start und restart akzeptiert. Andere Befehle (stop, delete, list) leiten Pfade automatisch von der Konfiguration des installierten Dienstes ab.

Proxykonfiguration

Wenn Ihr Netzwerk ausgehenden Datenverkehr über einen Proxy weiterleitet, exportieren Sie die Proxy-Umgebungsvariablen, bevor Sie relay start ausführen. Verwenden Sie sudo -E , um die Umgebung bei der Erhöhung zu erhalten:

export HTTPS_PROXY="http://proxy.corp.example.com:8080"
export NO_PROXY="localhost,127.0.0.1,.corp.example.com"
sudo -E ./relay start --config "<your-config>" --accept-license-agreement
export HTTPS_PROXY="http://proxy.corp.example.com:8080"
export NO_PROXY="localhost,127.0.0.1,.corp.example.com"
sudo -E ./relay start --config "<your-config>" --accept-license-agreement

Ohne -E setzt sudo die Umgebung zurück, und die Proxyeinstellungen gehen verloren.

Der Relay-Client schreibt die erfassten Proxy-Variablen als Environment= -Anweisungen in die Datei für die Systemeinheit, sodass der Hintergrunddienst sie verwendet – nicht systemübergreifend /etc/environment.

So aktualisieren Sie den Proxy nach der Installation: Exportieren Sie die neuen Werte und führen Sie sudo -E relay restart <id> aus.

So entfernen Sie den Proxy: unset HTTPS_PROXY HTTP_PROXY NO_PROXY und dann sudo relay restart <id>.

So überprüfen Sie, was der Dienst verwendet: systemctl cat relay-<id> | grep -i environment.

Unterstützte Proxyschemas und Authentifizierung finden Sie im Abschnitt Proxy unter Bereitstellen des Relay-Clients.

Sicherheitsframeworks

Wenn Ihre Umgebung SELinux, AppARMor oder fapolicyd verwendet, stellen Sie sicher, dass die Relay-Client-Binärdatei und ihre Datenverzeichnisse zulässig sind.

If you enable the on-prem executor, the Relay service also runs the Java executable and loads native libraries from the dependencies directory. Allow both, or the executor fails to start or cannot load its connector libraries.

SELinux

# Check enforcement mode
getenforce

# Relabel the binary if a custom policy blocks it
sudo semanage fcontext -a -t bin_t '/usr/local/bin/relay'
sudo restorecon -v /usr/local/bin/relay
# Check enforcement mode
getenforce

# Relabel the binary if a custom policy blocks it
sudo semanage fcontext -a -t bin_t '/usr/local/bin/relay'
sudo restorecon -v /usr/local/bin/relay

When the on-prem executor is enabled, the Relay service also runs the Java executable and loads native libraries from the dependencies directory. Label only the paths that generate denials. Check for denials first.

sudo ausearch -m AVC -ts recent | grep -i -e relay -e java
sudo ausearch -m AVC -ts recent | grep -i -e relay -e java

If the denials show the Java process refused read or map access to the dependencies directory, label the native libraries as shared libraries.

sudo semanage fcontext -a -t lib_t '/opt/uipath/relay/executor-deps(/.*\.so(\..*)?)?'
sudo restorecon -Rv /opt/uipath/relay/executor-deps
sudo semanage fcontext -a -t lib_t '/opt/uipath/relay/executor-deps(/.*\.so(\..*)?)?'
sudo restorecon -Rv /opt/uipath/relay/executor-deps

For any remaining denials, build a policy module rather than disabling enforcement.

sudo ausearch -m AVC -ts recent | audit2allow -M uipath-relay-executor
sudo semodule -i uipath-relay-executor.pp
sudo ausearch -m AVC -ts recent | audit2allow -M uipath-relay-executor
sudo semodule -i uipath-relay-executor.pp

AppARMor

Stellen Sie sicher, dass kein Profil /usr/local/bin/relay beim Netzwerkzugriff einschränkt oder Dateischreibvorgänge in /var/lib/uipath-relay/ oder /var/log/uipath-relay/ schreibt. Wenn Sie benutzerdefinierte Pfade verwenden, ersetzen Sie sie entsprechend.

If your organization confines local services with its own AppArmor profiles and the on-prem executor is enabled, the profile covering the Relay binary must also allow it to execute the Java runtime, and allow the Java process to read and map the connector libraries in the dependencies directory. Check for denials with sudo journalctl -k | grep -i apparmor.

fapolicyd

sudo fapolicyd-cli --file add /usr/local/bin/relay
sudo fapolicyd-cli --update
sudo fapolicyd-cli --file add /usr/local/bin/relay
sudo fapolicyd-cli --update

When the on-prem executor is enabled, fapolicyd must also trust the Java executable, the executor runtime JAR, and each connector library. A Java runtime installed from an archive rather than a distribution package is not in the package database and is untrusted by default; a packaged runtime such as java-21-openjdk needs no entry.

Trust each file individually.

sudo fapolicyd-cli --file add <java-home>/bin/java
sudo fapolicyd-cli --file add /var/lib/uipath-relay/groups/<id>/onprem-executor.jar
sudo fapolicyd-cli --file add /opt/uipath/relay/executor-deps/sapjco3.jar
sudo fapolicyd-cli --file add /opt/uipath/relay/executor-deps/sapidoc3.jar
sudo fapolicyd-cli --file add /opt/uipath/relay/executor-deps/libsapjco3.so
sudo fapolicyd-cli --update
sudo fapolicyd-cli --file add <java-home>/bin/java
sudo fapolicyd-cli --file add /var/lib/uipath-relay/groups/<id>/onprem-executor.jar
sudo fapolicyd-cli --file add /opt/uipath/relay/executor-deps/sapjco3.jar
sudo fapolicyd-cli --file add /opt/uipath/relay/executor-deps/sapidoc3.jar
sudo fapolicyd-cli --file add /opt/uipath/relay/executor-deps/libsapjco3.so
sudo fapolicyd-cli --update

Re-run fapolicyd-cli --file update <path> and fapolicyd-cli --update after any upgrade that replaces a trusted file: a Relay client upgrade, which replaces onprem-executor.jar, a Java upgrade, or a new connector library version. Trust entries record each file's size and hash, so they stop matching once a file changes. If the executor fails to start on a host running fapolicyd, check sudo journalctl -u fapolicyd -n 50.

Pfade, die zugelassen werden sollen

TypStandardpfad
Binär/usr/local/bin/relay
Daten/var/lib/uipath-relay/
Protokolle/var/log/uipath-relay/
Java executable (on-prem executor only)The java path resolved from PATH, or <java-home>/bin/java
Connector libraries (on-prem executor only)The directory passed to --onprem-executor-dep-dir

Wenn Sie --bin-dir, --data-dir oder --logs-dir verwendet haben, lassen Sie stattdessen diese benutzerdefinierten Pfade zu.

Benutzermodus

Der Benutzermodus (--user-mode) installiert den Relay-Client als systemd-Benutzerdienst anstelle eines Systemdiensts, sodass er ohne sudo ausgeführt werden kann. Dies ist für gemeinsam genutzte Maschinen und eingeschränkte Umgebungen geeignet, in denen kein Stammzugriff verfügbar ist.

Anforderungen

AnforderungenDetails
systemd 229+Überprüfen Sie: systemctl --version
BasisverzeichnisMuss vorhanden sein und dem Zielbenutzer gehören
systemd-BenutzersitzungÜberprüfen: systemctl --user is-system-running gibt running oder degradedzurück
SSH-AnmeldungErforderlich – su / sudo su stellen nicht die D-Business-Sitzung bereit, die die Benutzerdienste benötigen
loginctl lingerErforderlich, damit der Dienst nach der Abmeldung bestehen bleibt und beim Booten gestartet wird

Aktivieren Sie die Linging-Aktivität (einmalig, erfordert Administrator):

sudo loginctl enable-linger <username>
sudo loginctl enable-linger <username>

Ohne Linger Benutzerdienste werden angehalten, wenn Sie sich abmelden, und werden beim Booten nicht gestartet.

Starten Sie im Benutzermodus

./relay start --user-mode --config-file /path/to/config.txt --accept-license-agreement
./relay start --user-mode --config-file /path/to/config.txt --accept-license-agreement

On-prem executor in user mode

In user mode the executor runs as your user account instead of root, and the same executor flags apply:

./relay start --user-mode --config-file /path/to/config.txt \
  --accept-license-agreement \
  --enable-onprem-executor \
  --onprem-executor-java-home <java-home> \
  --onprem-executor-dep-dir <dep-dir>
./relay start --user-mode --config-file /path/to/config.txt \
  --accept-license-agreement \
  --enable-onprem-executor \
  --onprem-executor-java-home <java-home> \
  --onprem-executor-dep-dir <dep-dir>

The dependencies directory must not be group- or world-writable. If an administrator is available, have them create it owned by root with read access for your account, so no unprivileged account can change what the executor loads. Otherwise, create it yourself with chmod 0755 on the directory and 0644 on the files.

Verzeichnislayout im Benutzermodus

~/.local/bin/
  relay                                      # Shared binary (755)

~/.local/share/uipath-relay/
  groups/<id>/
    client_config                            # OAuth credentials (encrypted, 600)
    metadata.json                            # Service metadata (644)
    .credentials.key                         # Encryption key (600)
    onprem-executor.jar                      # Executor runtime when enabled (600)
  logs/<id>/
    relay.log
    relay.YYYYMMDD-HHMMSS.log
    onprem-executor.log                      # Executor log when enabled

~/.config/systemd/user/
  relay-<id>.service                         # Systemd user unit file
~/.local/bin/
  relay                                      # Shared binary (755)

~/.local/share/uipath-relay/
  groups/<id>/
    client_config                            # OAuth credentials (encrypted, 600)
    metadata.json                            # Service metadata (644)
    .credentials.key                         # Encryption key (600)
    onprem-executor.jar                      # Executor runtime when enabled (600)
  logs/<id>/
    relay.log
    relay.YYYYMMDD-HHMMSS.log
    onprem-executor.log                      # Executor log when enabled

~/.config/systemd/user/
  relay-<id>.service                         # Systemd user unit file

Der Pfad ~/.config/systemd/user/ kann nicht überschrieben werden. Binär-, Daten- und Protokollpfade können mit --bin-dir, --data-dir und --logs-dir angepasst werden.

Verwaltungsbefehle im Benutzermodus

Alle Befehle funktionieren ohne sudo:

relay list
relay stop <id>
relay restart <id>
relay delete <id>
relay logs <id> -f
relay list
relay stop <id>
relay restart <id>
relay delete <id>
relay logs <id> -f

Wann der Benutzermodus verwendet werden soll

SzenarioEmpfohlen
Produktionsserver mit StammzugriffSystemmodus (Standard)
Freigegebene Maschine, kein StammzugriffBenutzermodus
Entwicklung oder TestsBenutzermodus
Sicherheitssensible UmgebungenSystemmodus ( Manipulationssicherer Binärpfad)

Deinstallieren

  1. Alle Relay-Clients löschen ( relay list verwenden, um installierte Gruppen anzuzeigen):

    sudo relay delete <id>
    sudo relay delete <id>
    
  2. Entfernen Sie die freigegebene Binärdatei:

    sudo rm /usr/local/bin/relay
    sudo rm /usr/local/bin/relay
    
  3. Entfernen Sie verbleibende Daten- und Protokollverzeichnisse:

    sudo rm -rf /var/lib/uipath-relay /var/log/uipath-relay
    sudo rm -rf /var/lib/uipath-relay /var/log/uipath-relay
    

Ersetzen Sie für den Benutzermodus die Befehle durch die Benutzermodus-Äquivalente (kein sudo) und entfernen Sie ~/.local/bin/relay und ~/.local/share/uipath-relay.

Fehlersuche und ‑behebung

SymptomeUrsacheResolution
Dienst kann nicht gestartet werdenUnzureichende BerechtigungenAusführen mit sudo
permission deniedVerzeichnisse können nicht erstellt werdenÜberprüfen Sie den sudo -Zugriff oder verwenden Sie benutzerdefinierte Pfade zu einem beschreibbaren Speicherort
systemctl: command not foundsystemd nicht installiertVerwenden Sie den Vordergrundmodus (--detach=false) oder installieren Sie systemd
Der Dienst wird gestartet und dann sofort angehaltenKonfigurations- oder NetzwerkfehlerPrüfen Sie relay.log auf Startfehler
Dienst wird ausgeführt, aber Tunnel nicht eingerichtetNetzwerk- oder AuthentifizierungsproblemPrüfen Sie relay.log auf login to server Fehler; Überprüfen Sie die Verbindung zu cloud.uipath.com; Überprüfen Sie bei Relay-Client-Versionen vor 26.4.2 den TLS-Passdurchlauf zum regionalen Relay-Hostnamen
SELinux oder AppARMor blockiert die AusführungSicherheitsframeworkrichtlinieSiehe Sicherheitsframeworks
XDG_RUNTIME_DIR not found (Benutzermodus)Nicht über SSH angemeldetMelden Sie sich über SSH an, oder aktivieren Sie die Linger-Aktivität
D-Bus session bus unreachable (Benutzermodus)Nicht über SSH angemeldetMelden Sie sich über SSH an, oder aktivieren Sie die Linger-Aktivität
Proxy wird vom Dienst nicht verwendetVariable beim Start nicht erfasstMit sudo -E erneut ausführen oder mit systemctl cat relay-<id> | grep -i environmentüberprüfen
Hohe CPU oder hohe ArbeitsspeicherProtokollebene auf trace oder debugfestgelegtLegen Sie die Protokollebene auf info oder höher fest

Diagnosebefehle

# Real-time logs
sudo relay logs <id> -f

# Systemd journal
journalctl -u relay-<id> -f

# Service status
systemctl status relay-<id>

# Connectivity test
nc -zv cloud.uipath.com 443

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

# Check if binary is blocked by SELinux
sudo ausearch -m AVC -ts recent

# Check AppArmor status
sudo aa-status
# Real-time logs
sudo relay logs <id> -f

# Systemd journal
journalctl -u relay-<id> -f

# Service status
systemctl status relay-<id>

# Connectivity test
nc -zv cloud.uipath.com 443

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

# Check if binary is blocked by SELinux
sudo ausearch -m AVC -ts recent

# Check AppArmor status
sudo aa-status

Informationen zu Authentifizierungs- und Verbindungsfehlern, die plattformübergreifend genutzt werden, finden Sie unter Fehlerbehebung.

Schnellreferenz

AktionBefehl
Startensudo relay start --config-file config.txt --accept-license-agreement
Stoppensudo relay stop <id>
Neustart/Upgradesudo relay restart <id>
Löschensudo relay delete <id>
Löschen (erzwingen)sudo relay delete <id> --force
Listerelay list
Beschreibenrelay describe <id>
Protokollerelay logs <id> -f
Status des Dienstessystemctl status relay-<id>
Systemd-Judgejournalctl -u relay-<id> -f

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben