PHPackages                             mikevrind/deployer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [DevOps &amp; Deployment](/categories/devops)
4. /
5. mikevrind/deployer

ActiveLibrary[DevOps &amp; Deployment](/categories/devops)

mikevrind/deployer
==================

Easy deployer for web projects using Gitlab

1.1.11(9y ago)18453[1 issues](https://github.com/mikevrind/deployer/issues)MITPHPPHP &gt;=5.5.9

Since Dec 28Pushed 9y ago3 watchersCompare

[ Source](https://github.com/mikevrind/deployer)[ Packagist](https://packagist.org/packages/mikevrind/deployer)[ RSS](/packages/mikevrind-deployer/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependencies (2)Versions (17)Used By (0)

Deployer
========

[](#deployer)

[![License](https://camo.githubusercontent.com/439cebfacdce33cb4b887f157281f50701e6cdda8bf9b4fd3d92ee6be6e182c0/68747470733a2f2f706f7365722e707567782e6f72672f6d696b657672696e642f6465706c6f7965722f6c6963656e73652e737667)](https://packagist.org/packages/mikevrind/deployer)[![Latest Stable Version](https://camo.githubusercontent.com/8cadd4b8580efc5ab22e1d45c77020232be0d72f8af40a5806f338fa4c272e2c/68747470733a2f2f706f7365722e707567782e6f72672f6d696b657672696e642f6465706c6f7965722f762f737461626c652e737667)](https://packagist.org/packages/mikevrind/deployer)[![Total Downloads](https://camo.githubusercontent.com/f11331f15537cf765c47a4d77bbfbb9392f2f2df0f9ecd29dd39e9f0a3f85d67/68747470733a2f2f706f7365722e707567782e6f72672f6d696b657672696e642f6465706c6f7965722f646f776e6c6f6164732e737667)](https://packagist.org/packages/mikevrind/deployer)

Use this package to automate the deployment process of your Laravel project that are hosted on Gitlab. Just follow the installation instructions. Don't forget to check the configuration file for the deployment options!

Installation
------------

[](#installation)

Require this package with composer:

```
composer require mikevrind/deployer

```

After updating composer, add the DeployerServiceProvider to the providers array in config/app.php

```
MikeVrind\Deployer\DeployerServiceProvider::class,

```

Configuration
-------------

[](#configuration)

The setup of the deployer can (and should be) changed by publishing the configuration file.

You *should* use Artisan to copy the default configuration file from the `/vendor` directory to `/config/deployer.php` with the following command:

```
php artisan vendor:publish --provider="MikeVrind\Deployer\DeployerServiceProvider"

```

It's advised to define the settings via your .env file so that it's possible to change the behavior of the deployer per environment

CSRF Token
----------

[](#csrf-token)

Update the *VerifyCsrfToken* middleware by adding `'_deployer/deploy'` to the `$except` array.
Without this exception, all webhooks will fail because of a missing token in each request.

.env setup
----------

[](#env-setup)

Add the following lines to your .env(.example) file. The `DEPLOYER_REMOTE_*` settings are used to establish a CLI connection with the server.

```
DEPLOYER_ENABLED=true
DEPLOYER_MAIL_ENABLED=true
DEPLOYER_REPO_BRANCH=
DEPLOYER_REPO_PROJECT_ID=
DEPLOYER_REPO_REPOSITORY=

DEPLOYER_REMOTE_HOST=
DEPLOYER_REMOTE_USER=
DEPLOYER_REMOTE_PWD=
DEPLOYER_REMOTE_KEY=
DEPLOYER_REMOTE_KEYTEXT=
DEPLOYER_REMOTE_KEYPHRASE=
DEPLOYER_REMOTE_TIMEOUT=

```

Settings
--------

[](#settings)

### DEPLOYER\_ENABLED (default; false)

[](#deployer_enabled-default-false)

Determines if the deployer should be enabled for this environment

### DEPLOYER\_MAIL\_ENABLED (default; false)

[](#deployer_mail_enabled-default-false)

Determines if after deployment has been completed a mail should be send to the configured recipients

### DEPLOYER\_REPO\_BRANCH (default; master)

[](#deployer_repo_branch-default-master)

Determines to which branch the deployer should listen to when the web hook is fired

### DEPLOYER\_REPO\_PROJECT\_ID (default; 1)

[](#deployer_repo_project_id-default-1)

Determines to which project ID the deployer should listen to when the web hook is fired

### DEPLOYER\_REPO\_REPOSITORY (default; /group/project.git)

[](#deployer_repo_repository-default-gitgitdomaintldgroupprojectgit)

Determines to which project ID the deployer should listen to when the web hook is fired

### DEPLOYER\_REMOTE\_HOST (default; '')

[](#deployer_remote_host-default-)

Determines to which HOST the SSH connection should be established

### DEPLOYER\_REMOTE\_USER (default; '')

[](#deployer_remote_user-default-)

Determines the user that should be used for the SSH connection

### DEPLOYER\_REMOTE\_PWD (optional, default; '')

[](#deployer_remote_pwd-optional-default-)

Determines the password for the user that should be used for the SSH connection

### DEPLOYER\_REMOTE\_KEY (optional, default; '')

[](#deployer_remote_key-optional-default-)

Determines the public\_key filename for the user that should be used for the SSH connection

### DEPLOYER\_REMOTE\_KEYTEXT (optional, default; '')

[](#deployer_remote_keytext-optional-default-)

Determines the public\_key for the user that should be used for the SSH connection

### DEPLOYER\_REMOTE\_KEYPHRASE (optional, default; '')

[](#deployer_remote_keyphrase-optional-default-)

Determines the password for the public\_key

### DEPLOYER\_REMOTE\_TIMEOUT (default; 120)

[](#deployer_remote_timeout-default-120)

Determines how long the connection should wait for your commands. Settings this to `0` will wait indefinitely for your command to finish.

Webhook configuration
---------------------

[](#webhook-configuration)

Open your project and go to Settings -&gt; Web hooks. This package listens to the `_deployer/deploy` route.
So add something like `http(s)://www.domain.tld/_deployer/deploy` as the URL.
In most cases, the `Push events` trigger will be oke to use. Now add the new webhook and you're done!

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

Security
--------

[](#security)

If you discover any (security related) issues, please create an issue in the the issue tracker.

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity18

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~13 days

Recently: every ~32 days

Total

15

Last Release

3645d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/594341?v=4)[Mike de Vrind](/maintainers/MikeVrind)[@mikevrind](https://github.com/mikevrind)

---

Top Contributors

[![mikevrind](https://avatars.githubusercontent.com/u/594341?v=4)](https://github.com/mikevrind "mikevrind (1 commits)")

---

Tags

laravelgitlabdeployer

### Embed Badge

![Health badge](/badges/mikevrind-deployer/health.svg)

```
[![Health](https://phpackages.com/badges/mikevrind-deployer/health.svg)](https://phpackages.com/packages/mikevrind-deployer)
```

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3345.1M337](/packages/psalm-plugin-laravel)[spatie/laravel-prometheus

Export Laravel metrics to Prometheus

2821.5M8](/packages/spatie-laravel-prometheus)[innocenzi/deployer-recipe-forge

Seamless zero-downtime deployment on Forge with Deployer

1916.6k](/packages/innocenzi-deployer-recipe-forge)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
