diff --git a/docs/log-data-in-reportportal/test-framework-integration/Other/index.md b/docs/log-data-in-reportportal/test-framework-integration/Other/index.md index 794893b6b..16abd10d8 100644 --- a/docs/log-data-in-reportportal/test-framework-integration/Other/index.md +++ b/docs/log-data-in-reportportal/test-framework-integration/Other/index.md @@ -4,13 +4,12 @@ sidebar_position: 6 # Other -Please find the full list of available integrations with test frameworks in our [GitHub repositories](https://github.com/reportportal). +ReportPortal is an open-source test automation reporting tool with a public API. -If you need further guidelines, you can explore our [Developers guides](/developers-guides). +Some integrations with test frameworks are developed and maintained by the ReportPortal team, while others are created and supported by external contributors. If you don’t see your test framework listed in our documentation or repositories, try searching on GitHub. Additionally, you can ask within your framework’s community - someone there might be able to guide you on integrating it with ReportPortal. -What you can do if you can not find your Test Framework? -You can create custom integrations. To get started, please look at our [Implement own Integration](/log-data-in-reportportal/ImplementOwnIntegration) page. +What can you do if you cannot find your test framework? You can create custom integrations! To get started, please visit our [Implement own integration page](/log-data-in-reportportal/ImplementOwnIntegration/). :::note -We offer paid support for new or existing integrations. If you need more details, please send an email to support@reportportal.io. +We offer paid support for new or existing integrations. For more details, please [contact us](https://reportportal.io/contact-us/general/). ::: diff --git a/docs/plugins/authorization/SamlProviders/_category_.json b/docs/plugins/authorization/SamlProviders/_category_.json index f4026c028..a61c8fdfc 100644 --- a/docs/plugins/authorization/SamlProviders/_category_.json +++ b/docs/plugins/authorization/SamlProviders/_category_.json @@ -1,6 +1,4 @@ { "label": "SAML Providers", - "link": { - "type": "generated-index" - } + "link": {"type": "doc", "id": "index"} } diff --git a/docs/plugins/authorization/SamlProviders/index.md b/docs/plugins/authorization/SamlProviders/index.md new file mode 100644 index 000000000..3c1e93b50 --- /dev/null +++ b/docs/plugins/authorization/SamlProviders/index.md @@ -0,0 +1,13 @@ +# SAML Providers + +The **SAML Providers** category in ReportPortal enables efficient and secure user authentication using popular SAML providers like Azure SAML and Okta SAML. These services allow ReportPortal to connect seamlessly with existing identity management frameworks, making login processes faster and more reliable while meeting enterprise-grade security standards. + +When using Azure SAML as an authentication provider, users can log in with the credentials they already use within their organization. This setup offers a single sign-on (SSO) experience, making access management more efficient and reducing the need for password resets. Similarly, Okta SAML leverages Okta’s identity management platform to facilitate secure and simple login. With Okta SAML, ReportPortal users can also enjoy SSO functionality, boosting productivity and providing robust identity verification for consistent security. + +Setting up SAML-based authentication in ReportPortal is simple, with dedicated configuration options for Azure and Okta in the settings menu. Each guide offers step-by-step instructions to ensure a quick and accurate setup, allowing teams to link their ReportPortal accounts with their chosen provider easily. This flexibility in choosing an SSO provider simplifies access to the platform and reduces administrative overhead. + +By using SAML Providers like Azure SAML and Okta SAML, organizations can ensure that access to their test reporting and analytics remains secure, streamlined, and aligned with existing identity management policies, ultimately providing a more cohesive and productive user experience. + +import DocCardList from '@theme/DocCardList'; + + diff --git a/docs/plugins/authorization/_category_.json b/docs/plugins/authorization/_category_.json index cdce1e373..8a8b5918c 100644 --- a/docs/plugins/authorization/_category_.json +++ b/docs/plugins/authorization/_category_.json @@ -1,7 +1,5 @@ { "label": "Authorization", "position": "2", - "link": { - "type": "generated-index" - } + "link": {"type": "doc", "id": "index"} } diff --git a/docs/plugins/authorization/index.md b/docs/plugins/authorization/index.md new file mode 100644 index 000000000..9e190b166 --- /dev/null +++ b/docs/plugins/authorization/index.md @@ -0,0 +1,23 @@ +# Authorization + +The **Authorization section** in ReportPortal provides detailed guidance on supported methods for user authentication, offering secure and streamlined access management within your test automation reporting dashboard. ReportPortal supports multiple authorization options, including Active Directory, GitHub, LDAP, and SAML providers like Azure SAML and Okta SAML, allowing teams to choose the method that best integrates with their existing security infrastructure. + +**Active Directory** + +For organizations using Microsoft’s Active Directory (AD), ReportPortal provides an integration that allows users to authenticate using their AD credentials. This method leverages the organization’s current user management system, ensuring secure access control and reducing the need for additional login information. By logging in with their AD credentials, users can access ReportPortal in alignment with the organization’s security policies. + +**GitHub** + +ReportPortal also supports GitHub-based authentication, allowing users to sign in with their GitHub credentials. This is particularly useful for teams managing code repositories and workflows on GitHub, providing a seamless login experience and reducing the need for separate credentials. GitHub authentication simplifies access management for developers, enabling quick, direct entry into the test report dashboard. + +**LDAP** + +ReportPortal’s LDAP integration enables authentication through an organization’s existing directory, making it ideal for teams with established LDAP setups. This method links ReportPortal to company directory services, providing centralized user management and enhanced security by allowing users to sign in quickly with their directory credentials. + +**SAML Providers** + +ReportPortal supports SAML authentication through Azure SAML and Okta SAML. These integrations enable users to authenticate via a central identity provider, which simplifies access control across multiple platforms. Azure SAML and Okta SAML provide single-click access to ReportPortal through an organization’s SSO setup, which both reduces password fatigue and aligns with enterprise security standards. This method is particularly valuable for larger teams managing numerous tools and applications within their tech ecosystem. + +import DocCardList from '@theme/DocCardList'; + + diff --git a/docs/saved-searches-filters/FiltersPage.md b/docs/saved-searches-filters/FiltersPage.md index 07e566011..a69c89071 100644 --- a/docs/saved-searches-filters/FiltersPage.md +++ b/docs/saved-searches-filters/FiltersPage.md @@ -5,20 +5,29 @@ sidebar_label: Filters page # Filters page -You can see the list of your saved searches and filters created by other team members on the "Filters" page. +The **Filters page** in ReportPortal is a dedicated space for managing and organizing saved searches, providing a clear and accessible overview of all filters. This page shows your personal filters, making it easy to streamline test data access and focus on relevant information. -The following information is present on the "Filters" page: +The Filters page includes several key details for each filter: -- Filter name and description -- Options: criteria of search -- Owner: the user who created the filter -- Display on launches: ON/OFF switcher -- Delete option +- **Filter name and description**
+ Each filter is labeled with a clear name and often a brief description, helping users quickly identify its purpose. -To open launches based on saved filter, click the link of filter's name. The filter will be opened as a tab on the "Launches" page. +- **Options**
+ Here, you’ll find the search criteria defined for each filter, showing how data will be sorted or prioritized when this filter is used. -It is the only place where it is possible to delete the filter from our test report&analytics dashboard. +- **Owner**
+ The name of the team member who created the filter is displayed. -To do this, click the 'delete' icon of your filter and confirm the action. The filter will be deleted but not launches in it. +- **Display on launches toggle**
+ This ON/OFF switch determines if the filter should be readily available on the Launches page. Activating this option makes the filter easily accessible for all users, while deactivating it keeps the filter private. + +- **Delete option**
+ Each filter has a delete icon, allowing users to remove unnecessary filters if no longer needed. + +To open launches based on a saved filter, click on the filter’s name. This action will open a new tab on the Launches page, pre-filtered according to the selected criteria, simplifying navigation through large datasets. + +This Filters page is the only location where filters can be permanently deleted from test automation results dashboard. To delete a filter, simply click the delete icon associated with it and confirm the action. Note that while this will remove the filter, it will not delete the test launches or results associated with it. + +By using the filters efficiently, you can improve test data organization, focus on specific issues or milestones, and better align test reporting with your project’s evolving requirements. diff --git a/docs/user-account/RestoreAPassword.mdx b/docs/user-account/RestoreAPassword.mdx index 6b54ef1a8..f1d939d02 100644 --- a/docs/user-account/RestoreAPassword.mdx +++ b/docs/user-account/RestoreAPassword.mdx @@ -5,20 +5,33 @@ sidebar_label: Restore a password # Restore a password -If you forgot your password, you can restore it on the login page. To do that, perform the following steps: +The **Restore a password page** in ReportPortal offers a simple process for users who may have forgotten their password and need to regain access to their account quickly. -1. Click the "Forgot your password?" link on the login page. +:::note +GitHub user cannot restore the password on ReportPortal. +::: -2. Enter your email in the form that appears and click the "Change Password" - button. The password recovery instructions will be sent to your email. +To start the password reset process, follow these steps: -3. Follow the link from the email. The Restore Password form will appear. +1. Navigate to the login page
+ On the ReportPortal login page, you’ll see a link labeled "Forgot password?". -4. Fill in the restore password form and click the "Change Password" button. Now you can log in ReportPortal with the new -credentials. +2. Click the "Forgot password?" link
+Selecting this link will open the password recovery form, which prompts you to enter the email address associated with your ReportPortal account. - +3. Enter your email address
+Type in the email address that you registered with on ReportPortal, ensuring there are no typos. Once entered, click the "Send email" button. -:::note -GitHub user cannot restore the password on ReportPortal. -::: +4. Check your email for password recovery instructions
+After submitting your email, a message will be sent to your inbox with instructions to proceed. + +5. Follow the recovery link in the email
+Open the email, which will contain a secure link to reset your password. Clicking on this link will redirect you to the ReportPortal "Change password" form. + +6. Complete the "Change password" form
+Enter your new password in the form, taking care to choose a strong, unique password for security. Confirm the new password and click "Change password" to save it. + +7. Log in with your new password
+With your password successfully updated, you can now return to the login page and sign in with your new credentials. + + diff --git a/docs/user-role-guides/img/PermissionMap.png b/docs/user-role-guides/img/PermissionMap.png new file mode 100644 index 000000000..c39294627 Binary files /dev/null and b/docs/user-role-guides/img/PermissionMap.png differ diff --git a/docs/user-role-guides/index.md b/docs/user-role-guides/index.md index d0927acb9..41ffd17d0 100644 --- a/docs/user-role-guides/index.md +++ b/docs/user-role-guides/index.md @@ -4,7 +4,24 @@ sidebar_label: User role guides --- # User role guides -Here are the links to User Guide sections divided by ReportPortal User roles. + +All accounts in ReportPortal are divided into two types according to **instance-level classification**: + +- Administrator +- Regular user + +In addition, each account in ReportPortal has a specific role on a project according to **project-level classification**: + +- Project Manager +- Member +- Operator +- Customer + +An account with the "Administrator" type has permission to configure the entire instance and access all projects. + +You can check the permissions for each other role on the Project Members page. + + ## Administrator [Installation steps](/installation-steps) diff --git a/docusaurus.config.js b/docusaurus.config.js index f1875deff..5e9bcfde4 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -301,7 +301,7 @@ const config = { from: ['/installation-steps/DeployWithDockerOnLinuxMac', '/Deploy-with-Docker', '/installation-steps/DeployWithDockerOnWindows'], }, { - to: '/category/saml-providers', + to: '/plugins/authorization/SamlProviders', from: ['/reportportal-configuration/authorization/SAMLProvider', '/SAML-integration'], }, { @@ -357,7 +357,7 @@ const config = { from: '/Sauce-Labs-integration', }, { - to: '/category/authorization', + to: '/plugins/authorization', from: '/reportportal-configuration/authorization', }, { @@ -536,6 +536,14 @@ const config = { to: '/installation-steps-advanced/ScalingReportPortalServices', from: '/installation-steps-advanced/ScalingUpReportPortalAPIService', }, + { + to: '/plugins/authorization', + from: '/category/authorization', + }, + { + to: '/plugins/authorization/SamlProviders', + from: '/category/saml-providers', + }, ], }, ],