Skip to main content

​
Web UI

This document describes the web UI for Osmedeus which is the main entry point for running workflows and modules and some other utilities. Start the web UI by running the following command: 
osmedeus serve
then open your browser and go to https://localhost:8002
web-ui-login

Web UI Login

Your default password is in $HOME/osmedeus-base/osm-settings.yaml
You can also change the default password by running the following command: 
osmedeus config set server.username "osmedeus"
osmedeus config set server.password "$(openssl rand -hex 12)"

​
All Web UI Pages

The web UI consists of the following pages that allow you to view and manage your assets, workspaces, vulnerabilities, and other utilities.

​
1. Assets and Workspace

This is the main page of the web UI where you can view and manage your assets, workspaces, vulnerabilities, and artifacts which will be generated by the workflows.
web-ui-workspace

Workspace List

web-ui-assets

List of Assets

web-ui-vuln

List of Vulnerabilities

web-ui-assets

Assets In Light mode

web-ui-vuln

Vulnerabilities in light mode

You also have the option to enhance the UI, displaying artifacts in a cleaner, syntax-highlighted layout—ideal for reviewing markdown or HTML reports.
web-ui-artifact-list

List of Artifacts

web-ui-artifact-details

Artifact Details

​
2. Start New Scan

This is where you can start a new scan by selecting the workflow and the target asset with all the extra parameters and scheduling options.
web-ui-new

New Scan

After you start a new scan, you can view the progress and results in the list of scans.
web-ui-list-scan

List of Scans

​
3. Settings, Install Registry

This is where you can configure the settings and install the registry for Osmedeus.
web-ui-install-registry

Web UI Install Registry

web-ui-settings

Web UI Settings

​
4. Utilities Functions & Scheduling

This is where you can schedule the workflows to run at specific times or intervals, and also use the LLM chat to get help with your workflows.
web-ui-schedule

Schedule

web-ui-llm-chat

LLM Chat

web-ui-utility-functions

Utility Functions

​
Workflow Visualization and Editor

Visualization and editor for workflows in the web UI through the beautifl representation of the workflow via xyflow.
web-ui-workflow1

Web UI Workflow 1

web-ui-workflow2

Web UI Workflow 2

web-ui-workflow3

Web UI Workflow 3

web-ui-workflow4

Web UI Workflow 4

web-ui-workflow4

Web UI Workflow In Light mode

​
Communication with Web UI

Once you have logged in, you can use the web UI to run workflows, view the results, and manage your Osmedeus installation.
Request
curl --request POST \
  --url https://localhost:8002/osm/api/runs \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"flow": "general", "target": "example.com", "distributed": true}'