empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 08:55:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
1d8e208c32
fleet/ee/vulnerability-dashboard
History
Eric 1d8e208c32
Vulnerability dashboard: Add a way to start a local vulnerability dashboard with Docker (#17676) 
Related to: https://github.com/fleetdm/confidential/issues/5637

Changes:
- Added a way to start a vulnerability dashboard with Docker.
- Updated the folder readme to include instructions for starting the
vulnerability dashboard with docker
2024-03-21 16:31:20 -05:00
..
api Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
assets Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
config Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
scripts Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
tasks Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
views Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
.dockerignore Vulnerability dashboard: Add a way to start a local vulnerability dashboard with Docker (#17676) 2024-03-21 16:31:20 -05:00
.editorconfig Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
.eslintignore Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
.eslintrc Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
.gitignore Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
.htmlhintrc Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
.lesshintrc Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
.npmrc Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
.sailsrc Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
app.js Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
CHANGELOG.md Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
crontab Vulnerability dashboard: Add a way to start a local vulnerability dashboard with Docker (#17676) 2024-03-21 16:31:20 -05:00
docker-compose.yml Vulnerability dashboard: Add a way to start a local vulnerability dashboard with Docker (#17676) 2024-03-21 16:31:20 -05:00
Dockerfile Vulnerability dashboard: Add a way to start a local vulnerability dashboard with Docker (#17676) 2024-03-21 16:31:20 -05:00
entrypoint.sh Vulnerability dashboard: Add a way to start a local vulnerability dashboard with Docker (#17676) 2024-03-21 16:31:20 -05:00
Gruntfile.js Add fleet-vulnerability-dashboard repo to ee/ folder (#17428) 2024-03-13 13:06:11 -05:00
package.json Bump grunt from 1.0.4 to 1.5.3 in /ee/vulnerability-dashboard (#17600) 2024-03-21 13:41:49 -05:00
README.md Vulnerability dashboard: Add a way to start a local vulnerability dashboard with Docker (#17676) 2024-03-21 16:31:20 -05:00

README.md

fleet-vulnerability-dashboard

Report and track progress on fixing and prioritizing thousands of installed CVEs.

screenshot of dashboard: overview

How does it work?

CVEs are detected and annotated using NVD, CVSS, EPSS, CISA KEVs, osquery, and Fleet.

screenshot of dashboard: list

Why a separate repo?

Should we move this to a subdirectory of fleetdm/confidential and have it deploy from there?

  • Philosophy: Why do we use one repo?
  • See also: The "broken windows effect"
  • Decision: No. On 2023-07-14, we decided to keep it here so Stephan, Finn, and all other relevant folks from Fastly can access the code and collaborate.
  • Update: 2023-11-06: The best thing is to move this in the ee/ directory of fleetdm/fleet. That achieves the goal of making it source available, but still paid. Logistics to enable this involve changing hosted deployments to deploy from within a nested subdirectory (something we've done before)

Cosmogony

f.k.a. "scooper"

Original raw notes and context: (private google doc since it contains competitor information: https://docs.google.com/document/d/1ByNWY6n_C-rvL75lI6jca2OniHt5FqA5_nYMf61S0pM/edit#)

Running the vulnerability dashboard with Docker.

To run a local vulnerability dashboard with docker, you can follow these instructions.

  1. Clone this repo

  2. Update the following ENV variables ee/vulnerability-dashboard/docker-compose.yml file:

  3. sails_custom__fleetBaseUrl: The full URL of your Fleet instance. (e.g., https://fleet.example.com)

  4. sails_custom__fleetApiToken: AN API token for an API-only user on your Fleet instance.

You can read about how to create an API-only user and get it's token here

  1. Open the ee/vulnerability-dashboard/ folder in your terminal
  2. Run docker compose up --build to build the vulnerability dashboard's Docker image.

The first time the vulnerability dashboard starts it will Initalize the database and run the update-reports script before the server starts.

  1. Once the container is done building, the vulnerability dashboard will be available at http://localhost:1337

You can login with the default admin login:

  • Email address: admin@example.com

  • Password: abc123

How it's made

This is a Sails v1 application: