minvws / nl-kat-coordination

OpenKAT scans networks, finds vulnerabilities and creates accessible reports. It integrates the most widely used network tools and scanning software into a modular framework, accesses external databases such as shodan, and combines the information from all these sources into clear reports. It also includes lots of cat hair.
https://openkat.nl
European Union Public License 1.2
126 stars 58 forks source link

add model explorer to documentation #1574

Open ring-ring-ring opened 1 year ago

ring-ring-ring commented 1 year ago

@praseodym suggested to add the model explorer to the docs.

_Originally posted by @ring-ring-ring in https://github.com/minvws/nl-kat-coordination/pull/1563#discussion_r1286800392_

Darwinkel commented 1 year ago

We discussed this last week in the office, and if I recall correctly the consensus was that we wanted to make sure that the model explorer is up-to-date first. The mispo.es explorer is outdated, and can't be copied as-is.

We could either:

or,

or,

Does @underdarknl have any strong opinions about this?

underdarknl commented 1 year ago

There are two usecases that we could cater to. A: Users running their Own OpenKAT install, ad wanting to understand the model for their own use, eg developing plugins, reports etc), for these users we should show the users their versionof the Model, which means running it inside their local openkat env, and showing them whatever local model changes they made during hteir dev process. This would also make sure that once we move to a 'model as a plugin' situation this gives us the capability of showing the completed model as present in their install.

B: Users who are looking at the documentation prior to having their own install, these we could give a 'static' version in the docs, which we would need to generate from the model code for every release we do.

ring-ring-ring commented 1 year ago

Aeej I like that one - using the model inside the software might also be a good way to represent the data in the graph.