DocumentationRelease Notes
Log In
Documentation

Configuration

What is the Configuration page?

The Configuration page provides settings for customizing the Privileged Remote Access experience, including interface preferences, notification settings, and session behavior configurations.

How is it useful to my organization?

This page allows users to tailor support tools to fit their workflow, enhancing efficiency and delivering a streamlined support experience aligned with organizational requirements.

How do I access the Configuration page?

  1. Use a Chromium-based browser to sign in to your Privileged Remote Access URL.
    This URL is provided in the BeyondTrust welcome email and includes your site URL followed by /login.
  2. From the left menu, click Configuration.
    The Options page opens and displays by default.

Options

Use options to manage connection options, record sessions, speed up sessions

Session options

Require closed sessions on logout or quit

If you check Require Closed Sessions on Logout or Quit, users will be unable to log out of the console if they currently have any session tabs open.

Connection options

Reconnect timeout

Determine how long a disconnected endpoint client should attempt to reconnect.

Restrict physical access to the endpoint if the endpoint loses its connection or if all of the users in session are disconnected

If the session connection is lost, the remote system's mouse and keyboard input can be temporarily disabled, resuming either when the connection is restored or when the session is terminated.

Access session logging options

Enable screen sharing recording

Choose if screen sharing sessions should be automatically recorded as videos.

Screen sharing recording resolution

Set the resolution at which to view session recording playback.

ℹ️

Note

All recordings are saved in raw format; the resolution size affects playback only.

Enable user recording for Protocol Tunnel Jump

Choose if Protocol Tunnel Jump sessions should be automatically recorded as videos. Because Protocol Tunnel Jumps require the use of a third-party application of choice, the user's entire desktop is captured, including all monitors.

User recording resolution

Set the resolution at which to view session recording playback.

ℹ️

Note

All recordings are saved in raw format; the resolution size affects playback only.

Require user's consent before recording starts

Choose if users should receive a prompt telling them that their desktop will be recorded when beginning a Protocol Tunnel Jump session. Please note that if the user does not consent, Protocol Tunnel Jump session will not continue.

Enable command shell recording

Choose if command shell sessions should be automatically recorded as videos. Enabling command shell recordings also enables command shell sessions to be available as text transcripts.

Command shell recording resolution

Set the resolution at which to view session recording playback.

ℹ️

Note

All recordings are saved in raw format; the resolution size affects playback only.

⚠️

Important

The recording settings enabled on this page can be overridden by a Jump Policy that has Disable Session Recordings selected. This affects screen sharing, Protocol Tunnel Jump recording, and command shell recordings.

Enable automatic logging of system information

Choose if system information should be automatically pulled from the remote system at the beginning of the session, to be available later in the session report details.

Enable session forensics

Choose if you want the added capability to search across all sessions based on session events, which include chat messages, file transfer, registry editor events, and session foreground window changed events. This feature is enabled by default.

ℹ️

Note

If Command Shell is enabled, Session Forensics allows you to do an in-depth search of shell recordings. When you search for a key term and a match is made in a stored shell recording, the video will automatically be queued to that point in time in the recording. No command output or passwords are recorded.

Peer to peer options

Enabling peer-to-peer connections for access sessions enhances the performance of screen sharing, file transfer, and command shell tools. Additional firewall configuration might be required to successfully establish peer-to-peer connections.

Disabled

This is the default setting. Disables Peer to Peer connections. To enable this feature, you must choose a server to negotiate the session. When screen sharing, file transfer, or command shell is detected, the peer-to-peer connection is attempted. If successful, this creates a direct connection between the user and the client systems, while still sending a second data stream to the B Series Appliance for auditing purposes. If for any reason a peer-to-peer connection cannot be established, the session traffic defaults to the B Series Appliance-mediated connection.

Use BeyondTrust hosted peer to peer server

BeyondTrust clients attempt to reach a peer-to-peer connection through the server hosted by BeyondTrust. This requires that your BeyondTrust clients can make outbound UDP 3478 connection requests to stun.bt3ng.com. This setting is expected to work in most situations.

Access portal logo

Administrators may upload a custom logo image to be displayed on public-facing web pages. This allows external users to verify they are on your organization's web site, as well as enhancing the access portal with your organization's branding.

The logo image is displayed on the following public-facing web pages:

  • Access invite download page (the page shown after clicking a link in an access invite email)
  • Public recording URLs (view and download)
  • Extended availability responses (the page shown after clicking a link in an extended availability invitation email)
  • Jump approval authorizations (the page shown after clicking a link in a Jump approval email)

ℹ️

Note

Uploaded logo image files may be in any standard image format. The logical image size maximum is 250 pixels wide and 64 pixels high. However, BeyondTrust supports high density displays which allows for a maximum physical size of 500 pixels wide and 128 pixels high.


©2003-2025 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.