Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antonioribeiro/deeployer
Deploy your Laravel applications via Github or Bitbucket Hooks
https://github.com/antonioribeiro/deeployer
deployment laravel php
Last synced: 5 days ago
JSON representation
Deploy your Laravel applications via Github or Bitbucket Hooks
- Host: GitHub
- URL: https://github.com/antonioribeiro/deeployer
- Owner: antonioribeiro
- License: mit
- Created: 2014-01-04T21:02:43.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-02-18T16:26:52.000Z (almost 10 years ago)
- Last Synced: 2024-11-07T16:25:56.109Z (13 days ago)
- Topics: deployment, laravel, php
- Language: PHP
- Homepage:
- Size: 394 KB
- Stars: 146
- Watchers: 14
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Deeployer
[](https://packagist.org/packages/pragmarx/deeployer)
#### Automatically deploy Laravel applications every time it's pushed to the remote repository
Deployment via git webhooks is a common functionallity of most PaaS these days. This package is intended to be used for those that are hosting their websites in VPS, dedicated server or any other hosting provider that doesn't support web hooks.
Since this package uses Laravel remote (SSH-2) functionality to remote or locally deploy applications, your deployment app can be in one server and deploy applications to others, as many as you need.
#### Compatibility
This package currently works with
- Github
- Bitbucket
### Using it with Laravel Envoy
Define an url for your deployer to be used, in Github you can find this at Settings > Service Hooks > WebHook URLs > URL, example:
```
http://deployer.yoursite.io/deploy
```
Create a route in your application for the deployer url:
```
Route::post('deploy', function()
{
return Deeployer::run();
});
```
If you are using Laravel Envoy, install it and create tasks using your project url and the branch as the task name:
```
@task('https://github.com/you/repo-name:master', ['on' => ['localhost']])
touch /tmp/envoy-passthrough.txt
@endtask
```
And that's it, you're good to go! Configure your webook, push something and wait for it.
### Normal Usage
If you prefer to use Deeployer own deployment system, edit the file `app/config/packages/pragmarx/deeployer/config.php` and create your projects. In my opinion, is better to not use the `master` branch while automatically deploying apps:
```
'projects' => array(
array(
'ssh_connection' => 'yoursite-staging',
'git_repository' => 'https://github.com/yourname/yoursite.io',
'git_remote' => 'origin',
'git_branch' => 'staging',
'remote_directory' => '/var/www/vhosts/yoursite.io/staging/',
'composer_update' => true,
'composer_optimize_autoload' => true,
'composer_extra_options' => '',
'composer_timeout' => 60 * 5, // 5 minutes
'artisan_migrate' => false,
'post_deploy_commands' => array(
'zsh send-deployment-emails.sh',
),
),
),
```
Create the remote connection by editing `app/config/remote.php`:
```
'connections' => array(
'yoursite-staging' => array(
'host' => 'yoursite.com:22', <-- you can set a different SSH port if you need
'username' => 'root', <-- the user you use to deploy applications on your server
'password' => 'Bassw0rt',
'key' => '', <-- key files are safer than passwords
'root' => '/var/www', <-- you can ignore this, deployment path will be changed by Deeployer
),
),
```
Go to your server and `tail` the log file:
```
php artisan tail
```
Add that url to Github or Bitbucket.
Push something to your branch to automatically deploy your application:
```
git pull origin master:testing
git pull origin master:staging
git pull origin master:production
```
If you are just testing, in Github you can press 'Test Hook' button, after saving your URL.
### Installation
#### Requirements
- Laravel 4.1+
- Composer >= 2014-01-07 - This is a PSR-4 package
- SSH-2 Server
#### Installing
First, you need to be sure you have a Composer that supports PSR-4, so execute
```
composer self-update
```
or
```
sudo composer self-update
```
Require the Deeployer package:
```
composer require pragmarx/deeployer dev-master
```
Once this operation completes, add the service provider to your app/config/app.php:
```
'PragmaRX\Deeployer\Vendor\Laravel\ServiceProvider',
```
Publish and edit the configuration file:
```
artisan config:publish pragmarx/deeployer
```
### TODO
- Create a deployment artisan command, to manually deploy something troubled.
- Tests, tests, tests.
- Bitbucket is not done yet. (DONE!)
### Author
Antonio Carlos Ribeiro - -
### License
Deeployer is licensed under the MIT License - see the `LICENSE` file for details
### Contributing
Pull requests and issues are more than welcome.