-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
EPMRPP-96968 || Add Server Settings documentation (#843)
Co-authored-by: Yuliya_Prihodko <[email protected]>
- Loading branch information
1 parent
2395334
commit a94545a
Showing
13 changed files
with
100 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters