Quickstart

Learn how to run first Verdex detections in seconds.

1. Install Verdex

   Go

   go install -v github.com/verdexlab/verdex@latest
   

   Verdex requires the latest GO version to install successfully.

   Docker

   # using bash:
   echo 'alias verdex="docker run --rm verdexlab/verdex:latest"' >> ~/.bashrc
   source ~/.bashrc
   
   # or using zsh:
   echo 'alias verdex="docker run --rm verdexlab/verdex:latest"' >> ~/.zshrc
   source ~/.zshrc
   

   Binary

   Download the latest binary from official releases (v*): https://github.com/verdexlab/verdex/releases

2. Check Verdex installation

   verdex -version
   
3. Run version detection

   verdex -target https://keycloak.example.com -output-json ./results.json
   

   Yay, here are the first Verdex results! 🎉

Next steps

Products

Explore the services supported by Verdex and vote for the next ones.

Detection Options

Learn about the available Verdex options to optimize your scans.

Vulnerabilities

Discover how to obtain the list of vulnerabilities.

Output Formats

Learn about the different output formats that Verdex supports.

Contribute

How to contribute to Verdex by improving detections or reporting issues.