Skip to content
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

Improve docs regarding LiveView scope #115

Merged
merged 1 commit into from
Dec 9, 2024
Merged

Improve docs regarding LiveView scope #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion lib/error_tracker/web.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,20 @@ defmodule ErrorTracker.Web do

...

error_tracker_dashboard "/errors"
scope "/" do
...

error_tracker_dashboard "/errors"
end
end
```

This will add the routes needed for ErrorTracker's dashboard to work.

**Note:** when adding the dashboard routes, make sure you do it in an scope that
has CSRF protection (usually the `:browser` pipeline in most projects), as
otherwise you may experience LiveView issues like crashes and redirections.

## Security considerations

Errors may contain sensitive information, like IP addresses, users information
Expand Down
3 changes: 3 additions & 0 deletions lib/error_tracker/web/router.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ defmodule ErrorTracker.Web.Router do

It requires a path in which you are going to serve the web interface.

In order to work properly, the route should be in a scope with CSRF protection
(usually the `:browser` pipeline).

## Security considerations

The dashboard inlines both the JS and CSS assets. This means that, if your
Expand Down
Loading