mckeimic/joern repository overview

= Joern=

This image contains all the components needed to run joern (http://mlsec.org/joern⁠ or https://github.com/fabsx00/joern⁠).

Image container includes compiled version of joern, joern-tools, and the neo4j database with the gremlin plugin.

== Usage ==

• Mount the code to analyze as a volume at /code in the container and expose port 7474

** docker run -v /path/to/code:/code -p -it mckeimic/joern

• Create neo4j database using joern

** cd /code && joern .

• Start the neo4j server

** /var/lib/neo4j/bin/neo4j console

• Explore code however you like

** to access joern-tools, the python library for exploring the graph, just cd /joern-tools