Skip to main content

Server Settings

In the Server Settings section, you can enable GitHub authorization, allowing users to sign in with their GitHub credentials. Additionally, you can configure the instance to allow login only through SSO and here you can enable or disable Google Analytics.

Authorization configuration​

Inactivity timeout​

ADMIN can configure session expiration per instance.

For that, the ADMIN needs to navigate to Administrate > Server Settings and set up the duration of user inactivity before automatic logout in 'Inactivity timeout' block:

  • 15 minutes
  • 1 hour
  • 12 hours
  • 24 hours (default value)

The user is logged out if their session inactivity exceeds the defined timeout.

If the user is working in multiple tabs and the inactivity timeout is reached in one tab while they are still active in another, the user remains logged in until the timeout is reached in all tabs.

GitHub​

To enable GitHub authorization:

  1. Log in as ADMIN.
  2. Go to Administrate > Server Settings.
  3. Switch ON the "GitHub authorisation" toggle.
  4. Fill in required parameters for authorization.
  5. Click "Submit".

Now you can access ReportPortal by clicking the "Login with GitHub" button on the login page.

Instance Invitations​

ADMIN can disable the possibility for manual invitation of external users. In such case, users can get access to ReportPortal via identity provider only (for example, SAML) configured on the instance.

The default state of toggle on "Instance Invitations" section is OFF.

When toggle is OFF:

  1. The "Invite User" and "Add User" buttons are displayed on the "All Users" page.
  1. The "Invite User" button is displayed on the "Project Members" page.

When toggle is ON, manual invitation of external is disabled:

  1. The "Invite User" and "Add User" buttons are removed from the "All Users" page.
  1. The "Invite User" button on the "Project Members" page has been changed to the "Assign User" button. Now, the Project Manager and Administrator can no longer invite new users to this project and instance; they can only assign existing users to this project.

To assign user on the project:

  1. Log in as Project Manager or ADMIN.
  2. Go to the "Project Members" page.
  3. Click the "Assign User" button.
  4. Start type the name > suggestions will be provided in the dropdown.

or

  1. Log in as ADMIN.
  2. Go to Administrate > "All Projects" page.
  3. Click on the ellipsis button on the project preview.
  4. Select the "Members" option.
  5. Click on the "Assign User" button.
  6. Start type the name > suggestions will be provided in the dropdown.

Features​

An admin can disable the "Important launches" functionality to better control storage usage and prevent launches from being stored indefinitely on the instance.

By default, the "Important launches" functionality is enabled on all instances. Users can then mark launches as important using the launch burger menu or report launch as important, and these launches can only be deleted manually or when storage limits are exceeded.

To turn off the "Important launches" functionality:

  1. Log in as an ADMIN.
  2. Navigate to Administrate > Server Settings > "Features" tab.
  3. Turn the toggle "Important launches" off.

When toggling "Important Launches" off:

  1. The "Mark as important" option is disabled on the launch burger menu, and there is a tooltip with an explanation.
  1. A background job runs to remove the "Important" flag from launches that were previously marked as important, converting them to regular launches and making them subject to the standard retention policy.
  2. If the toggle is off, then even if a user reports a launch with the system attribute retentionPolicy:important, the launch will not be marked as important and will still be subject to the standard retention policy.
  3. If you previously had important launches, then turned off the toggle, and later turn it back on, the old launches that were once marked as important will not become important again.

Analytics​

To turn on Google Analytics on ReportPortal UI:

  1. Log in as ADMIN.
  2. Go to Administrate > Server Settings.
  3. Go to Analytics tab.
  4. Check "Help make Report Portal better by automatically sending analytics to us" checkbox.
  5. Click on "Submit" button.

Links & Branding​

ADMIN can configure the necessary links in the footer of the application on the Server Settings > 'Links & Branding' tab.

By default, there are 2 links hardcoded on UI:

Next links are displayed by default, but can be changed:

Admin can add 5 links except 2 hardcoded links, so a maximum of 7 links can be displayed in footer.

To add a new footer link:

  1. Log in as ADMIN.
  2. Go to Administrate > Server Settings > 'Links & Branding' tab.
  3. Click the 'Add new' button.
  1. Provide Link name (from 3 to 30 characters).
  2. Provide URL or Email (from 3 to 1024 characters).
  3. Click the 'Save' button.

To delete footer link:

  1. Go to Administrate > Server Settings > 'Links & Branding' tab.
  2. Click on the 'Trash' icon.
  3. Click the 'Delete' button on the 'Delete link' modal.

To change the links order:

  1. Go to Administrate > Server Settings > 'Links & Branding' tab > 'Footer Links' section.
  2. Click on the drag-n-drop icon.
  3. Change the links order.

All added/updated links immediately displayed across all application pages after saving changes.

note

Footer links visibly differ on Project Settings Page compared to other pages.