|
1 | | -# STIG - Structured Threat Intelligence Graph |
| 1 | +# Structured Threat Intelligence Graph (STIG) |
2 | 2 |
|
3 | | -[](https://youtube.com/watch?v=vMgb-yx7PVA) |
| 3 | +Structured Threat Intelligence Graph (STIG) is a tool for creating, editing, querying, analyzing and visualizing threat intelligence. It uses STIX version 2 as its data format. STIG uses a graph database (Neo4j) to store the data. |
4 | 4 |
|
5 | | -<img align="right" width="260" src="/images/STIG_rev1.png"> Structured Threat Intelligence Graph (STIG) is a tool for creating, editing, querying, analyzing and visualizing threat intelligence. It uses STIX version 2 as its data format. STIG uses a graph database (Neo4j) to store the data. |
6 | 5 |
|
7 | | -See the [STIG Innovation Sheet](18-179_STIG_Innovation_Sheet.pdf) for an overview. |
| 6 | +For more information on STIX, see the **[STIX 2.1 specification](https://oasis-open.github.io/cti-documentation/resources)**, the **[introduction](https://oasis-open.github.io/cti-documentation/stix/intro.html)**, and the **[walkthrough](https://oasis-open.github.io/cti-documentation/stix/walkthrough.html)**. |
8 | 7 |
|
9 | | -The STIX version 2.1 specification can be found at **<https://oasis-open.github.io/cti-documentation/resources>**. |
10 | | -An introduction and walk through of STIX can be found at **<https://oasis-open.github.io/cti-documentation/stix/intro.html>**, and **<https://oasis-open.github.io/cti-documentation/stix/walkthrough.html>**. |
| 8 | +**For installation and usage instructions, see our [documentation](https://stig.readthedocs.io/en/latest/).** |
11 | 9 |
|
12 | | -## Repository Structure |
13 | | -- The **STIG-Old** directory is where the codebase for the existing version of STIG is stored. See the README.md within that folder for instructions on how to run that project and for further information. |
14 | | -- The **STIG-React** directory is where the codebase for the new version of STIG we are working on developing is stored. This is where we will make the majority of code changes as this project progresses. See the README.md within that folder for instructions on how to run that project. |
| 10 | +## Quickstart: |
| 11 | +STIG can be run from a docker container and built from source using npm. |
| 12 | + |
| 13 | +1) Clone this repository |
| 14 | +2) `cd` into this repository |
| 15 | + |
| 16 | +**Using Docker:** |
| 17 | + |
| 18 | +3) Install Docker and docker-compose |
| 19 | +4) Run `docker-compose up -d` |
| 20 | + |
| 21 | +**Or Using NPM:** |
| 22 | + |
| 23 | +3) Ensure you have Node.js and npm installed: https://nodejs.org/en/download/package-manager |
| 24 | +4) Run `npm i && npm run dev` |
| 25 | + |
| 26 | +**Finally:** |
| 27 | + |
| 28 | +5) Open http://localhost:5173/ in a web browser |
0 commit comments