deployer/README.md

61 lines
1.3 KiB
Markdown
Raw Normal View History

2013-07-11 18:40:44 +04:00
Introduction
------------
2014-07-04 16:41:55 +04:00
[![Build Status](https://travis-ci.org/elfet/deployer.png?branch=master)](https://travis-ci.org/elfet/deployer)
2013-07-13 14:33:11 +04:00
2014-07-04 16:41:55 +04:00
There are a lot of deployment tools, even in php. But none of them are simple and functional like Deployer.
2013-07-13 14:33:11 +04:00
2014-07-05 14:14:58 +04:00
Create `deploy.php` in your project:
```php
require 'recipe/symfony.php';
server('main', 'domain.com')
->user('you')
->pubKey();
server('test', 'test.domain.com')
->user('you');
task('deploy:done', function () {
write('Deploy done!');
});
after('deploy', 'deploy:done');
2014-07-05 14:14:58 +04:00
```
And run command:
```
dep deploy
```
Done! You just deploy your project.
2013-07-11 18:40:44 +04:00
Requirements
------------
2014-07-05 13:51:56 +04:00
Deployer is only supported on PHP 5.4.0 and up (yes, it's time to grow up).
Deployer work with ssh2 pecl extension, but if you do not install it on you machine - do not worry,
Deployer will work with [PHPSecLib](https://github.com/phpseclib/phpseclib).
2013-07-11 18:40:44 +04:00
Installation
------------
2013-07-11 19:04:08 +04:00
2014-07-05 13:51:56 +04:00
To install Deployer use [Composer](https://getcomposer.org):
```
composer global require elfet/deployer:dev-master
```
2014-07-05 13:54:11 +04:00
Make sure what `~/.composer/vendor/bin` in your `PATH`.
2014-07-05 13:51:56 +04:00
Install via PHAR: TODO
Documentation
-------------
2014-07-05 13:54:11 +04:00
Documentation can be found on site [deployer.in](http://deployer.in).
2014-07-05 13:51:56 +04:00
2013-07-11 19:00:21 +04:00
License
-------
2013-07-13 14:33:11 +04:00
Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php