Skip to content

Commit

Permalink
EPMRPP-96968 || Add Server Settings documentation (#843)
Browse files Browse the repository at this point in the history
Co-authored-by: Yuliya_Prihodko <[email protected]>
  • Loading branch information
pressayuliya and Yuliya_Prihodko authored Dec 11, 2024
1 parent 2395334 commit a94545a
Show file tree
Hide file tree
Showing 13 changed files with 100 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/admin-panel/AllProjectsPage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ To modify project settings please refer to [Project Settings](/configuration/Pro

## Invite user on "All Projects" page

:::info
Depending on the toggle state in [Server Settings](/admin-panel/ServerSettings), the ability to manually invite external users to ReportPortal can be disabled.
:::

To invite a user to a project on "All Projects" page, perform the following steps:

1. Login into the ReportPortal instance as an `Administrator`.
Expand Down
8 changes: 8 additions & 0 deletions docs/admin-panel/AllUsersPage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ ReportPortal allows to create a new user account on the "All Users" page in the

## Add user

:::info
Depending on the toggle state in [Server Settings](/admin-panel/ServerSettings), the ability to manually invite external users to ReportPortal can be disabled.
:::

To add a user on the "All Users" page, perform the following steps:

1. Login into ReportPortal instance as `Administrator`.
Expand Down Expand Up @@ -56,6 +60,10 @@ Please, do not forget to review project roles on regular basis. We recommend to

## Invite user on the "All Users" page

:::info
Depending on the toggle state in [Server Settings](/admin-panel/ServerSettings), the ability to manually invite external users to ReportPortal can be disabled.
:::

To invite a user on the "All Users" page, perform the following steps:

1. Login into ReportPortal instance as `Administrator`.
Expand Down
84 changes: 84 additions & 0 deletions docs/admin-panel/ServerSettings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
sidebar_position: 4
sidebar_label: Server Settings
---

# 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

### GitHub

To enable [GitHub authorization](/plugins/authorization/GitHub/):

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](/plugins/authorization/GitHub#reportportal-configuration).
5. Click "Submit".

<MediaViewer src={require('./img/server-settings/ServerSettings1.png')} alt="Enable GitHub authorization in our test automation dashboard" />

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

### Instance Invitations

Administrator 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.

<MediaViewer src={require('./img/server-settings/ServerSettings2.png')} alt="Toggle on Instance Invitations section" />

When toggle is OFF:

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

<MediaViewer src={require('./img/server-settings/ServerSettings3.png')} alt="All Users page when toggle is OFF" />

2. The "Invite User" button is displayed on the "Project Members" page.

<MediaViewer src={require('./img/server-settings/ServerSettings4.png')} alt="Project Members page when toggle is OFF" />

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.

<MediaViewer src={require('./img/server-settings/ServerSettings5.png')} alt="All Users page when toggle is ON" />

2. 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.

<MediaViewer src={require('./img/server-settings/ServerSettings6.png')} alt="Project Members page when toggle is ON" />

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.

<MediaViewer src={require('./img/server-settings/ServerSettings7.png')} alt="Assign user on the project on the Project Members page" />

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.

<MediaViewer src={require('./img/server-settings/ServerSettings8.png')} alt="Assign user on the project on the Members page" />

## Analytics

To turn on [Google Analytics](/terms-and-conditions/GoogleAnalyticsUsageByReportPortal/) 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.

<MediaViewer src={require('./img/server-settings/ServerSettings9.png')} alt="turn on Google Analytics on our test automation results dashboard" />
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/configuration/UserManagement.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ User with `ADMINISTRATOR` role and users with project role `PROJECT_MANAGER`.

### Invite user on a project

:::info
Depending on the toggle state in [Server Settings](/admin-panel/ServerSettings), the ability to manually invite external users to ReportPortal can be disabled.
:::

To invite a user on the "Project Members" page, perform the following steps:

1. Login into ReportPortal instance as with the `PROJECT_MANAGER` project role.
Expand Down

0 comments on commit a94545a

Please sign in to comment.