# code6

**Repository Path**: west_lake_free/code6

## Basic Information

- **Project Name**: code6
- **Description**: 码小六（code6）是一款 GitHub 代码泄露监控系统，通过定期扫描 GitHub 发现代码泄露行为，为企业安全保驾护航！ 系统特点 全可视化界面，操作简单 支持 GitHub
- **Primary Language**: PHP
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/code6
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 9
- **Created**: 2020-06-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

![码小六](https://raw.githubusercontent.com/4x99/snapshot/master/code6/logo.png)

![license](https://img.shields.io/github/license/4x99/code6?color=%231890FF&style=flat-square)
![release](https://img.shields.io/github/v/release/4x99/code6?color=%231890FF&sort=semver&style=flat-square)
![stars](https://img.shields.io/github/stars/4x99/code6?color=%231890FF&style=flat-square)
![forks](https://img.shields.io/github/forks/4x99/code6?color=%231890FF&style=flat-square)
![watchers](https://img.shields.io/github/watchers/4x99/code6?color=%231890FF&style=flat-square)

码小六是一款 GitHub 代码泄露监控系统，通过定期扫描 GitHub 发现代码泄露行为，为企业安全保驾护航！

</div>

---

## 系统特点
- 全可视化界面，操作简单
- 支持 GitHub 令牌管理及智能调度
- 扫描结果信息丰富，支持批量操作
- 任务配置灵活，可单独配置任务扫描参数
- 支持白名单模式，主动忽略白名单仓库

---

## 运行环境
- Linux
- PHP >= 7.3.0
- Composer
- MySQL >= 5.7
- Apache >= 2.4

---

## 系统界面
请点击浏览大图 :P

![登录页面](https://raw.githubusercontent.com/4x99/snapshot/master/code6/login.png)

![应用概况](https://raw.githubusercontent.com/4x99/snapshot/master/code6/home.png)

![扫描结果](https://raw.githubusercontent.com/4x99/snapshot/master/code6/code-leak.png)

---

## 安装指南

### 克隆代码
```
git clone https://github.com/4x99/code6.git <项目目录>
```

### 配置 Apache
请确保已开启 `mod_rewrite` 模块
```
<VirtualHost *:80>
    ServerName <ServerName>
    DocumentRoot "<项目目录>/public"
</VirtualHost>
```

### 下载依赖包
安装 Composer：
```
curl -O https://mirrors.aliyun.com/composer/composer.phar
chmod +x composer.phar
mv composer.phar /usr/local/bin/composer
```

配置阿里云镜像：
```
composer config repo.packagist composer https://mirrors.aliyun.com/composer/
```

下载项目依赖包：
```
cd <项目目录> && composer install --no-dev --prefer-dist --optimize-autoloader
```

### 项目配置
设置目录权限：
```
chmod -R 755 storage
chown -R <用户名>:<组名> storage
```

创建配置文件：
```
cp .env.example .env
```

生成应用密钥：
```
php artisan key:generate
```

创建并配置数据库：
```
vim .env
```
```
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=
DB_USERNAME=
DB_PASSWORD=
```

自动生成表结构：
```
php artisan migrate
```

### 配置任务调度
```
crontab -e -u <用户>
```

```
* * * * * cd <项目目录> && php artisan schedule:run >> /dev/null 2>&1
```

### 创建用户
```
php artisan code6:user-add <邮箱> <密码>
```

如需查看用户列表或删除用户请执行：
```
php artisan code6:user-list
php artisan code6:user-delete <邮箱>
```

### 配置令牌与任务
进入系统后请前往 `[ 令牌配置 ]` 和 `[ 任务配置 ]` 模块进行配置，配置完毕即可使用！