> ## Documentation Index
> Fetch the complete documentation index at: https://docs.osmedeus.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Web UI

> Server and Web UI for Osmedeus

This document describes the web UI for Osmedeus which is the main entry point for running workflows and modules and some other utilities.

<Note>The Osmedeus server also acts as an event receiver, processing events from other runs and handling scheduled scans. See [Event-Driven](/advanced/event-driven) for more details.</Note>

Start the web UI by running the following command:

```bash theme={null}
osmedeus serve
```

then open your browser and go to `https://localhost:8002`.

## How to Login into Web UI

<Frame caption="Web UI Login">
  <img src="https://mintcdn.com/osmedeus/v2F2CQFtcKul_NUM/images/web-ui/web-ui-login.png?fit=max&auto=format&n=v2F2CQFtcKul_NUM&q=85&s=dfba46c1700d447635d4cad73be37d81" alt="web-ui-login" width="2846" height="1982" data-path="images/web-ui/web-ui-login.png" />
</Frame>

<Tip>Your default password is in `$HOME/osmedeus-base/osm-settings.yaml`</Tip>

You can view the default credentials by running the following command as it is auto-generated:

```bash theme={null}
osmedeus config view server.username
osmedeus config view server.password
```

<Danger>Many API endpoints are intentionally designed to execute code on your machine, so ensure your web UI and API endpoints are protected with strong credentials. See [security-warning](/others/security-warning) for more details</Danger>

You can also change the default password and set API key authentication by running the following command:

```bash theme={null}
osmedeus config set server.username "osmedeus"
osmedeus config set server.password "$(openssl rand -hex 12)"
# api key auth requires a jwt secret signing key
osmedeus config set server.jwt.secret_signing_key "$(openssl rand -hex 32)"
osmedeus config set server.enabled_auth_api true
osmedeus config set server.auth_api_key "$(openssl rand -hex 24)"

## API Key Authentication Settings
# server:
#   enabled_auth_api: true
#   auth_api_key: "your-secure-api-key"

```

***

## 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.

<Frame caption="Workspace List">
  <img src="https://mintcdn.com/osmedeus/v2F2CQFtcKul_NUM/images/web-ui/web-ui-workspace.png?fit=max&auto=format&n=v2F2CQFtcKul_NUM&q=85&s=0b2294cbd78b0a220b0f660a3239b845" alt="web-ui-workspace" width="2974" height="1382" data-path="images/web-ui/web-ui-workspace.png" />
</Frame>

<Columns cols={2}>
  <Frame caption="List of Assets">
    <img src="https://mintcdn.com/osmedeus/v2F2CQFtcKul_NUM/images/web-ui/web-ui-assets.png?fit=max&auto=format&n=v2F2CQFtcKul_NUM&q=85&s=0ce499f1662852c2a17527d2b49a01b7" alt="web-ui-assets" width="2974" height="2378" data-path="images/web-ui/web-ui-assets.png" />
  </Frame>

  <Frame caption="List of Vulnerabilities">
    <img src="https://mintcdn.com/osmedeus/v2F2CQFtcKul_NUM/images/web-ui/web-ui-vuln.png?fit=max&auto=format&n=v2F2CQFtcKul_NUM&q=85&s=03e1ce746624549ce5c83b42e1810139" alt="web-ui-vuln" width="2974" height="2378" data-path="images/web-ui/web-ui-vuln.png" />
  </Frame>
</Columns>

<Columns cols={2}>
  <Frame caption="Assets In Light mode">
    <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/web-ui/web-ui-assets-light.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=ad0fe412789e8619e886d487843c7d7e" alt="web-ui-assets" width="4336" height="2460" data-path="images/web-ui/web-ui-assets-light.png" />
  </Frame>

  <Frame caption="Vulnerabilities in light mode">
    <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/web-ui/web-ui-vuln-light.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=1673c91a94e46376fbd29bf092b14246" alt="web-ui-vuln" width="4336" height="2460" data-path="images/web-ui/web-ui-vuln-light.png" />
  </Frame>
</Columns>

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

<Columns cols={2}>
  <Frame caption="List of Artifacts">
    <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/web-ui/web-ui-artifact-list.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=8c503eba5dd87d53f1f87babddb0f719" alt="web-ui-artifact-list" width="4336" height="2208" data-path="images/web-ui/web-ui-artifact-list.png" />
  </Frame>

  <Frame caption="Artifact Details">
    <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/web-ui/web-ui-artifact-details.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=b245a40f6f8f0670ed2394331ce106ca" alt="web-ui-artifact-details" width="4336" height="2098" data-path="images/web-ui/web-ui-artifact-details.png" />
  </Frame>
</Columns>

