概述
Bulwark是一款针对企业和组织机构的组织资产和漏洞管理工具,该工具继承了Jira,旨在帮助企业安全从业人员生成关于组织内部的应用程序安全报告。
需要注意的是,该项目目前还处于前期开发阶段,因此可能会存在运行不稳定的情况。
工具下载
代码语言:javascript复制git clone https://github.com/softrams/bulwark.git
使用Docker启动
首先,我们需要在本地环境中安装好Docker【阅读原文下载】。
接下来,创建一个.env文件,并提供下列参数配置:
代码语言:javascript复制MYSQL_DATABASE="bulwark"
MYSQL_PASSWORD="bulwark"
MYSQL_ROOT_PASSWORD="bulwark"
MYSQL_USER="root"
MYSQL_DB_CHECK="mysql"
DB_PASSWORD="bulwark"
DB_URL="172.16.16.3"
DB_ROOT="root"
DB_USERNAME="bulwark"
DB_PORT=3306
DB_NAME="bulwark"
DB_TYPE="mysql"
NODE_ENV="production"
DEV_URL="http://localhost:4200"
PROD_URL="http://localhost:5000"
JWT_KEY="changeme"
JWT_REFRESH_KEY="changeme"
CRYPTO_SECRET="changeme"
CRYPTO_SALT="changeme"
构建并启动Bulwark容器:
代码语言:javascript复制docker-compose up
开启/停止Bulwark容器:
代码语言:javascript复制docker-compose start
docker-compose stop
移除Bulwark容器:
代码语言:javascript复制docker-compose down
此时,我们可以访问localhost:5000来使用Bulwark。
本地安装
代码语言:javascript复制$ git clone https://github.com/softrams/bulwark.git
$ cd bulwark
$ npm install
以开发模式运行:
代码语言:javascript复制$ npm run start:dev
以生产模式运行:
代码语言:javascript复制$ npm start
环境变量
在项目根目录中创建一个.env文件,应用程序将使用dotenv来解析这个文件。
DB_PASSWORD
代码语言:javascript复制DB_PASSWORD="somePassword"
这个变量用于设置数据库密码。
DB_USERNAME
代码语言:javascript复制DB_USERNAME="foobar"
这个变量用于设置数据库用户名。
DB_URL
代码语言:javascript复制DB_URL=something-foo-bar.dbnet
这个变量用于设置数据库URL地址。
DB_PORT
代码语言:javascript复制DB_PORT=3306
这个变量用于设置数据库端口号。
DB_NAME
代码语言:javascript复制DB_NAME="foobar"
这个变量用于设置数据库名称。
DB_TYPE
代码语言:javascript复制DB_TYPE="mysql"
这个应用程序使用的是MySQL来作为数据库。
NODE_ENV
代码语言:javascript复制NODE_ENV=production
这个变量用于设置节点环境。
代码语言:javascript复制DEV_URL="http://localhost:4200"
如果需要使用不同端口,可配置该参数。
代码语言:javascript复制PROD_URL="http://localhost:5000"
如果需要使用不同端口,可配置该参数。
JWT_KEY
代码语言:javascript复制JWT_KEY="changeMe"
这个变量用于设置JWT凭证。
JWT_REFRESH_KEY
代码语言:javascript复制JWT_REFRESH_KEY="changeMe"
这个变量用于刷新JWT凭证。
CRYPTO_SECRET
代码语言:javascript复制CRYPTO_SECRET="randomValue"
这个变量用于设置Scrypt密码。
CRYPTO_SALT
代码语言:javascript复制CRYPTO_SECRET="randomValue"
这个变量用于设置Scrypt盐值。
空.env文件模板
代码语言:javascript复制DB_PASSWORD=""
DB_URL=""
DB_USERNAME=""
DB_PORT=3306
DB_NAME=""
DB_TYPE=""
NODE_ENV=""
DEV_URL="http://localhost:4200"
PROD_URL="http://localhost:5000"
JWT_KEY=""
JWT_REFRESH_KEY=""
CRYPTO_SECRET=""
CRYPTO_SALT=""
创建初始数据库迁移
首先,我们需要使用下列命令来创建初始数据库迁移:
代码语言:javascript复制$ npm run migration:init
接下来,运行初始数据库迁移:
代码语言:javascript复制$ npm run migration:run
默认凭证
我们需要在初始安装过程中创建一个用户账号,凭证如下:
代码语言:javascript复制电子邮箱:admin@example.com
密码:changeMe
首次登录时,别忘了在账号配置中更新默认的用户密码。
Bulwark基于下列项目开发实现
Typeorm Angular Express
许可证协议
本项目的开发与发布遵循MIT开源许可证协议。
项目地址
Bulwark:【GitHub传送门】