luis-sousa-pinto / horusec-docs

Horusec oficial documentation

Horusec Documentation

This repository uses hugo server and contains Horusec's official documentation.

Table of contents

1. About

2. Getting Started

i. Requirements

ii. Installation

iii. Build

3. Issues

4. Contributing Guide

5. Roadmap

6. Code of Conduct

7. Community

About

Horusec is an open source tool that performs a static code analysis to identify security flaws during the development process. Currently, the languages for analysis are C#, Java, Kotlin, Python, Ruby, Golang, Terraform, Javascript, Typescript, Kubernetes, PHP, C, HTML, JSON, Dart, Elixir, Shell, Nginx. The tool has options to search for key leaks and security flaws in all your project's files, as well as in Git history. Horusec can be used by the developer through the CLI and by the DevSecOps team on CI /CD mats.

For more information, check out Horusec's documentation.

Getting Started

Requirements

To edit, run and build this project, you will need:

• Yarn

• Node

  • To check the installation, run npm -v and node -v in your terminal.

• Hugo

  • To check the installation, run hugo version in your terminal.

Installation

Run the command below to install the dependencies:

make install

Build

Run the following command to build this project:

npm run build

And you can see the folder generated by hugo into ./dist path.

Running

To see this project running, use the command below:

make run

• Now, check if the Web Server is available at http://localhost:1313/docs/.

Running the website locally

Once you've cloned this repo, from the root folder, run the command:

make build

Issues

To open or track an issue for this project, in order to better coordinate your discussions, we recommend that you use the Issues tab in the main Horusec repository.

Contributing Guide

Check out Horusec's contributing guide.

Roadmap

We have a project roadmap, you can come contribute with us!

Horusec also have other repositories, check out some of our other projects:

• Horusec CLI
• Horusec Platform
• Horusec DevKit
• Horusec Engine
• Horusec Operator
• Horusec VsCode

Code of Conduct

Please read the code of conduct.

Community

Feel free to reach out to us at:

• GitHub Issues
• If you have any questions or ideas, let's chat in our Zup Open Source Forum.

This project exists thanks to all the contributors. You rock! ❤️ 🚀