CyberEdge 项目安装与使用教程

CyberEdge 项目安装与使用教程

CyberEdge 互联网资产综合扫描/攻击面测绘 项目地址: https://gitcode.com/gh_mirrors/cy/CyberEdge

1. 项目目录结构及介绍

CyberEdge 项目采用了模块化的目录结构，使得项目的组织清晰、维护方便。以下是项目的主要目录及其功能的介绍：

CyberEdge/
├── .github/              # GitHub 工作流文件
├── cmd/                  # 主应用程序的入口和启动代码
├── docs/                 # 项目文档
├── image/                # 项目所需图像资源
├── pkg/                  # 项目核心包，包含业务逻辑和模型定义
├── wordlist/             # 存储字典文件
├── .gitignore            # 指定 Git 忽略的文件和目录
├── Dockerfile.backend    # 后端服务的 Dockerfile
├── Dockerfile.frontend   # 前端服务的 Dockerfile
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── docker-compose.yaml   # 定义和运行多容器 Docker 应用程序
├── generate_env.sh       # 生成环境变量的脚本
├── go.mod                # Go 依赖管理文件
├── go.sum                # Go 依赖校验文件
├── nginx.conf            # Nginx 配置文件
├── start.sh              # 启动项目的脚本

2. 项目的启动文件介绍

项目的启动主要通过 start.sh 脚本进行，以下是 start.sh 脚本的内容及功能介绍：

#!/bin/bash

# 设置环境变量
source generate_env.sh

# 启动 Docker 容器
docker-compose up -d

# 输出启动日志
echo "CyberEdge 服务已启动"
echo "前端界面: http://localhost:47808"
echo "后端 API: http://localhost:31337"

start.sh 脚本会先加载环境变量，然后使用 docker-compose 命令启动后端、前端及所有依赖服务，最后输出访问地址和端口信息。

3. 项目的配置文件介绍

项目的配置主要通过 generate_env.sh 脚本生成环境变量文件，以下是 generate_env.sh 脚本的内容及功能介绍：

#!/bin/bash

# 生成环境变量文件
cat > .env <<EOF
# MongoDB 配置
MONGO_URI=mongodb://mongo:27017/cyberedge

# Redis 配置
REDIS_URL=redis://redis:6379/0

# CyberEdge 后端配置
BACKEND_HOST=localhost
BACKEND_PORT=31337

# CyberEdge 前端配置
FRONTEND_HOST=localhost
FRONTEND_PORT=47808
EOF

generate_env.sh 脚本会创建一个名为 .env 的文件，其中包含了项目运行所需的环境变量，如数据库连接信息、服务端口等。这些变量会被 start.sh 脚本加载，用于配置项目运行时的环境。

CyberEdge 互联网资产综合扫描/攻击面测绘 项目地址: https://gitcode.com/gh_mirrors/cy/CyberEdge