CodeIgniter - Presets
Start a CodeIgniter Project with Docker in 3 Easy Steps
kool create codeigniter my-project
- Update env
kool run setup
Yes, using kool + Docker to create and work on new CodeIgniter projects is that easy!
If you haven't done so already, you first need to install Docker and the kool CLI.
Also, make sure you're running the latest version of kool. Run the following command to compare your local version of kool with the latest release, and, if a newer version is available, automatically download and install it.
$ kool self-update
Please note that it helps to have a basic understanding of how Docker and Docker Compose work to use Kool with Docker.
kool create codeigniter my-project
kool create PRESET FOLDER command to create your new CodeIgniter project:
$ kool create codeigniter my-project
Under the hood, this command will run
composer create-project --no-install --no-scripts --prefer-dist codeigniter4/appstarter my-project using a customized kool Docker image: kooldev/php:7.4.
After installing CodeIgniter,
kool create automatically runs the
kool preset codeigniter command, which helps you easily set up the initial tech stack for your project using an interactive wizard.
$ Preset CodeIgniter is initializing! ? Which app service do you want to use [Use arrows to move, type to filter] > PHP 7.4 PHP 8.0 ? Which database service do you want to use [Use arrows to move, type to filter] > MySQL 8.0 MySQL 5.7 MariaDB 10.5 PostgreSQL 13.0 none ? Which cache service do you want to use [Use arrows to move, type to filter] > Redis 6.0 Memcached 1.6 none $ Preset codeigniter initialized!
Now, move into your new CodeIgniter project:
$ cd my-project
kool preset command auto-generated the following configuration files and added them to your project, which you can modify and extend.
Now's a good time to review the docker-compose.yml file and verify the services match the choices you made earlier using the wizard.
2. Update env
You need to update some default values in CodeIgniter's env file to match the services in your docker-compose.yml file.
MySQL 5.7 and 8.0 or MariaDB 10.5
-DB_CONNECTION=mysql +DB_CONNECTION=pgsql -DB_HOST=127.0.0.1 +DB_HOST=database -DB_PORT=3306 +DB_PORT=5432
In order to avoid permission issues with mysql and mariaDB, add a user other than root and a password to your env file
-DB_USERNAME=root +DB_USERNAME=<some_user> -DB_PASSWORD= +DB_PASSWORD=<somepass>
kool run setup
Say hello to kool.yml, say goodbye to custom shell scripts!
As mentioned above, the
kool preset command added a kool.yml file to your project. Think of kool.yml as a super easy-to-use task helper. Instead of writing custom shell scripts, add your own scripts to kool.yml (under the
scripts key), and run them with
kool run SCRIPT (e.g.
kool run spark). You can add your own single line commands (see
composer below), or add a list of commands that will be executed in sequence (see
To help get you started, kool.yml comes prebuilt with an initial set of scripts (based on the choices you made earlier using the preset wizard), including a script called
setup, which helps you spin up a project for the first time.
scripts: composer: kool exec app composer spark: kool exec app php spark phpunit: kool exec app php ./bin/phpunit setup: - cp env .env - kool start - kool run composer install - kool run spark key:generate reset: - kool run composer install - kool run spark migrate:refresh -f
Go ahead and run
kool run setup to start your Docker environment and finish setting up your project:
# CAUTION: this script will reset your `.env` file with `env` $ kool run setup
As you can see in kool.yml, the
setupscript will do the following in sequence: copy your updated env file to .env; start your Docker environment; use Composer to install vendor dependencies; generate your
.env); and then build your Node packages and assets.
kool run setup finishes, you should be able to access your new site at http://localhost and see the CodeIgniter welcome page. Hooray!
Verify your Docker container is running using the
kool status command.
kool logs app to see the logs from the running
kool logsto see the logs from all running containers. Add the
kool logsto follow the logs (i.e.
kool logs -f app).
Run Commands in Docker Containers
kool exec to execute a command inside a running service container:
# kool exec [OPTIONS] SERVICE COMMAND [--] [ARG...] $ kool exec app ls
kool run spark --help to execute the
kool exec app php spark --help command in your running
app container and print out information about CodeIgniter's CLI commands.
Open Sessions in Docker Containers
Similar to SSH, if you want to open a Bash session in your
app container, run
kool exec app bash, where
app is the name of the service container in docker-compose.yml. If you prefer, you can use
sh instead of
kool exec app sh).
$ kool exec app bash bash-5.1# $ kool exec app sh /app #
Connect to Docker Database Container
You can easily start a new SQL client session inside your running
database container by executing
kool run mysql (MySQL) or
kool run psql (PostgreSQL) in your terminal. This runs the single-line
psql script included in your kool.yml.
Access Private Repos and Packages in Docker Containers
If you need your
app container to use your local SSH keys to pull private repositories and/or install private packages (which have been added as dependencies in your
package.json file), you can simply add
$HOME/.ssh:/home/kool/.ssh:delegated under the
volumes key of the
app service in your docker-compose.yml file. This maps a
.ssh folder in the container to the
.ssh folder on your host machine.
volumes: - .:/app:delegated + - $HOME/.ssh:/home/kool/.ssh:delegated
When it's time to stop working on the project:
$ kool stop
And when you're ready to start work again:
$ kool start
We have more presets to help you start projects with kool in a standardized way across different frameworks.
Missing a preset? Make a request, or contribute by opening a Pull Request. Go to https://github.com/kool-dev/kool/tree/master/presets and browse the code to learn more about how presets work.