diff --git a/docs/admin-panel/AllProjectsPage.mdx b/docs/admin-panel/AllProjectsPage.mdx index f70739a48..187308c14 100644 --- a/docs/admin-panel/AllProjectsPage.mdx +++ b/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`. diff --git a/docs/admin-panel/AllUsersPage.mdx b/docs/admin-panel/AllUsersPage.mdx index 15eb20f81..3867135b7 100644 --- a/docs/admin-panel/AllUsersPage.mdx +++ b/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`. diff --git a/docs/admin-panel/ServerSettings.mdx b/docs/admin-panel/ServerSettings.mdx new file mode 100644 index 000000000..c53e14ff2 --- /dev/null +++ b/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". + + + +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. + + + +When toggle is OFF: + +1. The "Invite User" and "Add User" buttons are displayed on the "All Users" page. + + + +2. 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. + + + +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. + + + +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. + + + +## 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. + + diff --git a/docs/admin-panel/img/server-settings/ServerSettings1.png b/docs/admin-panel/img/server-settings/ServerSettings1.png new file mode 100644 index 000000000..282dd9c73 Binary files /dev/null and b/docs/admin-panel/img/server-settings/ServerSettings1.png differ diff --git a/docs/admin-panel/img/server-settings/ServerSettings2.png b/docs/admin-panel/img/server-settings/ServerSettings2.png new file mode 100644 index 000000000..4d51cc0c1 Binary files /dev/null and b/docs/admin-panel/img/server-settings/ServerSettings2.png differ diff --git a/docs/admin-panel/img/server-settings/ServerSettings3.png b/docs/admin-panel/img/server-settings/ServerSettings3.png new file mode 100644 index 000000000..1b3fb237f Binary files /dev/null and b/docs/admin-panel/img/server-settings/ServerSettings3.png differ diff --git a/docs/admin-panel/img/server-settings/ServerSettings4.png b/docs/admin-panel/img/server-settings/ServerSettings4.png new file mode 100644 index 000000000..f485eec5c Binary files /dev/null and b/docs/admin-panel/img/server-settings/ServerSettings4.png differ diff --git a/docs/admin-panel/img/server-settings/ServerSettings5.png b/docs/admin-panel/img/server-settings/ServerSettings5.png new file mode 100644 index 000000000..dcb9b8e2e Binary files /dev/null and b/docs/admin-panel/img/server-settings/ServerSettings5.png differ diff --git a/docs/admin-panel/img/server-settings/ServerSettings6.png b/docs/admin-panel/img/server-settings/ServerSettings6.png new file mode 100644 index 000000000..4b912d7dd Binary files /dev/null and b/docs/admin-panel/img/server-settings/ServerSettings6.png differ diff --git a/docs/admin-panel/img/server-settings/ServerSettings7.png b/docs/admin-panel/img/server-settings/ServerSettings7.png new file mode 100644 index 000000000..57fc475aa Binary files /dev/null and b/docs/admin-panel/img/server-settings/ServerSettings7.png differ diff --git a/docs/admin-panel/img/server-settings/ServerSettings8.png b/docs/admin-panel/img/server-settings/ServerSettings8.png new file mode 100644 index 000000000..b3599b453 Binary files /dev/null and b/docs/admin-panel/img/server-settings/ServerSettings8.png differ diff --git a/docs/admin-panel/img/server-settings/ServerSettings9.png b/docs/admin-panel/img/server-settings/ServerSettings9.png new file mode 100644 index 000000000..7deab7f1d Binary files /dev/null and b/docs/admin-panel/img/server-settings/ServerSettings9.png differ diff --git a/docs/configuration/UserManagement.mdx b/docs/configuration/UserManagement.mdx index 6957addb7..55089ca01 100644 --- a/docs/configuration/UserManagement.mdx +++ b/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.