### 2. Start New Scan (Simple Run & Scheduled)

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.

<Frame caption="New Scan and Schedule Scan">
  <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/web-ui/web-ui-new-scan.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=6c602f66a6050a88b06d6544dd17cedc" alt="web-ui-new" width="3080" height="2060" data-path="images/web-ui/web-ui-new-scan.png" />
</Frame>

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

<Frame caption="List of Scans">
  <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/web-ui/web-ui-list-scan.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=72cdee67fb77700a2f7752728aec5480" alt="web-ui-list-scan" width="3080" height="1786" data-path="images/web-ui/web-ui-list-scan.png" />
</Frame>

### 3. Settings, Install Registry

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

<Columns cols={2}>
  <Frame caption="Web UI Install Registry">
    <img src="https://mintcdn.com/osmedeus/v2F2CQFtcKul_NUM/images/web-ui/web-ui-install-registry.png?fit=max&auto=format&n=v2F2CQFtcKul_NUM&q=85&s=abdb5e6a931f20ea0602658ccd8d9fbf" alt="web-ui-install-registry" width="2974" height="2378" data-path="images/web-ui/web-ui-install-registry.png" />
  </Frame>

  <Frame caption="Web UI Settings">
    <img src="https://mintcdn.com/osmedeus/v2F2CQFtcKul_NUM/images/web-ui/web-ui-settings.png?fit=max&auto=format&n=v2F2CQFtcKul_NUM&q=85&s=6ec05384cb97b44c35e379d423fc3cf3" alt="web-ui-settings" width="2974" height="2378" data-path="images/web-ui/web-ui-settings.png" />
  </Frame>
</Columns>

### 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.

<Columns cols={3}>
  <Frame caption="Schedule">
    <img src="https://mintcdn.com/osmedeus/v2F2CQFtcKul_NUM/images/web-ui/web-ui-schedule.png?fit=max&auto=format&n=v2F2CQFtcKul_NUM&q=85&s=557450eae49d2c08d54cd78b1bd4e4e7" alt="web-ui-schedule" width="3040" height="1884" data-path="images/web-ui/web-ui-schedule.png" />
  </Frame>

  <Frame caption="LLM Chat">
    <img src="https://mintcdn.com/osmedeus/v2F2CQFtcKul_NUM/images/web-ui/web-ui-llm-chat.png?fit=max&auto=format&n=v2F2CQFtcKul_NUM&q=85&s=d13704496b57f5c8047539aca509b5a0" alt="web-ui-llm-chat" width="2974" height="2378" data-path="images/web-ui/web-ui-llm-chat.png" />
  </Frame>

  <Frame caption="Utility Functions">
    <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/web-ui/web-ui-utility-functions.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=f0fdc7f162eccf5205e511611cc5f928" alt="web-ui-utility-functions" width="4336" height="2208" data-path="images/web-ui/web-ui-utility-functions.png" />
  </Frame>
</Columns>

## Workflow Visualization and Editor

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

<Frame caption="Web UI Workflow 1">
  <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/workflow-editor/web-ui-workflow-1.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=d1b131606a725342236d09695d994b96" alt="web-ui-workflow1" width="4336" height="2674" data-path="images/workflow-editor/web-ui-workflow-1.png" />
</Frame>

<Frame caption="Web UI Workflow 2">
  <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/workflow-editor/web-ui-workflow-2.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=39238f673302ed02c24bcd98739b0cfd" alt="web-ui-workflow2" width="4336" height="2674" data-path="images/workflow-editor/web-ui-workflow-2.png" />
</Frame>

<Frame caption="Web UI Workflow 3">
  <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/workflow-editor/web-ui-workflow-3.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=5b64d52474163fe14c1bfda3daec75e5" alt="web-ui-workflow3" width="4336" height="2674" data-path="images/workflow-editor/web-ui-workflow-3.png" />
</Frame>

<Frame caption="Web UI Workflow 4">
  <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/workflow-editor/web-ui-workflow-4.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=f6805dec64cf3711338d18f3f8f35b2f" alt="web-ui-workflow4" width="4336" height="2674" data-path="images/workflow-editor/web-ui-workflow-4.png" />
</Frame>

<Frame caption="Web UI Workflow In Light mode">
  <img src="https://mintcdn.com/osmedeus/rQ49bCQbs9dKARCy/images/workflow-editor/web-ui-workflow-light.png?fit=max&auto=format&n=rQ49bCQbs9dKARCy&q=85&s=c0cbec3d518dce7702d2068794d9df0d" alt="web-ui-workflow4" width="4336" height="2460" data-path="images/workflow-editor/web-ui-workflow-light.png" />
</Frame>

## 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.

```bash Request theme={null}
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}'
```
