Back to Portfolio

Gitlab Autodeploy

Automatically deploy your web app repositories on "git push".

PHP
Live DemoSource Code

Project Details

GitLab AutoDeploy

A new and completely rewritten version is available at GitLab AutoDeploy V2

Author: Afaan Bilal

Project Page: afaan.me/gitlab-autodeploy

Introduction

GitLab AutoDeploy is a PHP script to easily deploy web app repositories on git push or
any other hook. It is based on a similar script I wrote for GitHub.

Features

  • No SSH access required.
  • No shell access required.
  • Fully compatible with shared servers.
  • Public, internal and private repos are supported.

Setup

  1. Download gitlab-autodeploy.php.
  2. Update the [PRIVATE_TOKEN] and [REPO_ID] with your GitLab Private token and Project ID.
  3. Set the deploy directory by replacing [DEPLOY_DIR] relative to the script.
  4. Set your timezone.
  5. Upload the script to your server.
  6. On GitLab, add a WebHook to your repo for a push event (or any other) and
    set it to the uploaded script.
  7. You're done!

Now, whenever you git push to your gitlab repo, it will be automatically deployed
to your web server!

Getting your Private Token and Project ID

  1. Your private token can be found in your GitLab profile in Profile Settings » Account.
  2. For your project ID, go to https://gitlab.com/api/v3/projects/?private_token=PRIVATE-TOKEN
    (Replace PRIVATE-TOKEN with your private token)
  3. Find your project in the returned JSON and copy the ID associated with it.

Adding a WebHook

You must have administrative access to the repo for adding WebHooks

  1. Go to your GitLab repo » Settings » Web Hooks.
  2. Enter the URL of the gitlab-autodeploy.php script in the URL field.
  3. If your server does not use SSL, then uncheck Enable SSL Verification.
  4. Leave everything else as is, click Add Web Hook.
  5. You're done!

Contributing

All contributions are welcome. Please create an issue first for any feature request
or bug. Then fork the repository, create a branch and make any changes to fix the bug
or add the feature and create a pull request. That's it!
Thanks!

License

GitLab AutoDeploy is released under the MIT License.
Check out the full license here.

License

The MIT License (MIT)

Copyright (c) 2012-2016 Afaan Bilal, AMX Infinity!

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.