Skip to content

Commit

Permalink
Add description about notification dialog
Browse files Browse the repository at this point in the history
  • Loading branch information
tamasmak committed Nov 21, 2023
1 parent c1ae12f commit ca88ad8
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions articles/tools/appsec/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,27 @@ The SBOM file, [filename]`bom-npm.json` should be generated in the `/resources`
AppSec Kit isn't enabled in production mode. Therefore, you'll need to start your application in <</configuration/development-mode#, development mode>> -- which is the mode in which applications start by default. You don't need to enable this, explicitly.


=== Notification Dialog

After the application has started, AppSec Kit analyzes the dependencies, collects any vulnerabilities, and displays a notification dialog (see screenshot). There you'll see a link, labeled _Open AppSec Kit_, that you can click on to open the UI in a new tab.

[[getting-started-notification-dialog]]
.AppSec Kit Notification Dialog
image::img/notification-dialog.png[]

You can also navigate to the UI using the `vaadin-appsec-kit` route. For example, on your localhost, enter something like this in your browser: link:http://localhost:8080/vaadin-appsec-kit[http://localhost:8080/vaadin-appsec-kit].

You should configure https://vaadin.com/docs/v23/advanced/server-push[server push] for a `UI` so you'll be notified when new vulnerabilities are found. You can do this by adding the `@Push` annotation to a UI class like so:

[source,java]
----
@Push
public class ExampleUI extends UI {
// ...
}
----


== AppSec Kit UI

The AppSec Kit UI has views for seeing vulnerabilities and dependencies of which you should be aware. This section describes those views, which can be found under the two main tabs of the UI.
Expand Down

0 comments on commit ca88ad8

Please sign in to comment.