Skip to content

docs: Add setup step 3 to the toolbar #12181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 18, 2024
Merged

docs: Add setup step 3 to the toolbar #12181

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f64e78
docs: Add setup step 3 to the toolbar
ryan953 Dec 18, 2024
598c4e8
link to Settings>Projects picker
ryan953 Dec 18, 2024
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
Binary file added docs/product/dev-toolbar/img/sentry-project-settings-toolbar.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/product/dev-toolbar/img/sentry-toolbar-settings.png
View file
Open in desktop
Binary file not shown.
5 changes: 1 addition & 4 deletions docs/product/dev-toolbar/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,7 @@ After setting up the Dev Toolbar you’ll see a “Login to Sentry” button flo
After clicking the button, you will see a pop-up window for logging in to Sentry.
![Sentry log in pop up](./img/login-popup.png)

If it's your first time setting up the Dev Toolbar, there will be a button with a link to Sentry's Dev Toolbar settings page to configure your domain.
If it's your first time [setting up the Dev Toolbar](/product/dev-toolbar/setup) , there will be a button with a link to Sentry's Dev Toolbar settings page to configure your domain.
![Dev Toolbar configure domains button](./img/configure-domain.png)

You'll need to add your domain URL to Allowed Origins in Sentry on the **Settings > Project > Dev Toolbar** page.
![Sentry's Dev Toolbar Settings Page](./img/sentry-toolbar-settings.png)

Learn more about setting up the toolbar, including configuring a feature flag provider and integrating the toolbar in different environments, on the next page.
6 changes: 5 additions & 1 deletion docs/product/dev-toolbar/setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You need to complete two steps to get the toolbar rendered on the page:
```
It is recommended that you add the script tag at the bottom of the page so it doesn’t block other critical JavaScript.

2. Call `window.SentryToolbar.init(initConfig)` to set up a toolbar instance on each page where you want to see the Dev Toolbar.
2. Call `window.SentryToolbar.init(initConfig)` to set up a toolbar instance on each page where you want to see the Dev Toolbar. Take care to also [conditionally load the toolbar in your production environment](#deploying-to-production-environments).
```html
<html>
<head>...</head>
Expand All @@ -36,6 +36,10 @@ You need to complete two steps to get the toolbar rendered on the page:
</html>
```

3. Edit Project Settings in Sentry so the Toolbar is allowed to connect from your dev, staging, and production domains.
Copy link
Member

@JoshFerge JoshFerge Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it possible to link to the settings page from here?

Copy link
Member Author

@ryan953 ryan953 Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can get to https://sentry.sentry.io/settings/projects/ but without knowing the project name i can't get closer

Copy link
Member

@JoshFerge JoshFerge Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ahh its project settings, not org settings. gotcha. could make it org settings?

Copy link
Member Author

@ryan953 ryan953 Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's a per-project config

Copy link
Member

@JoshFerge JoshFerge Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not make it an org config? cause what if you have multiple projects on the same domain?

Copy link
Member Author

@ryan953 ryan953 Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

orgs can have like, their main website, but also all the backend tools with very different domains. kinda a security thing

if different projects are on the same domain that's ok. the request is for a project+domain pair. So everything could have localhost added to each of their lists no problem.

Copy link
Member Author

@ryan953 ryan953 Dec 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the security position is that:
we're doing a login using sentry.io, so cookies and things never leave our own control. but org data is leaving sentry.io so I wanted to validate that we're exfiltrating those api responses to a domain known to the customer. This way org data only gets sent to domains the customer controls... then the sdk can use the data to render the toolbar.
This is against phishing cases: if a random site got someone to log into sentry we wouldn't be revealing api responses to that site because of cors in the usual cases, and because of this domain check if they try to abuse the iframe proxy that the toolbar uses.

![Sentry's Dev Toolbar Settings Page](./img/sentry-project-settings-toolbar.png)


### Unmounting The Toolbar

If you have called `SentryToolbar.init({...})` to render the toolbar, but now want to manually remove or unmount it from the page, you can call the cleanup function that is returned from `init()`. This will unmount all the injected HTML and CSS. Login credentials will not be removed, so you can re-insert the toolbar and still be authenticated.
Expand Down
Loading