Merge pull request #844 from reportportal/rc/24.2.2

Release 24.2.2 docs updates

docs/admin-panel/AllProjectsPage.mdx

@@ -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`.

docs/admin-panel/AllUsersPage.mdx

@@ -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`.
@@ -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`.

docs/admin-panel/ServerSettings.mdx

@@ -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" />

docs/configuration/UserManagement.mdx

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

docs/features/SCIMServerFeature.md

@@ -0,0 +1,35 @@
+---
+sidebar_position: 8
+sidebar_label: SCIM Server feature
+---
+
+# SCIM Server feature
+
+SCIM is a protocol that simplifies how you manage user identities and access across various applications and services. It automates the sharing of user identity information between your identity provider (like Azure AD or Okta) and service providers, such as ReportPortal.
+
+ReportPortal includes a SCIM Server that acts as a bridge between your identity provider and ReportPortal, streamlining the management of user accounts.
+
+**Benefits**
+
+* Reduced administrative work: Automating the creation and removal of user accounts helps eliminate manual errors and saves time.
+* Enhanced security: SCIM ensures that security policies and access controls are consistently applied across different systems.
+* Improved user experience: Users are automatically assigned to projects and roles based on their group memberships in the identity provider.
+
+**Key Features**
+
+* Automated Account Setup: SCIM allows for the automatic creation of user accounts in ReportPortal, complete with project and role assignments.
+* Flexible Account Types: Users can be designated as Admins or Regular Users in ReportPortal.
+* Dynamic Updates: Changes in the identity provider trigger updates in account type and project assignments in ReportPortal.
+* Account De-provisioning: Supports both "soft" delete (disabling accounts) and "hard" delete (removing accounts).
+
+**Group Management**
+
+Both user and application groups are recognized as sources for project membership. Group names in the identity provider must follow a specific pattern set on the SCIM Server to correctly update project and role assignments in ReportPortal. This involves a regular expression pattern that identifies the project name and role from the group name.
+
+**Default Roles**
+
+A default project role can be assigned to users who don't have a specific role pattern in their group membership on the Identity Provider side.
+
+:::note
+The SCIM server feature is a premium offering from ReportPortal, available as part of our paid support services. We provide assistance with both the identity provider settings and the SCIM Server configuration.<br />
+If you're interested in enabling SCIM for your setup, please [contact us](https://reportportal.io/contact-us/general) for more information.