Version: 8.x

How to Deploy a Codeigniter 4 Project

require 'recipe/codeigniter4.php';

Source

Deployer is a free and open source deployment tool written in PHP. It helps you to deploy your Codeigniter 4 application to a server. It is very easy to use and has a lot of features.

Three main features of Deployer are:

Provisioning - provision your server for you.
Zero downtime deployment - deploy your application without a downtime.
Rollbacks - rollback your application to a previous version, if something goes wrong.

Additionally, Deployer has a lot of other features, like:

Easy to use - Deployer is very easy to use. It has a simple and intuitive syntax.
Fast - Deployer is very fast. It uses parallel connections to deploy your application.
Secure - Deployer uses SSH to connect to your server.
Supports all major PHP frameworks - Deployer supports all major PHP frameworks.

You can read more about Deployer in Getting Started.

The deploy task of Codeigniter 4 consists of:

deploy:prepare – Prepares a new release
- deploy:info – Displays info about deployment
- deploy:setup – Prepares host for deploy
- deploy:lock – Locks deploy
- deploy:release – Prepares release
- deploy:update_code – Updates code
- deploy:env – Configure .env file
- deploy:shared – Creates symlinks for shared files and dirs
- deploy:writable – Makes writable dirs
deploy:vendors – Installs vendors
spark:optimize – Optimize for production.
spark:migrate – Locates and runs all new migrations against the database.
deploy:publish – Publishes the release
- deploy:symlink – Creates symlink to release
- deploy:unlock – Unlocks deploy
- deploy:cleanup – Cleanup old releases
- deploy:success – Deploys your project

The codeigniter4 recipe is based on the common recipe.

Configuration

public_path

Source

Overrides public_path from recipe/provision/website.php.

Default Configurations

Default value

'public'

shared_dirs

Source

Overrides shared_dirs from recipe/deploy/shared.php.

Default value
['writable']

shared_files

Source

Overrides shared_files from recipe/deploy/shared.php.

Default value
['.env']

writable_dirs

Source

Overrides writable_dirs from recipe/deploy/writable.php.

Default value
[
    'writable/cache',
    'writable/debugbar',
    'writable/logs',
    'writable/session',
    'writable/uploads',
]

log_files

Source

Default value

'writable/logs/*.log'

codeigniter4_version

Source

Default value
$result = run('{{bin/php}} {{release_or_current_path}}/spark');
preg_match_all('/(\d+\.?)+/', $result, $matches);
return $matches[0][0] ?? 5.5;