deployer/README.md

76 lines
3.0 KiB
Markdown
Raw Normal View History

2016-11-11 21:04:26 +07:00
<p align="center">
2016-11-11 21:29:20 +07:00
<a href="https://deployer.org" target="_blank"><img width="243" src="https://raw.githubusercontent.com/deployphp/deployer.org/master/public/images/deployer.png?v2"></a>
2016-11-11 21:04:26 +07:00
</p>
2016-11-11 21:16:51 +07:00
<p align="center">
<a href="https://travis-ci.org/deployphp/deployer"><img src="https://travis-ci.org/deployphp/deployer.svg?branch=master" alt="Build Status"></a>
<a href="https://scrutinizer-ci.com/g/deployphp/deployer/"><img src="http://img.shields.io/scrutinizer/g/deployphp/deployer.svg?style=flat" alt="Code Quality"></a>
<a href="https://packagist.org/packages/deployer/deployer"><img src="https://img.shields.io/packagist/dt/deployer/deployer.svg" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/deployer/deployer"><img src="http://img.shields.io/packagist/v/deployer/deployer.svg?style=flat" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/deployer/deployer"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License"></a>
</p>
## About Deployer
2013-07-13 14:33:11 +04:00
2014-10-17 16:56:26 +04:00
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/69072898-df4a-4dee-ab05-c2ae83d6c469/big.png)](https://insight.sensiolabs.com/projects/69072898-df4a-4dee-ab05-c2ae83d6c469)
2014-08-13 13:21:13 +04:00
Deployer is a deployment tool written in PHP.
2013-07-13 14:33:11 +04:00
2016-10-25 15:30:04 +07:00
See [deployer.org](https://deployer.org) for more information and documentation.
2014-07-05 14:14:58 +04:00
2016-10-25 15:30:04 +07:00
Support Deployer development by [![Becoming a patron](https://img.shields.io/badge/become-patron-brightgreen.svg)](https://www.patreon.com/deployer)
2015-06-03 12:22:29 +07:00
2016-11-11 21:04:26 +07:00
## Requirements
2016-03-19 22:44:01 +07:00
* PHP 5.5.0 and up.
2014-11-29 22:39:25 +03:00
That's all!
2015-05-14 19:13:57 +07:00
You can enable [sockets](http://php.net/manual/en/book.sockets.php) to speedup deployment process with parallel deployment.
2014-08-13 13:21:13 +04:00
2016-11-11 21:04:26 +07:00
## Installation
2016-10-25 15:23:35 +07:00
To install Deployer download [deployer.phar](https://deployer.org/deployer.phar) archive and move deployer.phar to your bin directory and make it executable.
2014-07-05 13:51:56 +04:00
2015-06-18 10:11:15 +02:00
``` sh
2016-11-13 00:18:18 +07:00
curl -LO https://deployer.org/deployer.phar
mv deployer.phar /usr/local/bin/dep
chmod +x /usr/local/bin/dep
2015-06-18 10:11:15 +02:00
```
2014-07-12 16:50:13 +04:00
To upgrade Deployer run command:
2015-06-18 10:11:15 +02:00
``` sh
2016-11-13 00:18:18 +07:00
dep self-update
2015-06-18 10:11:15 +02:00
```
2014-07-05 13:51:56 +04:00
2014-07-12 16:50:13 +04:00
Or via composer:
2014-07-05 13:51:56 +04:00
2015-06-18 10:11:15 +02:00
``` sh
2016-11-13 00:18:18 +07:00
composer require deployer/deployer
2015-06-18 10:11:15 +02:00
```
2014-07-05 13:51:56 +04:00
2016-11-11 21:04:26 +07:00
## Documentation
2015-01-21 11:13:11 +03:00
Documentation source can be found in [deployphp/docs](https://github.com/deployphp/docs) repository.
2014-07-05 13:51:56 +04:00
2016-11-11 21:04:26 +07:00
## Roadmap
2016-11-08 18:23:08 +07:00
* Better documentation.
* Better DX with intelligible errors.
2016-11-05 18:04:16 +07:00
* Better parallel task runner based on https://github.com/icicleio/icicle
* Task grouping for parallel execution.
* Task combining for less ssh calls.
* Implement `dep status` command with health-check of running application and deployment log.
2016-11-05 18:04:16 +07:00
* More deploy strategies.
* More integration with third-party services.
* Web-based client.
2015-05-14 19:13:57 +07:00
2016-11-11 21:04:26 +07:00
## Maintainers
2016-03-20 00:02:04 +07:00
* Anton Medvedev [@elfet](https://github.com/elfet)
* Oanh Nguyen [@oanhnn](https://github.com/oanhnn)
See also the list of [contributors](https://github.com/deployphp/deployer/graphs/contributors) who participated in this project.
2015-09-17 12:56:22 +07:00
2016-11-11 21:04:26 +07:00
## Support
2016-10-25 15:23:35 +07:00
Deployer is an open source project. If you want to support the development of Deployer visit our [patreon page](https://www.patreon.com/deployer).
2016-11-11 21:04:26 +07:00
## License
Licensed under the [MIT license](http://opensource.org/licenses/MIT).