Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/dashboard/accounts/2fa.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ On the first step, we offer a list of popular authentication apps Bugsee can wor

![](2fa-step-2.png)

On the next step, Bugsee provides the information to configure your authentication application to work with Bugsee. Open you app and scan the shown QR code or manually specify the key if your app does not support QR codes.
On the next step, Bugsee provides the information to configure your authentication application to work with Bugsee. Open your app and scan the shown QR code or manually specify the key if your app does not support QR codes.

![](2fa-step-3.png)

Now, when you have configured your authentication application, it's time to check whether it was configured properly. Provide the verification token you authentication application is displaying for Bugsee on the next step.
Now, when you have configured your authentication application, it's time to check whether it was configured properly. Provide the verification token your authentication application is displaying for Bugsee on the next step.

![](2fa-step-4.png)

Expand Down
4 changes: 2 additions & 2 deletions docs/dashboard/accounts/sso/instructions/config-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Navigate to the SSO within your AWS console and switch to _Applications_ section

![](aws-step-1.png)

Now Click _"Add a new application"_ and then click _"Add a custom SAML 2.0 application "_.
Now Click _"Add a new application"_ and then click _"Add a custom SAML 2.0 application"_.

![](aws-step-2.png)

Expand All @@ -35,6 +35,6 @@ As the next step, you need to configure attributes mapping to let SSO work. Swit
You can read more about possible attribute values [here](https://docs.aws.amazon.com/singlesignon/latest/userguide/attributemappingsconcept.html?icmpid=docs_sso_console).
:::

Copy the attribute names. You must provide the same names in the Bugsee SSO setup wizard dialog when prompted. Also, as _"Format"_ for _"Subject"_ use _"emailAddress"_ and for the rest fields use _"uri"_.
Copy the attribute names. You must provide the same names in the Bugsee SSO setup wizard dialog when prompted. Also, as _"Format"_ for _"Subject"_ use _"emailAddress"_ and for the remaining fields use _"uri"_.

That's all the steps required to configure SSO in AWS console. Complete the configuration of SSO in Bugsee and you're all set.
2 changes: 1 addition & 1 deletion docs/dashboard/accounts/sso/instructions/config-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: "/dashboard/accounts/sso/instructions/config-azure"

## Configuration

Navigate to your Azure. In the search bar at the top, type "Enterprise applications" and select the corresponding item.
Navigate to your Azure portal. In the search bar at the top, type "Enterprise applications" and select the corresponding item.

![](azure-step-0.png?v=2)

Expand Down
6 changes: 3 additions & 3 deletions docs/dashboard/accounts/sso/instructions/config-jumpcloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Set **Bugsee** as the _"Display label"_ field value and optionally pick the colo

![](jumpcloud-step-3.png)

Once upload completes, some of the fields will be populated automatically as shown. Notice, that _"IDP Entity ID_" is not filled. Just copy and paste the value from _"SP Entity ID"_ to _"IDP Entity ID_".
Once upload completes, some of the fields will be populated automatically as shown. Notice that _"IDP Entity ID"_ is not filled. Just copy and paste the value from _"SP Entity ID"_ to _"IDP Entity ID"_.

![](jumpcloud-step-4.png)

Next, we need to configure **user** attributes. They will contain information about the user being authenticated and must match to the values specified in the _"Fields Map_" step in Bugsee SSO setup wizard. Follow the visual instructions below.
Next, we need to configure **user** attributes. They will contain information about the user being authenticated and must match the values specified in the _"Fields Map"_ step in Bugsee SSO setup wizard. Follow the visual instructions below.

![](jumpcloud-step-5.png)

Expand All @@ -33,7 +33,7 @@ Remember and/or make note of the attributes' names you've used. We will need the
You can read more about user attributes available in JumpCloud in their [Knowledge base article](https://support.jumpcloud.com/s/article/configuring-user-attributes-for-saml-connectors-2019-08-21-10-36-47)
:::

Now, make sure _"Sign assertion_" is not checked and _"Declare redirect endpoint"_ is, on the contrary, is checked. Fill in _"IdP-initiated URL"_ **only** if you want to force the _"SP-initiated authentication SSO"_ (Bugsee supports both SP- and IdP-initiated authentication SSO). As the last segment in _"IdP URL"_ put "bugsee".
Now, make sure _"Sign assertion"_ is not checked and _"Declare redirect endpoint"_ is, on the contrary, checked. Fill in _"IdP-initiated URL"_ **only** if you want to force the _"SP-initiated authentication SSO"_ (Bugsee supports both SP- and IdP-initiated authentication SSO). As the last segment in _"IdP URL"_ put "bugsee".

![](jumpcloud-step-6.png)

Expand Down
4 changes: 2 additions & 2 deletions docs/dashboard/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Filters area contains all the possible set of fields eligible to be used as sear

![Search text compare options](search_text_compare_options.png)

Sometimes, you want to persist you search criteria to reuse at a later time. "Saved filters" were designed exactly for that. If you want to save you search criteria and reuse it later, just click "Save" in the right side of the search bar. Provide meaningful name for the search criteria you're about to save and click "Save" inside the popup. Now, you will see the saved search criteria in the "Saved filters" dropdown whenever you open it.
Sometimes, you want to persist your search criteria to reuse at a later time. "Saved filters" were designed exactly for that. If you want to save your search criteria and reuse it later, just click "Save" on the right side of the search bar. Provide a meaningful name for the search criteria you're about to save and click "Save" inside the popup. Now, you will see the saved search criteria in the "Saved filters" dropdown whenever you open it.

![Saved filters](search_saved_filters.png)

If you want some criteria to be applied by default, you can click at star icon in the corresponding row within the list of saved configurations. As you may guessed, clicking at the trash icon will let you delete the assigned configuration.
If you want some criteria to be applied by default, you can click the star icon in the corresponding row within the list of saved configurations. As you may have guessed, clicking the trash icon will let you delete the assigned configuration.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Using Bugsee on mobile devices requires installation of Bugsee lightweight SDK:
* [Installing iOS SDK](/sdk/ios/installation/)
* [Installing Android SDK](/sdk/android/installation/)
* [Installing Cordova SDK](/sdk/cordova/installation/)
* [Installing React Native Module](/sdk/react_native/installation/)
* [Installing React Native SDK](/sdk/react_native/installation/)
* [Installing Flutter SDK](/sdk/flutter/installation/)
* [Installing Unity SDK](/sdk/unity/installation/)
* [Installing KMP SDK (Beta)](/sdk/kmp/installation/)
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ All authentication types imply that you have access to the remote service you're

This authentication type requires username and password of the user on whose behalf you want Bugsee to perform related activities in remote service. This is the simplest and quickest way to configure integration, as it relies on existing authentication data, but is also the least secure of all available methods.

We do not apply any limitations to both username and password. All the validation is done within remote service that actually uses them to identify user.
We impose no restrictions on username or password. All the validation is done within remote service that actually uses them to identify user.

:::info
We strongly recommend creating a dedicated user when basic authentication is used.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: "/integrations/configuration"

## Overview

We've designed the setup flow for integrations to be based upon wizards with sets of simple steps. Mostly integration flows have similar steps sequence, but there can be some discrepancies as requirements differ from one integration to another.
We've designed the setup flow for integrations to be based upon wizards with sets of simple steps. Most integration flows have a similar sequence of steps, but there can be some discrepancies as requirements differ from one integration to another.

The absolute minimal set of steps is (they do not correlate with wizard titles):

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/recipes/recipes_issues.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Terminating app due to uncaught exception 'NSInvalidArgumentException', reason:

If we pass that string to a service that pre-formats text using Markdown, then we potentially will lose some of the characters from that line (e.g. asterisks will be treated as bold triggers and will not be displayed).

To mitigate this, we let you set the _description\_format_ field. By default, its value is set to ```raw``` which means that target field is not formatted with any of the markup languages and contains a plain string. You can set it to either ```html``` or ```markdown``` depending on the target service formatting support. In our example above, if we set _description\_format_ to ```markdown``` and pass the result of the recipe to JIRA, _description_ field will be kept intact. Setting the "_format" field instructs our algorithm to omit escaping the data if it matches the supported markup in remote service. Below is a table with all the services and what format they expect when is set in recipe result.
To mitigate this, we let you set the _description\_format_ field. By default, its value is set to ```raw``` which means that target field is not formatted with any of the markup languages and contains a plain string. You can set it to either ```html``` or ```markdown``` depending on the target service formatting support. In our example above, if we set _description\_format_ to ```markdown``` and pass the result of the recipe to JIRA, _description_ field will be kept intact. Setting the "_format" field instructs our algorithm to omit escaping the data if it matches the supported markup in remote service. Below is a table with all the services and what format they expect when it is set in the recipe result.

|Service|Supported markup|
|---|---|
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/recipes/recipes_notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ These recipes handle data that is collected when some event is raised. For now,
- issue.deleted
- issue.comment

For simplicity, we unified the data structures passed to the ```handle()``` method to the ones being used in Webhooks. So, for details, on what data is available for each of the events listed above, refer to the [Webhook events](/webhooks/events/).
For simplicity, we unified the data structures passed to the ```handle()``` method with the ones used in Webhooks. So, for details, on what data is available for each of the events listed above, refer to the [Webhook events](/webhooks/events/).

```javascript
function handle(event) {
Expand All @@ -42,7 +42,7 @@ function handle(event) {
}
```

Note, that result is not used as is. Before executing the recipe, a default message object is constructed. Then, when recipe result is received, it extends that default object (replaces the default values on corresponding fields).
Note that the result is not used as-is. Before executing the recipe, a default message object is constructed. Then, when recipe result is received, it extends that default object (replaces the default values on corresponding fields).

```result``` object is constructed from the following fields:

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/android/gradle-plugin/releases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ slug: "/sdk/android/gradle-plugin/releases"

### 4.0.6 (August 2026)

Stops Bugsee being added to build variants that do not include the SDK, and fixes two crashes and a
Prevents Bugsee from being added to build variants that do not include the SDK, and fixes two crashes and a
build failure. Recommended for everyone; essential if you include Bugsee in some build variants
only.

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/ios/lifecycle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: "/sdk/ios/lifecycle"
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Bugsee SDK silently works within your app and recording everything to assist you in debugging when something unexpected happens. Our SDK is designed as a black box, but there may be cases when you want to be notified about changes/events within Bugsee itself. Lifecycle events are designed exactly for that. Each time when internal state changes or some important event is raised, lifecycle event is dispatched to the user code.
Bugsee SDK silently works within your app, recording everything to assist you in debugging when something unexpected happens. Our SDK is designed as a black box, but there may be cases when you want to be notified about changes/events within Bugsee itself. Lifecycle events are designed exactly for that. Each time when internal state changes or some important event is raised, lifecycle event is dispatched to the user code.

## Implementing callback

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/ios/manual.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ You can also use the BugseeExtendedReport to fill it with information and upload
// You can request video export to the specified file. This
// operation is asynchronous.
//
// Note: Do no trigger upload while video export is being performed!
// Note: Do not trigger upload while video export is being performed!
//
// Available since Bugsee iOS SDK v5.4.0
[extendedReport exportVideoToPath:@"full/video/path.mov" withCompletion:^{
Expand Down Expand Up @@ -170,7 +170,7 @@ Bugsee.createReport { report in
// You can request video export to the specified file. This
// operation is asynchronous.
//
// Note: Do no trigger upload while video export is being performed!
// Note: Do not trigger upload while video export is being performed!
//
// Available since Bugsee iOS SDK v5.4.0
report.exportVideo(path: "full/video/path.mov") {
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/ios/privacy/cleanup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Bugsee SDK does not continuously stream any personal data. The collected data an
Bugsee SDK provides a way to clean up the data stored on the disk. This can be useful in cases when you want to remove all the data collected by Bugsee from the device.

:::warning
Note that this API does not delete the session-related data, such as [attributes](/sdk/ios/custom/#sessionuser-attributes). To cleanup up those, use corresponding API (e.g. `[Bugsee clearAllAttributes]`)
Note that this API does not delete the session-related data, such as [attributes](/sdk/ios/custom/#sessionuser-attributes). To clean those up, use the corresponding API (e.g. `[Bugsee clearAllAttributes]`)
:::


Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/ios/privacy/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Data sent along with the reports may include video recording of screen, network

It is the sole responsibility of the application developers to remove any such data from the reports before it leaves the users’ device.

Bugsee provides the tools and means to either prevent some data of being collected or clean the data during the collection process:
Bugsee provides the tools and means to either prevent some data from being collected or clean the data during the collection process:

* [Video and Touch](/sdk/ios/privacy/video/)
* [Console logs](/sdk/ios/privacy/logs/)
Expand Down