mirror of https://github.com/MISP/misp-website
51 lines
3.6 KiB
Markdown
Executable File
51 lines
3.6 KiB
Markdown
Executable File
---
|
|
layout: page
|
|
title: MISP Documentation and Support
|
|
permalink: /documentation/
|
|
toc: true
|
|
---
|
|
|
|
## MISP Documentation
|
|
|
|
The MISP documentation is maintained in the [misp-book project](https://github.com/MISP/misp-book). The documentation is in git book format and we welcome contribution.
|
|
|
|
The MISP documentation is available in [HTML format](https://www.circl.lu/doc/misp/), [PDF](https://www.circl.lu/doc/misp/book.pdf), [Kindle Mobi format](https://www.circl.lu/doc/misp/book.mobi) and [EPUB](https://www.circl.lu/doc/misp/book.epub).
|
|
|
|
MISP Install guides (stock install instructions for getting a base MISP system running) are available at [https://misp.github.io/MISP/](https://misp.github.io/MISP/).
|
|
|
|
### MISP galaxy, objects and taxonomies documentation
|
|
|
|
- [MISP galaxy](https://github.com/MISP/misp-galaxy) clusters are documented and available in [HTML format](/galaxy.html) or [PDF format](/galaxy.pdf).
|
|
- [MISP objects](https://github.com/MISP/misp-objects) are documented and available in [HTML format](/objects.html) or [PDF format](/objects.pdf).
|
|
- [MISP taxonomies](https://github.com/MISP/misp) are documented and available in [HTML format](/taxonomies.html) or [PDF format](/taxonomies.pdf).
|
|
|
|
### MISP training materials
|
|
|
|
All MISP training materials (including source code) are available at [https://github.com/MISP/misp-training](https://github.com/MISP/misp-training).
|
|
|
|
MISP [training materials are available on](https://www.misp-project.org/misp-training/).
|
|
|
|
### MISP format documentation
|
|
|
|
MISP formats are described in [specification document](https://github.com/MISP/misp-rfc) based on the current implementation of MISP core and PyMISP. These specifications are available for
|
|
other developers willing to develop their own tools or software supporting the MISP format.
|
|
|
|
* [misp-core-format](https://github.com/MISP/misp-rfc/blob/master/misp-core-format/raw.md.txt) which describes the core JSON format of MISP. Current Internet-Draft: [05](https://tools.ietf.org/html/draft-dulaunoy-misp-core-format)
|
|
* [misp-taxonomy-format](https://github.com/MISP/misp-rfc/blob/master/misp-taxonomy-format/raw.md.txt) which describes the taxonomy JSON format of MISP. Current Internet-Draft: [06](https://tools.ietf.org/html/draft-dulaunoy-misp-taxonomy-format)
|
|
* [misp-galaxy-format](https://github.com/MISP/misp-rfc/blob/master/misp-galaxy-format/raw.md.txt) which describes the [galaxy](https://github.com/MISP/misp-galaxy) template format used to expand the threat actor modelling of MISP. Current Internet-Draft: [05](https://datatracker.ietf.org/doc/draft-dulaunoy-misp-galaxy-format/)
|
|
* [misp-object-template-format](https://github.com/MISP/misp-rfc/blob/master/misp-object-template-format/raw.md.txt) which describes the [object](https://github.com/MISP/misp-objects) template format to add combined and composite object to the MISP core format. Current Internet-Draft: [02](https://datatracker.ietf.org/doc/draft-dulaunoy-misp-object-template-format/)
|
|
|
|
### MISP OpenAPI Spec
|
|
MISP API OpenAPI spec available is [here](/documentation/openapi).
|
|
|
|
## Community Support
|
|
|
|
If you have any issues with MISP core software, [the issue tracking of MISP](https://github.com/MISP/MISP/issues) is handled in GitHub.
|
|
|
|
If the issue is related to [one of the MISP software or data models](https://github.com/MISP/), please open an issue in the respective issue tracker of the GitHub repository.
|
|
|
|
You are also welcome on the MISP gitter chats:
|
|
* [MISP/MISP](https://gitter.im/MISP/MISP) where development is discussed.
|
|
* [MISP/Support](https://gitter.im/MISP/Support) where community support is provided.
|
|
* [MISP/Sharing](https://gitter.im/MISP/Sharing) for general information sharing topics
|