Jackhammer 项目使用教程

Jackhammer 项目使用教程

jackhammer Jackhammer - One Security vulnerability assessment/management tool to solve all the security team problems. 项目地址: https://gitcode.com/gh_mirrors/ja/jackhammer

1. 项目目录结构及介绍

Jackhammer项目的目录结构如下：

• config.yml：项目的主配置文件，用于定义项目运行的各项参数。
• Dockerfile：用于创建Docker镜像的文件。
• docker-build.sh：用于构建Docker镜像的脚本。
• docker-compose-with-marathon.yml：用于在Marathon环境中部署的docker-compose文件。
• docker-compose-with-no-marathon.yml：用于非Marathon环境的docker-compose文件。
• dump.sql：项目数据库的初始数据文件。
• LICENSE：项目的许可证文件。
• pom.xml：Maven项目文件，用于管理项目的依赖。
• README.md：项目的说明文件。
• src：源代码目录，包含项目的所有代码文件。
• travis.yml：用于配置持续集成服务Travis CI的文件。

2. 项目的启动文件介绍

项目的启动主要通过Docker进行，以下是启动项目的基本步骤：

1. 克隆项目到本地：

   git clone https://github.com/olacabs/jackhammer.git
   

2. 使用docker-compose启动服务：

   • 对于非Marathon环境，运行以下命令：

     docker-compose -f docker-compose-with-no-marathon.yml up -d
     

   • 对于Marathon环境，运行以下命令：

     docker-compose -f docker-compose-with-marathon.yml up -d
     

3. 启动后，可以使用默认的登录凭据来访问系统：

   • 用户名：jackhammer@olacabs.com
   • 密码：j4ckh4mm3r

3. 项目的配置文件介绍

项目的配置主要通过config.yml文件进行，以下是配置文件的一些关键部分：

• database：定义数据库连接参数，如数据库类型、主机、端口、用户名和密码等。
• server：定义服务器的端口和其他相关设置。
• scanners：配置项目中使用的各种安全扫描工具的相关参数。
• users：定义用户的角色和权限。
• severity_levels：定义漏洞严重性级别的配置。

确保根据实际情况调整config.yml中的配置项，以适应不同的部署环境。

jackhammer Jackhammer - One Security vulnerability assessment/management tool to solve all the security team problems. 项目地址: https://gitcode.com/gh_mirrors/ja/jackhammer