# Piplin

**Repository Path**: amlove2/Piplin

## Basic Information

- **Project Name**: Piplin
- **Description**: Piplin是一款免费、开源的持续集成与部署系统，适用于软件的自动化构建、测试和部署相关的各种应用场景 - 官方QQ群：656868
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://github.com/Piplin/Piplin
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 117
- **Created**: 2017-12-16
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Fixhub

[![StyleCI](https://styleci.io/repos/67609292/shield)](https://styleci.io/repos/67609292/)
[![Build Status](https://travis-ci.org/Fixhub/Fixhub.svg?branch=master)](https://travis-ci.org/Fixhub/Fixhub)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

Fixhub 是一款基于PHP [Laravel 5.5](http://laravel.com)框架开发的开源Web自动化部署系统。

![Screenshot](http://fixhub.org/fixhub.png)

## Fixhub能做什么？

**注意** Fixhub仍处于并将长期处于初级阶段，下面的部分特性可能还没有100%完成。有任何问题请随时向我们反馈。

* 支持PHP、Python、JAVA、Ruby等项目的发布
* 通过SSH将程序部署到多台服务器上
* 直接从Git仓库克隆项目代码并进行打包、安装
* 执行远程服务器bash命令
* 通过Websocket实现项目部署状态的实时跟踪
* 在服务器保留追溯版本记录，以便快速回滚
* 通过任务计划进行项目健康检测
* 可通过webhook触发部署
* 上线单申请、审核流程
* Slack和邮件通知

## 下一阶段需要实现的功能

- [ ] 通过OAuth2.0实现与自托管的Gitlab账户打通
- [ ] 权限控制
- [ ] 工单，工作流
- [ ] 可视化的统计
- [ ] 完善后台功能
- [ ] API

## 使用到的技术

- [x] Laravel
- [x] Bootstrap
- [x] ionicons
- [x] Node.js
- [x] Beanstalkd
- [x] Redis
- [x] Memcached
- [x] JWT-Auth
- [x] Socket.io
- [x] Supervisor

## 开发使用到的技术

- [x] Gulp
- [x] Sass
- [x] Codception
- [x] PHP CodeSniffer
- [x] PHP Docblock Checker
- [x] PHP CS Fixer
- [x] Travis-ci
- [x] Style-CI
- [x] Gitlab-Ci


## 安装环境要求

- [PHP](http://www.php.net) 7.0.0+或更高(不再支持PHP7以下版本)
- 数据库, 推荐使用[MySQL](https://www.mysql.com) 或 [PostgreSQL](http://www.postgresql.org)。 当然[SQLite](https://www.sqlite.org)也可以运行。
- [Composer](https://getcomposer.org)
- [Redis](http://redis.io)
- [Node.js](https://nodejs.org/)
- [队列系统](http://laravel.com/docs/5.5/queues), 推荐使用[Beanstalkd](http://kr.github.io/beanstalkd/)或Redis。

### 可选项

- 为了确保队列监听、websocket等后台服务的正常运行，推荐使用[Supervisor](http://supervisord.org)
- 缓存服务推荐使用Memcached, 更多的缓存方案选择请看 [caching server](http://laravel.com/docs/5.5/cache).

## 安装手册

一. 克隆代码

```shell
$ git clone https://github.com/fixhub/fixhub.git
```

二. 安装依赖包

```shell
$ composer install -o --no-dev
```

三. 安装socket.io

```shell
$ npm install --production
```

四. 确保storage、bootstrap/cache和public/upload目录可写。

```shell
$ make file-permission
```

五. 拷贝.env.example到.env

```shell
$ cp .env.example .env
```

六. 安装Fixhub

```shell
$ php artisan app:install
```

七. 清除配置缓存

```shell
$ php artisan config:clear
```

八. 将你的服务器根目录指向 `public/`, 请查看 [examples/](/examples) 下的相关配置文件，里面包含 Apache和 nginx的配置范例.

九. 启动web socket，配置相关计划任务.

1、 通过`supervisor`管理Fixhub后台服务，请看 [examples/supervisor.conf](examples/supervisor.conf)

2、 不通过`supervisor`管理Fixhub后台服务，你需要手动启动websocket服务。在Fixhub根目录执行`node socket.js` (目录监听6001端口)。手动设置计划任务请看 [examples/crontab](examples/crontab).

### 升级

一. 获取最新代码

```shell
$ git fetch --all
$ git checkout {latest_tag} // please change me
 ```

二. 更新依赖

```shell
$ composer install -o --no-dev
```

三. 执行Fixhub升级

```shell
$ php artisan app:update
```

## 系统演示

体验Fixhub, 请访问 [Fixhub](http://fixhub.org):

- **用户名:** fixhub 或 `fixhub@fixhub.org`
- **密码:** `fixhub`

> 注意：系统会每5分钟自动重置一次密码，该账号没有权限访问管理功能.

## 开发相关

Fixhub代码里已经自带编译后的前端静态资源，如果你不想修改前端样式，可直接忽略本环节。

工具集：

- Node.js
- Gulp

```shell
npm install
gulp
```

## 鸣谢

- [Laravel](http://laravel.com)
- [Bootstrap](https://github.com/twbs/bootstrap)
- [AdminLTE](https://github.com/almasaeed2010/AdminLTE)
- [Forge](https://forge.laravel.com/)
- [Deployer](https://github.com/REBELinBLUE/deployer)
- [socket.io](https://github.com/socketio/socket.io)
- [ionicons](http://ionicons.com/)

## 软件授权协议

Fixhub is licensed under [The MIT License (MIT)](LICENSE).