SecHub/README.md
2026-05-30 10:20:22 +08:00

148 lines
3.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# SecHub - 网络安全工具集
![SecHub](assets/imgs/favicon.ico)
## 项目简介
SecHub 是一个面向网络安全领域的工具集合系统,提供多种网络安全工具的集中管理。该项目采用 JSON 存储工具信息,通过 PHP 网页界面实现工具的展示与访问,为安全研究人员和从业者提供一站式的工具导航平台。
## 功能特性
- 🛠️ **工具分类管理**:按类别组织网络安全工具,便于查找和使用
- 🔍 **智能搜索**:支持全局搜索和栏目内搜索,快速定位所需工具
- 🌓 **主题切换**:支持白天/黑夜模式切换,保护视力
- 📱 **响应式设计**:适配各种屏幕尺寸,移动端友好
- 💾 **数据持久化**:使用 SQLite 数据库存储工具信息,提高查询效率
- 🔄 **自动同步**JSON 数据变更时自动同步到数据库
- 📥 **数据导出**:支持下载原始 JSON 数据文件
## 技术栈
- **后端**: PHP
- **数据库**: SQLite
- **前端**: HTML, CSS, JavaScript
- **数据存储**: JSON 文件
- **架构**: JSON 驱动架构
## 项目结构
```
SecHub/
├── assets/
│ ├── css/
│ │ └── style.css # 样式文件
│ ├── db/
│ │ └── sechub.db # SQLite 数据库
│ ├── imgs/
│ │ ├── beian.png # 备案图标
│ │ └── favicon.ico # 网站图标
│ └── json/
│ └── template.json # json模板
├── db.php # 数据库管理类
├── index.php # 主页面
└── search.php # 搜索 API
```
## 部署方式
### 环境要求
- PHP 7.0+
- PDO SQLite 扩展
- Web 服务器Apache/Nginx
### 快速部署
1. 克隆或下载本项目
2. 将项目文件放置于 Web 服务器根目录
3. 确保 `assets/db/` 目录具有写入权限
4. 访问 `index.php` 即可使用
### 权限设置
确保以下目录具有写入权限:
```bash
chmod 755 assets/db/
```
## 使用说明
### 添加新工具
在对应的 JSON 文件中添加工具信息,格式如下:
```json
[
{
"section": "安全工具"
},
{
"name": "工具名称",
"url": "https://example.com",
"description": "工具描述"
}
]
```
### 搜索功能
- **全局搜索**:在顶部搜索框输入关键词,实时显示所有栏目中的匹配结果
- **栏目搜索**:在每个栏目内的搜索框输入关键词,仅在该栏目中搜索
### 主题切换
点击右上角的月亮/太阳图标切换白天/黑夜模式,系统会记住您的选择。
## 数据格式
每个 JSON 文件包含一个数组,第一个元素定义栏目名称,后续元素为具体的工具信息:
```json
[
{
"section": "栏目名称"
},
{
"name": "工具名称",
"url": "工具链接",
"description": "工具描述"
}
]
```
## 核心功能说明
### 数据库同步机制
系统采用智能同步机制,仅在 JSON 文件修改时间超过 5 分钟时才更新数据库,避免频繁读写影响性能。
### 搜索算法
支持对工具名称、描述和 URL 进行模糊搜索,提供实时的搜索结果反馈。
### 响应式设计
采用现代 CSS Grid 布局,自动适配不同屏幕尺寸,提供良好的移动端体验。
## 许可证
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情
## 联系方式
- 项目主页: [https://git.masonliu.com/MasonLiu/SecHub](https://git.masonliu.com/MasonLiu/SecHub)
- 作者: MasonLiu
- 邮箱: [您的邮箱地址]
## 备案信息
**示例网站:**[sehub.masonliu.com](https://sechub.masonliu.com)
- ICP 备案号: 蜀ICP备2026025173号
- 公安备案号: 川公网安备51162302000285号
---
© 2026 SecHub - Gaming Master Cybersecurity | MasonLiu