Skip to content

Commit

Permalink
Merge pull request #409 from owasp-noir/update-docs-introdution
Browse files Browse the repository at this point in the history
Refactor Docker installation documentation and add link to Docker tag page
  • Loading branch information
hahwul authored Sep 22, 2024
2 parents 7d92c9f + 8799f5d commit 0434f93
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/_get_started/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,6 @@ or Replace `<version>` with the specific version tag you need.

```dockerfile
FROM ghcr.io/owasp-noir/noir:<version>
```
```

If you want to see packages by Docker tag, visit [this page](https://github.com/owasp-noir/noir/pkgs/container/noir).
13 changes: 11 additions & 2 deletions docs/introdution.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,15 @@ nav_order: 1
---

## What is noir?
Noir is an open-source project specializing in identifying attack surfaces for enhanced whitebox security testing and security pipeline. This includes the capability to discover API endpoints, web endpoints, and other potential entry points within source code for thorough security analysis.

Noir is an open-source project dedicated to identifying attack surfaces, enhancing whitebox security testing, and optimizing security pipelines. It excels at discovering API endpoints, web endpoints, and other potential entry points within source code for comprehensive security analysis.

![](../images/noir-usage.jpg)

This tool was developed using [Crystal](https://crystal-lang.org). Initially started as hahwul's personal project[^1] in August 2023, it became an OWASP project in June 2024, co-led by [hahwul](https://github.com/hahwul) and [ksg](https://github.com/ksg97031).

[^1]: [Hello Noir 👋🏼](https://www.hahwul.com/2023/08/03/hello-noir/)

## How it works?

Noir is composed of several key components: detector, analyzer, deliver, minilexer, output-builder, and tagger. These components interact and work together to effectively analyze source code. Through this process, they help identify endpoints, parameters, headers, and more within the source code.
Expand Down Expand Up @@ -49,4 +54,8 @@ We believe every contribution counts and appreciate the time and effort you put

To get started, simply follow the guidelines in the [Contribute Guide](https://github.com/owasp-noir/noir/blob/main/CONTRIBUTING.md). It's full of helpful tips and instructions to make your first contribution smooth and enjoyable.

Happy contributing!
Happy contributing!

## Help and feedback

We always welcome feedback. Please share your thoughts, suggestions, or report any issues via the GitHub [discussions](https://github.com/orgs/owasp-noir/discussions) or [issues](https://github.com/owasp-noir/noir/issues) page.

0 comments on commit 0434f93

Please sign in to comment.