- スタート アップ ガイド
- データのセキュリティとコンプライアンス
- 組織
- 認証とセキュリティ
- ライセンス
- テナントとサービス
- アカウントとロール
- AI Trust Layer
- 外部アプリケーション
- 通知
- ログ
- データ エクスポート
- 組織でのテスト
- トラブルシューティング
- Test Cloud に移行する
Relay クライアントを Linux に systemd サービスとしてデプロイし、ネットワークと Test Cloud 間の送信トンネルを確立します。
このページでは、Linux に固有の運用設定について説明します。クロスプラットフォームの前提条件とネットワーク要件については、「 Relay クライアントをデプロイする」をご覧ください。
オペレーティング システムの要件
Relay クライアントには systemd 229 以降が必要です。確認するには、以下の手順を実行します。 systemctl --version。
| 分布 | 最小バージョン |
|---|---|
| Ubuntu | 20.04 LTS (フォーカル) |
| Debian | 10(バスター) |
| Red Hat Enterprise Linux | 8 |
| Amazon Linux | 2023 年 |
| SUSE Linux Enterprise Server | 15 |
| Oracle Linux | 8 |
systemd 229+ を搭載した Linux ディストリビューションであれば、すべて動作することが期待されます。systemd のない環境では、リレークライアントはフォアグラウンドモード (--detach=false) で実行できますが、プロセス管理、自動起動、およびリカバリはユーザーが担当します。
必要な権限: systemd サービス (/etc/systemd/system/) をインストールし、デフォルトのデータディレクトリとログディレクトリを作成し、バイナリを /usr/local/bin/にコピーするには、sudo (root) アクセスが必要です。ルートレス インストールの場合は、「 ユーザー モード」をご覧ください。
前提条件
システム
- systemd 229+ でサポートされる Linux ディストリビューション
sudo(root) アクセス権があるか、使用する予定--user-mode- 最小 200 MB の空きディスク領域
- オンプレミスの Executor を必要とする、サポートされている TCP ベースの接続を使用する場合、以下を実行します。
- ホストと Executor の推奨キャパシティを確認します
- Java 21 以降の JRE または JDK (
PATH上にあるか、--onprem-executor-java-homeで渡されます。既存のインストールは機能します。
ネットワーク
- Relay クライアント
26.4.2以降では、cloud.uipath.comへの送信 HTTPS (ポート 443) が許可されます。これには WebSocket のアップグレードも含まれます 26.4.2より前のリレー クライアント バージョンでは、<region>-relay.uipath.comへの送信 TLS (ポート 443) が許可され、TLS パススルーが構成されます- Relay ホストは、登録されているすべての HTTP または HTTPS エンドポイント、およびサポートされている各 TCP ベースのエンドポイントのホストとポートを解決して接続できます
セキュリティ
- SELinux / AppArmor / fapolicyd 除外が設定されている (該当する場合) ( セキュリティフレームワーク を参照)
- オンプレミスの Executor を使用する場合: 管理者が所有する依存関係ディレクトリと、特権のないアカウントは書き込めない Java インストールExecutor は、Relay サービス アカウントの権限で、両方からコードを読み込みます
構成
- Relay グループが作成され、クライアント設定文字列が準備完了 ( Relay グループの設定を参照)
前提条件を検証する
次のコマンドを実行します:
# Check systemd version (must be 229+)
systemctl --version
# Verify sudo access
sudo -v
# Check available disk space
df -h /var/lib
# On-prem executor only: Java 21+ on PATH, or pass --onprem-executor-java-home
java -version
# Check systemd version (must be 229+)
systemctl --version
# Verify sudo access
sudo -v
# Check available disk space
df -h /var/lib
# On-prem executor only: Java 21+ on PATH, or pass --onprem-executor-java-home
java -version
インストール
1. ダウンロードして抽出する
UiPath Customer Portal から、使用しているアーキテクチャ (x86_64 または ARM64) 向けの Relay クライアント アーカイブをダウンロードします。
unzip relay_linux_amd64.zip && chmod +x relay
unzip relay_linux_amd64.zip && chmod +x relay
Relay クライアント 26.4.3以降、アーカイブには onprem-executor.jarも含まれます。このファイルを、抽出したディレクトリ内の relay バイナリの横に置いておき、そのディレクトリからインストール コマンドまたはアップグレード コマンドを実行します。
2. 開始
クライアント設定文字列 ( UiPath Administration で生成。「Relay グループを設定する」の説明を参照) は次の 2 つの方法で指定できます。
オプション A: インライン。構成文字列を直接渡します。作成またはクリーンアップするファイルがない:
sudo ./relay start --config "<your-config>" --accept-license-agreement
sudo ./relay start --config "<your-config>" --accept-license-agreement
オプション B: ファイル。構成をファイルに保存してから参照します。これは、シェル履歴にシークレットが記載されないようにするため、推奨されるオプションです。
sudo ./relay start --config-file /path/to/config.txt --accept-license-agreement
sudo ./relay start --config-file /path/to/config.txt --accept-license-agreement
オンプレミスの Executor を必要とするサポート対象の TCP ベースの接続の場合は、「 コネクタ依存関係を追加する」の説明に従い、最初にコネクタ ライブラリをステージングしてから、単一のコマンドでクライアントを起動します。
コネクタの依存関係を追加する
一部のコネクタでは、Relay クライアントに含まれていないサードパーティ ライブラリが必要です。コネクタ ベンダーから入手し、Relay ホストの専用ディレクトリにすべて配置します。Relay クライアントはディレクトリ パスを格納しますが、ライブラリはコピーしません。
オンプレミスの Executor は、Relay サービス アカウントの権限でこれらのライブラリを読み込んで実行します。ディレクトリとその親、およびその中のすべてのファイルは、サービス アカウントに対する読み取りアクセス権を持つ rootによってのみ所有および書き込み可能にします。その内容を変更できる人は誰でも、これらのアクセス許可でコードを実行できます。
ルート アクセスのないインストールの場合は、「 ユーザー モードのオンプレミス Executor」をご覧ください。
SAP BAPI の場合は、SAP から SAP JCo 3 ライブラリを取得し、次のファイルを依存関係ディレクトリに配置します。
| 必要なファイル | 目的 |
|---|---|
sapjco3.jar | SAP JCo Java ライブラリ |
sapidoc3.jar | SAP IDoc Java ライブラリ |
libsapjco3.so | Java ランタイムアーキテクチャに適合する SAP JCo Linux ネイティブライブラリ |
サポートされている別のコネクタの場合は、そのコネクタのドキュメントに記載されているベンダー ライブラリを同じディレクトリに配置します。
オンプレミスの Executor から始めます
依存関係ディレクトリを作成し、そこにライブラリをコピーして、Executor を有効化した状態で Relay クライアントを起動します。絶対パスを使用して Java 21 以降のランタイムで --onprem-executor-java-home をポイントし、Executor が目的のランタイムを使用するようにします。
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
--config フラグと --config-file フラグは相互に排他的です。バックグラウンド サービスとしてではなくフォアグラウンドで実行する (デバッグに便利) には、 --detach=falseを渡します。
Relay クライアントは、接続の検証、OAuth による認証、Test Cloud への登録、プロキシ構成のダウンロード、資格情報の暗号化、systemd サービスのインストールのすべてを 1 つのコマンドで行います。
期待される出力:
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>
起動時に、Relayクライアントはバイナリを自動的に /usr/local/bin/relayにコピーします。マシン上のすべてのリレー グループは、この 1 つのバイナリを共有します。インストール ディレクトリを --bin-dirで上書きします。
3. 確認する
relay list
relay list
正常なクライアントでは、STATUS 列に ● running が表示されます。表示される ID 値は、後続のすべてのコマンド (relay stop <id>、 relay logs <id>など) で使用されます。また、UiPath Administration の [リレー グループの詳細] ページにもアクセスできます。
ログで次の login to server successを確認して、トンネルが確立されていることを確認します。
sudo relay logs <id> -f
sudo relay logs <id> -f
オンプレミス Executor が有効化されている場合は、その構成を確認します。
sudo relay describe <id>
sudo relay describe <id>
[ オンプレミス実行 者] セクションでは、リッスン ポート、ランタイム バージョン、ランタイム パス、Java ホーム、および使用している依存関係ディレクトリとともに Enabled: true が報告されます。Java のホーム ディレクトリと依存関係ディレクトリが意図したディレクトリであることを確認します。
次に、Executor が起動したことを確認します。そのログには、準備ができると Started OnPremRuntimeApplication エントリが含まれます。
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
カスタム ログ ディレクトリを構成した場合は、代わりにその onprem-executor.log パスを使用します。次に、このエンドポイントを使用するコネクタからテスト呼び出しを実行して、フル パスが機能することを確認します。
管理
リスト (List)
このマシンにインストールされているすべてのリレー グループを、ステータス、バージョン、およびグループ名とともに表示します (使用可能な場合)。sudoは必要ありません。
relay list
relay list --json
relay list
relay list --json
説明を入力
Relay クライアント 26.4.2 以降で使用できます。relay versionを実行して、インストールされているバージョンを確認します。
1 つのリレー グループの詳細情報 (サービス設定、設定されたパス、ステータス、バージョン、グループ名 (利用可能な場合) などが表示されます。sudoは必要ありません。オンプレミスの Executor が有効化されているシステム サービスの場合は、 sudo を使用して実行し、ルートが所有する onprem-executor.jarから読み取る Executor のバージョンを含めます。
relay describe <id>
relay describe <id> --json
relay describe <id>
relay describe <id> --json
停止
リレー サービスを停止します。構成とログは保持されます。リレーは後で再起動できます。
sudo relay stop <id>
sudo relay stop <id>
再起動してアップグレードする
Relay サービスを再起動し、Test Cloud から最新のプロキシ構成を取得します。
sudo relay restart <id>
sudo relay restart <id>
アップグレード: 新しい Relay クライアント アーカイブを展開します。新しい relay のバイナリと一致する onprem-executor.jar を一緒に保持してから、抽出されたディレクトリから sudo ./relay restart <id> を実行します。restart コマンドは、インストールされたバイナリを更新し、Executor が有効になっている場合はその JAR を更新します。
すでにインストールされているサービスで Executor を有効化するには、展開されたアーカイブ ディレクトリから sudo ./relay restart <id> --enable-onprem-executor を実行して、一致する onprem-executor.jar が利用可能になるようにします。
| シナリオ | コマンド |
|---|---|
| Test Cloud でのエンドポイントの追加または削除 | sudo relay restart <id> |
| クライアント シークレットのローテーション (インライン) | sudo relay restart --config "<new-config>" |
| クライアント シークレットのローテーション (ファイル) | sudo relay restart --config-file /path/to/new-config.txt |
| ログ レベルの変更 | sudo relay restart <id> --log-level debug |
| ログ ディレクトリまたは保持期間の変更 | sudo relay restart <id> --logs-dir /opt/mycompany --log-retention-days 30 |
| オンプレミスの Executor を有効化する | sudo ./relay restart <id> --enable-onprem-executor |
| オンプレミスの Executor を無効化する | sudo relay restart <id> --disable-onprem-executor |
| Relay クライアントのアップグレード | 新しいアーカイブを展開してから、 sudo ./relay restart <id> |
--configまたは --config-file を指定する場合、<id>引数は任意です。構成から抽出されます。
削除する
サービスを停止して Test Cloud から登録を解除し、ローカルの設定ファイルとログ ファイルをすべて削除します。
sudo relay delete <id>
sudo relay delete <id>
クラウドで登録を解除せずにローカル クリーンアップを強制するには (たとえば、資格情報を失った場合や、クラウド側のリレー グループがすでに削除されている場合):
sudo relay delete <id> --force
sudo relay delete <id> --force
バージョン
relay version
relay version
自動アップグレードはありません。新しいアーカイブを抽出し、各グループに対してそのディレクトリから sudo ./relay restart <id> を実行します。
ディレクトリ構造
すべてのディレクトリは、最初の実行時に自動的に作成されます。
/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
ファイルのアクセス許可
| パス | モード | 理由 |
|---|---|---|
| ディレクトリ | 755 | 読み取り/書き込みアクセスをリレーする |
client_config | 600 | 暗号化された OAuth 資格情報が含まれます |
.credentials.key | 600 | AES-256-GCM 暗号化キー |
metadata.json | 644 | サービス メタデータ (状態、PID、インストールのタイムスタンプ) |
onprem-executor.jar | 600 | Executor ランタイムが保護されたサービス ストレージにコピーされた |
relay.log | 644 | トラブルシューティングが容易 |
| バイナリ | 755 | systemdによる実行可能 |
| 依存関係ディレクトリ (Executor のみ) | 755、所有 root | あなたがそれを作成します。Executor は、そこから JAR とネイティブ ライブラリをコードとして読み込みます |
| 依存関係ディレクトリ内のファイル | 644、所有 root | これらのいずれかへの書き込みアクセスは、サービス アカウントとしてのコード実行です |
Relay クライアントは、このテーブル内の依存関係ディレクトリを除くすべてのパスを作成および保守します。それはあなたのものを作成し、維持します:それとその中のすべてを保持し、 root が所有し、 rootのみが書き込むことができます。
カスタム パス
Relay クライアントのインストール時にデフォルトディレクトリを上書きします。
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
| フラグ | 既定 (Default) | 説明 |
|---|---|---|
--bin-dir | /usr/local/bin | 共有バイナリのディレクトリ |
--data-dir | /var/lib | 構成データのルート |
--logs-dir | /var/log | ログ ファイルのルート。で変更できます restart |
リレークライアントは、カスタムデータルートとログルートの下に uipath-relay/ を追加します。
--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>/
--bin-dir と --data-dir は、 start コマンドでのみ受け付けられます。--logs-dir は start および restartによって受け入れられます。その他のコマンド (stop、 delete、 list) は、インストールされているサービス構成から自動的にパスを派生させます。
プロキシ構成
ネットワークで送信トラフィックがプロキシ経由でルーティングされる場合は、relay startを実行する前にプロキシ環境変数をエクスポートしてください。sudo -E を使用して、昇格時に環境を保護します。
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
-Eを使用しない場合、sudo は環境をリセットし、プロキシ設定は失われます。
Relay クライアントは、キャプチャしたプロキシ変数を Environment= ディレクティブとして systemd unit ファイルに書き込むため、バックグラウンド サービスはシステム全体の /etc/environmentではなくそれらを使用します。
インストール後にプロキシを更新するには: 新しい値をエクスポートして [ sudo -E relay restart <id>] を実行します。
プロキシを削除するには、unset HTTPS_PROXY HTTP_PROXY NO_PROXY、次にsudo relay restart <id>します。
サービスが使用するものを確認するには、以下の手順を実行します。 systemctl cat relay-<id> | grep -i environment.
サポートされているプロキシスキームと認証については、 リレークライアントのデプロイのプロキシセクションを参照してください。
セキュリティ フレームワーク
環境で SELinux、AppArmor、または fapolicy d を使用している場合は、Relay クライアントバイナリとそのデータディレクトリが許可されていることを確認してください。
オンプレミスの Executor を有効化すると、Relay サービスは Java 実行可能ファイルも実行し、依存関係ディレクトリからネイティブ ライブラリを読み込みます。両方を許可しないと、Executor が起動に失敗するか、コネクタ ライブラリを読み込めません。
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
オンプレミスの Executor が有効化されている場合、Relay サービスは Java 実行可能ファイルも実行し、依存関係ディレクトリからネイティブ ライブラリを読み込みます。拒否が生成されたパスにのみラベルを付けます。最初に拒否を確認します。
sudo ausearch -m AVC -ts recent | grep -i -e relay -e java
sudo ausearch -m AVC -ts recent | grep -i -e relay -e java
拒否の結果、Java プロセスが依存関係ディレクトリへの読み取りまたはマップ アクセスを拒否されたことが示される場合は、ネイティブ ライブラリに共有ライブラリとしてラベルを付けます。
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
拒否が残っている場合は、適用を無効化するのではなく、ポリシー モジュールを構築します。
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
App Armor
/usr/local/bin/relayネットワークアクセスや /var/lib/uipath-relay/ や /var/log/uipath-relay/へのファイル書き込みを制限するプロファイルがないことを確認します。カスタム パスを使用する場合は、それに応じて置換します。
組織がローカル サービスを独自の AppArmor プロファイルで制限し、オンプレミスの Executor が有効になっている場合、Relay バイナリをカバーするプロファイルでは、その Java ランタイムの実行も許可し、Java プロセスが依存関係ディレクトリ内のコネクタ ライブラリを読み取ってマッピングできるようにする必要があります。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
オンプレミスの Executor が有効化されている場合、fapolicyd は Java 実行可能ファイル、Executor ランタイム JAR、および各コネクタ ライブラリも信頼する必要があります。配布パッケージではなくアーカイブからインストールされた Java ランタイムはパッケージ データベースに存在せず、デフォルトでは信頼されていません。 java-21-openjdk などのパッケージ化されたランタイムには、エントリは不要です。
各ファイルを個別に信頼します。
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
信頼できるファイルを置き換えるアップグレード (Relay クライアントのアップグレード (onprem-executor.jarを置き換える Relay クライアントのアップグレード、Java のアップグレード、または新しいコネクタ ライブラリ バージョン) が実行された後に、fapolicyd-cli --file update <path>を再実行してfapolicyd-cli --updateします。信頼エントリには各ファイルのサイズとハッシュが記録されるため、ファイルが変更されると一致しなくなります。fapolicyd を実行しているホストで Executor を起動できない場合は、 sudo journalctl -u fapolicyd -n 50を確認してください。
許可するパス
| 入力 | 既定のパス |
|---|---|
| バイナリ | /usr/local/bin/relay |
| データ | /var/lib/uipath-relay/ |
| ログ | /var/log/uipath-relay/ |
| Java 実行可能ファイル (オンプレミスの Executor のみ) | PATH、または から解決されたjava パスです<java-home>/bin/java |
| コネクタ ライブラリ (オンプレミスの Executor のみ) | 渡されるディレクトリ --onprem-executor-dep-dir |
--bin-dir、--data-dir、または --logs-dirを使用した場合は、代わりにこれらのカスタム パスを許可します。
ユーザー モード
ユーザーモード (--user-mode) は、リレークライアントをシステムサービスではなく systemd ユーザーサービス としてインストールし、 sudoなしで実行できるようにします。これは、ルートアクセスが利用できない共有マシンや制限された環境に適しています。
要件
| 要件 | 詳細 |
|---|---|
| systemd 229+ | 次のコマンドを確認します。 systemctl --version |
| ホーム ディレクトリ | ターゲット ユーザーが存在し、所有している必要があります |
| systemd ユーザー セッション | Verify: systemctl --user is-system-running は running または degraded を返します。 |
| SSH ログイン | 必須。su / sudo su は、ユーザーサービスが必要とするD-Busセッションを提供しません |
loginctl linger | ログアウト後もサービスを維持し、起動時に開始するために必要です |
リンガーを有効にする (1 回限り、管理者が必要):
sudo loginctl enable-linger <username>
sudo loginctl enable-linger <username>
リンガーがない場合、ユーザー サービスはログアウト時に停止し、起動時に開始されません。
ユーザー モードで開始
./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
ユーザー モードのオンプレミス Executor
ユーザー モードでは、Executor は ではなくユーザー アカウントとして実行され root同じ Executor フラグが適用されます。
./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>
依存関係ディレクトリは、グループまたはワールド書き込み可能であってはなりません。管理者が空いている場合は、自分のアカウントに対する読み取りアクセス権を持つ root が所有する管理者を作成してもらい、権限のないアカウントが Executor に読み込む内容を変更できないようにします。それ以外の場合は、 ディレクトリに chmod 0755 し、 ファイルに 0644 して自分で作成します。
ユーザー モードのディレクトリ レイアウト
~/.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
~/.config/systemd/user/パスは上書きできません。バイナリ、データ、およびログのパスは、 --bin-dir、 --data-dir、および --logs-dirでカスタマイズできます。
ユーザー モードでの管理コマンド
すべてのコマンドは 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
ユーザー モードを使用する状況
| シナリオ | 推奨仕様 |
|---|---|
| ルートアクセス権を持つ本番サーバー | システム モード (既定) |
| 共有マシン、ルート アクセスなし | ユーザー モード |
| 開発またはテスト | ユーザー モード |
| セキュリティが重視される環境 | システムモード(改ざん防止バイナリパス) |
アンインストール
-
すべてのRelayクライアントを削除します(
relay listを使用して、インストールされているグループを表示します)。sudo relay delete <id>sudo relay delete <id> -
共有バイナリを削除します。
sudo rm /usr/local/bin/relaysudo rm /usr/local/bin/relay -
残りのデータ ディレクトリとログ ディレクトリを削除します。
sudo rm -rf /var/lib/uipath-relay /var/log/uipath-relaysudo rm -rf /var/lib/uipath-relay /var/log/uipath-relay
ユーザー モードの場合は、コマンドを同等のユーザー モード ( sudoなし) に置き換え、 ~/.local/bin/relay と ~/.local/share/uipath-relayを削除します。
トラブルシューティング
| 症状 | 原因 | 解決方法 |
|---|---|---|
| サービスの開始に失敗する | 権限が不十分である | 次で実行 sudo |
permission denied | ディレクトリを作成できない | sudoアクセスを確認するか、書き込み可能な場所へのカスタム パスを使用します |
systemctl: command not found | systemd がインストールされていない | フォアグラウンドモード(--detach=false)を使用するか、systemdをインストールします |
| サービスが開始された後、すぐに停止します | 構成またはネットワーク エラー | 起動エラーがないか relay.log を確認する |
| サービスは実行されていますが、トンネルが確立されていません | ネットワークまたは認証の問題 | relay.loglogin to serverエラーがないか確認します。cloud.uipath.comへの接続を確認します。26.4.2より前の Relay クライアント バージョンの場合、リージョンのリレー ホスト名への TLS パススルーを確認します |
| SELinux または AppArmor による実行のブロック | セキュリティ フレームワーク ポリシー | 詳しくは、「セキュリティ フレームワーク」をご覧ください |
XDG_RUNTIME_DIR not found (ユーザー モード) | SSH 経由でログインしていない | SSH 経由でログインするか、linger を有効にします |
D-Bus session bus unreachable (ユーザー モード) | SSH 経由でログインしていない | SSH 経由でログインするか、linger を有効にします |
| プロキシがサービスで使用されていない | 変数が開始時にキャプチャされない | sudo -Eで再実行するか、systemctl cat relay-<id> | grep -i environment で検証します |
| CPU またはメモリの使用率が高い | ログ レベルを trace または debug に設定 | ログ レベルを info 以上に設定します |
診断コマンド
# 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
プラットフォーム間で共有される認証エラーと接続エラーについては、「 トラブルシューティング」を参照してください。
クイック リファレンス
| 操作 | コマンド |
|---|---|
| 先頭 | sudo relay start --config-file config.txt --accept-license-agreement |
| 停止 | sudo relay stop <id> |
| 再起動/アップグレード | sudo relay restart <id> |
| 削除する | sudo relay delete <id> |
| 削除 (強制) | sudo relay delete <id> --force |
| リスト (List) | relay list |
| 説明を入力 | relay describe <id> |
| ログ | relay logs <id> -f |
| サービスのステータス | systemctl status relay-<id> |
| Systemdジャーナル | journalctl -u relay-<id> -f |
- オペレーティング システムの要件
- 前提条件
- システム
- ネットワーク
- セキュリティ
- 構成
- 前提条件を検証する
- インストール
- 1. ダウンロードして抽出する
- 2. 開始
- 3. 確認する
- 管理
- リスト (List)
- 説明を入力
- 停止
- 再起動してアップグレードする
- 削除する
- バージョン
- ディレクトリ構造
- ファイルのアクセス許可
- カスタム パス
- プロキシ構成
- セキュリティ フレームワーク
- Selinux
- App Armor
- fapolicyd
- 許可するパス
- ユーザー モード
- 要件
- ユーザー モードで開始
- ユーザー モードのオンプレミス Executor
- ユーザー モードのディレクトリ レイアウト
- ユーザー モードでの管理コマンド
- ユーザー モードを使用する状況
- アンインストール
- トラブルシューティング
- 診断コマンド
- クイック リファレンス