kenjis/codeigniter-deployer

A Deployment Tool for CodeIgniter 3.0

Installs: 9 024

Dependents: 0

Suggesters: 1

Security: 0

Stars: 52

Watchers: 9

Forks: 24

Open Issues: 0

Type:project

dev-master / 1.0.x-dev 2015-07-13 10:36 UTC

This package is auto-updated.

Last update: 2020-09-23 04:11:41 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License

A Deployment Tool for CodeIgniter 3.0.

You can deploy CodeIgniter with one command.

This is based on Deployer 3.0.

Folder Structure

codeigniter/
└── deploy/
     ├── deploy.php ... config file for Deployer
     ├── deploy.sh  ... script to deploy
     └── logs/

Requirements

  • PHP 5.4.0 or later
  • Composer
  • Git
  • SSH
  • Shell

Installation

Install this project with Composer:

$ cd /path/to/codeigniter/
$ composer require kenjis/codeigniter-deployer:1.0.x@dev --dev

Install deploy folder to your CodeIgniter application folder:

$ php vendor/kenjis/codeigniter-deployer/install.php
  • Above command always overwrites exisiting files.
  • You must run it at CodeIgniter project root folder.

Configuration

Configure deploy/deployer.php.

Servers

// Your production server
server('prod', 'your.server.example.com', 22)
    ->user('username')
    ->forwardAgent()
    ->stage('production')
    ->env('branch', 'master')
    ->env('deploy_path', '/var/www/your-codeigniter-app');

See https://github.com/deployphp/docs/blob/master/servers.md for details.

Repository

// Your Git repository
set('repository', 'git@github.com:org/your-codeigniter-app.git');

You need git command on your servers, and make sure you can git clone on the servers.

Reference

Configure Your Servers

Apache

See the sample below. In this case, /var/www/your-codeigniter-app is a base folder.

your-codeigniter-app/
├── current -> /var/www/your-codeigniter-app/releases/20150529181638
└── releases/
     ├── 20150529180505/
     ├── 20150529181203/
     └── 20150529181638/

Each deployment is installed in releases/YYYYMMDDHHMMSS folder.

The current release is your-codeigniter-app/current folder, and it is a symbolic link to releases/20150529181638 folder.

So if you use codeigniter-composer-installer's folder structure, your Apache configuratoin is like this:

DocumentRoot /var/www/your-codeigniter-app/current/public

If you use CodeIgniter as the default folder structure, your Apache configuratoin is like this:

DocumentRoot /var/www/your-codeigniter-app/current

sudo

Deployer will try to get write permission with the sudo command, so this command has to be running without prompt password and without tty.

Here is an example of configuration:

Defaults:username !requiretty

username   ALL=(ALL) NOPASSWD: /usr/bin/setfacl

If you don't need sudo for your deployment, you can set in deploy/deployer.php.

set('writable_use_sudo', false);

How to Deploy

$ cd /path/to/codeigniter/
$ cd deploy/
$ sh deploy.sh

Related Projects for CodeIgniter 3.0