https://github.com/terminal42/deployer-recipes

Tools and recipes for deployer.org
https://github.com/terminal42/deployer-recipes

Last synced: 23 days ago
JSON representation

Tools and recipes for deployer.org

• Host: GitHub
• URL: https://github.com/terminal42/deployer-recipes
• Owner: terminal42
• License: mit
• Created: 2019-03-06T09:19:03.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2022-03-26T12:49:17.000Z (almost 3 years ago)
• Last Synced: 2024-11-14T21:42:37.848Z (about 2 months ago)
• Language: PHP
• Size: 3.72 MB
• Stars: 10
• Watchers: 8
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# terminal42 deployer recipes

This repository contains recipes to integrate with [deployer](https://github.com/deployphp/deployer).

## Installing

```

composer require deployer/recipes terminal42/deployer-recipes:dev-main@dev --dev

```

## Usage

### Include recipes manually

Include recipes in your `deploy.php` file:

```php

require 'recipe/contao.php';

require 'recipe/database.php';

require 'recipe/deploy.php';

require 'recipe/encore.php'; // or 'recipe/gulp.php';

require 'recipe/maintenance.php';

``` 

### Bootstrap file

Copy [`deploy-hosts.yml`](bootstrap/deploy-hosts.yml) to your project root and one of 

the [bootstrap files](bootstrap) as your `deploy.php` file:

1. [`contao4-encore.php`](bootstrap/contao4-encore.php) – Contao 4 setup with Encore for assets management

2. [`contao4-gulp.php`](bootstrap/contao4-gulp.php) – Contao 4 setup with Gulp for assets management

## Pro Tips

### Disable releases

If you would like to disable the releases (e.g. for a dev system) you can do it simply by including the recipe:

```php

require 'recipe/disable-releases.php';

``` 

### Contao Manager

Although Contao Manager seems to be redundant if the system can be deployed, you may still want to install it

e.g. for [trakked.io](https://www.trakked.io). To do that, simply add the following task to the list:

```diff

task('deploy', [

    // …

    'maintenance:enable',

+   'contao:download_manager'

    // …

])->desc('Deploy your project');

```

### Database Helpers (Restore and release)

This collection provides a tasks to easily restore/release the database `dev <-> live` unidirectionally.

First, include the `database-helpers.php` recipe.

You can use the command `dep database:retrieve example.com` to download a database dump from remote (example.com) and overwrite the local database.

You can use the command `dep database:release example.com` to overwrite the remote (example.com) datbase with the local one.

## Further Reading

- https://deployer.org/docs/

- https://deployer.org/recipes.html

- https://github.com/eikona-media/deployer-recipes

## License

Licensed under the [MIT license](https://github.com/terminal42/deployer-recipes/blob/master/LICENSE).