Download the PHP package node-link/cakephp-git-deploy without Composer
On this page you can find all versions of the php package node-link/cakephp-git-deploy. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package cakephp-git-deploy
GitDeploy plugin for CakePHP
Plugin to operate automatic git-pull server with CakePHP 3 (Using WebHook from GitHub, GitLab and Bitbucket)
Requirements
- CakePHP 3.5 or later
- PHP 5.6 or later
Installation
1. Install plugin
You can install this plugin into your CakePHP application using composer.
The recommended way to install composer packages is:
2. Load plugin
Please load the plugin manually as follows:
Prior to 3.6.0, you should use Plugin::load()
:
Or, use bin/cake
to load the plugin as follows:
Configuration
Edit config/.env
or config/app.php
.
The full default configuration is as follows:
It is recommended to add following items to config/.env
.
It may not work unless COMPOSER_HOME
is set correctly.
Settings
GitHub
In your repository, navigate to Settings → Webhooks → Add webhook, and use the following settings:
- Payload URL: https://example.com/git-deploy
- Content type: application/json
- Secret: The value of
GIT_DEPLOY_TOKEN
inconfig/.env
- Which events would you like to trigger this webhook?: :radio_button: Just the push event
- Active: :ballot_box_with_check:
Click "Add webhook" to save your settings, and the script should start working.
GitLab
In your repository, navigate to Settings → Integrations, and use the following settings:
- URL: https://example.com/git-deploy
- Secret Token: The value of
GIT_DEPLOY_TOKEN
inconfig/.env
- Trigger: :ballot_box_with_check: Push events
- Enable SSL verification: :ballot_box_with_check: (only if using SSL, see GitLab's documentation for more details)
Click "Add webhook" to save your settings, and the script should start working.
Bitbucket
In your repository, navigate to Settings → Webhooks → Add webhook, and use the following settings:
- Title: Git Deploy
- URL: https://example.com/git-deploy?token=
GIT_DEPLOY_TOKEN
- Active: :ballot_box_with_check:
- SSL / TLS: :white_large_square: Skip certificate verification (only if using SSL, see Bitbucket's documentation for more details)
- Triggers: :radio_button: Repository push
Click "Save" to save your settings, and the script should start working.
Trouble Shooting
If execution is not successful, please refer to logs/error.log
and logs/debug.log
.
Details of the error at the time of execution may be listed in some cases.
Permissions
When it does not work well, in many cases, there is a problem with permissions.
Please set so that the web server user (www
, www-data
, apache
, etc...) can git pull
and composer install
.
It is suggested this be accomplished by changing the repository group to the web server user's and giving the group write permissions:
- Open a terminal to the directory containing the repository on the server.
- run
sudo chown -R yourusername:webserverusername project-dir/
to change the group of the repo. - run
sudo chmod -R g+s project-dir/
to make the group assignment inherited for new files/dirs. - run
sudo chmod -R 775 project-dir/
to set read & write for both owner and group.
SSH
Generate an SSH key and add it to your account so that git pull can be run without a password.
Reporting Issues
If you have a problem with the GitDeploy plugin, please send a pull request or open an issue on GitHub.
Also, I would appreciate it if you contribute to updating README.md
file.