---
title: OpenVulnScan Admin Guide
description: OpenVulnscan Admin Guide
image: https://sudo-sec.xyz/hubfs/image-png-May-23-2025-03-59-41-5755-PM.png
---

[Skip to content](https://sudo-sec.xyz/blog/openvulnscan-admin-guide#main-content)

[![sudo-sec-dark-1](https://sudo-sec.xyz/hs-fs/hubfs/sudo-sec-dark-1.png?width=2536&height=2536&name=sudo-sec-dark-1.png)](https://sudo-sec.xyz/?hsLang=en-us)

- [Blog List](https://sudo-sec.xyz/blog)
- Services
  
  Show submenu for Services 
  
    - [External Attack Surface Management](https://sudo-sec.xyz/external-attack-surface-management-easm)
    - [Vulnerability Management](https://sudo-sec.xyz/vulnerability-management-services-0)
    - [Threat Modeling](https://sudo-sec.xyz/threat-management-services)
    - [Managed Services](https://sudo-sec.xyz/managed-services)
    - [Penetration Testing](https://sudo-sec.xyz/pentest-services)
- [Partners](https://sudo-sec.xyz/partners)
- [Products](https://sudo-sec.xyz/products)
- [Contact-Us](https://sudo-sec.xyz/contact-us)

Open main navigation

Close main navigation

- [Blog List](https://sudo-sec.xyz/blog)
- Services
  
  Show submenu for Services 
  
    - [External Attack Surface Management](https://sudo-sec.xyz/external-attack-surface-management-easm)
    - [Vulnerability Management](https://sudo-sec.xyz/vulnerability-management-services-0)
    - [Threat Modeling](https://sudo-sec.xyz/threat-management-services)
    - [Managed Services](https://sudo-sec.xyz/managed-services)
    - [Penetration Testing](https://sudo-sec.xyz/pentest-services)
- [Partners](https://sudo-sec.xyz/partners)
- [Products](https://sudo-sec.xyz/products)
- [Contact-Us](https://sudo-sec.xyz/contact-us)
- [Home](https://sudo-sec.xyz/)

[Home](https://sudo-sec.xyz/?hsLang=en-us)

 May 23, 2025 12:00:14 PM

# OpenVulnScan Admin Guide

![Picture of Brandon Williams](https://sudo-sec.xyz/hs-fs/hubfs/sudo-sec-dark.png?width=50&name=sudo-sec-dark.png) [Brandon Williams](https://sudo-sec.xyz/blog/author/brandon-williams)

Share: [facebook-f icon](http://www.facebook.com/share.php?u=https://sudo-sec.xyz/blog/openvulnscan-admin-guide) [linkedin-in icon](http://www.linkedin.com/shareArticle?mini=true&url=https://sudo-sec.xyz/blog/openvulnscan-admin-guide) [Twitter icon](https://twitter.com/intent/tweet?url=https://sudo-sec.xyz/blog/openvulnscan-admin-guide) [pinterest-p icon](http://pinterest.com/pin/create/link/?url=https://sudo-sec.xyz/blog/openvulnscan-admin-guide) [envelope icon](mailto:?body=https://sudo-sec.xyz/blog/openvulnscan-admin-guide)

## 👨‍🔧 OpenVulnScan Admin Guide

### Installation

#### 1. Clone the Repository

| git clone https://github.com/sudo-secxyz/OpenVulnScan.git cd OpenVulnScan |
| --- |

 

#### 2. Environment Setup

- - Create a `.env` file based on `.env.example`
    - Configure:
      
          - Database URI
          - Email service (for alerts)
          - OAuth credentials
          - Redis (for task queue)

3. Launch the App

| docker-compose up --build |
| --- |

The app runs at `http://localhost:8000`.

### Managing Users

Most User management can be handled in the User Management UI in the profile drop-down

![](https://sudo-sec.xyz/hs-fs/hubfs/image-png-May-23-2025-03-59-41-5755-PM.png?width=1870&height=888&name=image-png-May-23-2025-03-59-41-5755-PM.png)

- Users are stored in the `users` table.
- Admins can change roles via the admin panel or directly in the DB.
- You can disable accounts by setting `is_active` to false.

---

### Managing Agents

Download Agent

<https://github.com/sudo-secxyz/OpenVulnScan#-download-agent-script>

| curl -O "http://localhost:8000/agent/download?openvulnscan\_api=http://localhost:8000/agent/report" |
| --- |

 

openvulnscan\_api=`change to the ip address of scanner if not localhost`

| mv download agent.py python3 agent.py |
| --- |

```
 
```

- Agents register using a shared secret or API key.
- Agent data is stored in the `agents` and `agent_packages` tables.
- You can revoke agents in the dashboard or via API.

---

### Security Configuration

- Use HTTPS in production with a reverse proxy (e.g., Nginx).
- JWT secrets and session signing keys should be strong and stored securely.
- Enable login rate limiting via middleware settings.

---

### Scheduled Tasks

- Background scans (e.g., scheduled CVE checks) are managed via FastAPI background tasks or Celery if configured.
- You can configure scan intervals in the UI.

---

### CVE Enrichment

- CVE data is pulled from NVD or a local mirror (if set).
- To refresh data:

| python scripts/update\_cve.py |
| --- |

### API Access

- API keys can be issued to users for external integration.
- All routes are protected with OAuth2 or token-based auth.
- Documentation available at `/docs`.

### Forwarding Syslogs

- simple raw syslog forwarding availible via the settings menu
- ![](https://sudo-sec.xyz/hs-fs/hubfs/image-png-May-30-2025-07-03-50-9291-AM.png?width=2174&height=853&name=image-png-May-30-2025-07-03-50-9291-AM.png)

 

[information security](https://sudo-sec.xyz/blog/tag/information-security), [scanning](https://sudo-sec.xyz/blog/tag/scanning), [documentation](https://sudo-sec.xyz/blog/tag/documentation), [openvulnscan](https://sudo-sec.xyz/blog/tag/openvulnscan)

## Related posts

[![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXdMYQW1EuJa12jhLjP-PYCQenLe_qLl5wI5jG4WzU_DTCgsHcN4mKXteovB9Ipw39sOEFDUnTP3hNS3O-Zqarh-jRTb7ivzYvs13ZvY8dueYRnRDdbOGyG-uPoixvWMkVFPl2Ip-dH9VCyfa5zXQ9roCvRt?key=LTTjaY9MRekgRKDPWCmvig)](https://sudo-sec.xyz/blog/threat-modeling-breifing?hsLang=en-us)

[information security](https://sudo-sec.xyz/blog/tag/information-security)

## [Threat Modeling Breifing](https://sudo-sec.xyz/blog/threat-modeling-breifing?hsLang=en-us)

![Picture of Brandon Williams](https://sudo-sec.xyz/hs-fs/hubfs/sudo-sec-dark.png?width=50&name=sudo-sec-dark.png) [Brandon Williams](https://sudo-sec.xyz/blog/author/brandon-williams) 

 Oct 16, 2024 12:30:05 AM

What is Threat Modeling

[Read more](https://sudo-sec.xyz/blog/threat-modeling-breifing?hsLang=en-us)

[![](https://sudo-sec.xyz/hs-fs/hubfs/image-png.png?height=200&name=image-png.png)](https://sudo-sec.xyz/blog/bug-hunting-perspective-for-beginners?hsLang=en-us)

[information security](https://sudo-sec.xyz/blog/tag/information-security)

## [Bug Hunting perspective for beginners](https://sudo-sec.xyz/blog/bug-hunting-perspective-for-beginners?hsLang=en-us)

![Picture of Brandon Williams](https://sudo-sec.xyz/hs-fs/hubfs/sudo-sec-dark.png?width=50&name=sudo-sec-dark.png) [Brandon Williams](https://sudo-sec.xyz/blog/author/brandon-williams) 

 Sep 17, 2024 8:15:42 PM

When Selecting a Bug Bounty engagement to participate in there are many aspects of which to take...

[Read more](https://sudo-sec.xyz/blog/bug-hunting-perspective-for-beginners?hsLang=en-us)

[![](https://sudo-sec.xyz/hs-fs/hubfs/image-png-Oct-03-2024-04-46-57-7644-AM.png?height=200&name=image-png-Oct-03-2024-04-46-57-7644-AM.png)](https://sudo-sec.xyz/blog/basics-of-discovering-a-target?hsLang=en-us)

[information security](https://sudo-sec.xyz/blog/tag/information-security)

## [Basics of Discovering a Target.](https://sudo-sec.xyz/blog/basics-of-discovering-a-target?hsLang=en-us)

![Picture of Brandon Williams](https://sudo-sec.xyz/hs-fs/hubfs/sudo-sec-dark.png?width=50&name=sudo-sec-dark.png) [Brandon Williams](https://sudo-sec.xyz/blog/author/brandon-williams) 

 Oct 3, 2024 1:30:01 AM

I wanted to talk through some of the phases of a security engagement, so today I decided to speak...

[Read more](https://sudo-sec.xyz/blog/basics-of-discovering-a-target?hsLang=en-us)

[Advertise here](https://aads.com/campaigns/new/?source_id=2356253&source_type=ad_unit&partner=2356253)

[Advertise here](https://aads.com/campaigns/new/?source_id=2356253&source_type=ad_unit&partner=2356253)

[linkedin-in icon](https://www.linkedin.com/company/sudo-sec-consulting/) [Follow us on Facebook](https://www.instagram.com/sudo_sec_consulting/) [Follow us on Facebook](https://github.com/sudo-secxyz) [Follow us on Facebook](https://www.facebook.com/profile.php?id=61569024711431)

---

Copyright © 2022,

```json
{
  "@context" : "https://schema.org",
  "@type" : "BlogPosting",
  "author" : {
    "@type" : "Person",
    "name" : "Brandon Williams",
    "url" : "https://sudo-sec.xyz/blog/author/brandon-williams"
  },
  "dateModified" : "2025-05-30T07:04:33.770Z",
  "datePublished" : "2025-05-23T16:00:14.000Z",
  "headline" : "OpenVulnScan Admin Guide",
  "image" : [ "https://sudo-sec.xyz/hubfs/image-png-May-23-2025-03-59-41-5755-PM.png" ],
  "mainEntityOfPage" : {
    "@id" : "https://sudo-sec.xyz/blog/openvulnscan-admin-guide",
    "@type" : "WebPage"
  },
  "publisher" : {
    "@type" : "Organization",
    "logo" : {
      "@type" : "ImageObject",
      "url" : "https://sudo-sec.xyz/hubfs/sudo-sec-dark.png"
    },
    "name" : "Sudo-Sec"
  }
}
```