README.md

TNT Devbox

TNT Devbox is a starter kit for local development using docker containers. To understand the principles behind TNT Devbox checkout the guide.

Installation

Clone this git repository to your development root directory. For example: /Users/myusername/devbox/www and make the create-project script executable

$ chmod +x ./docker/bin/create-project.sh

Creating a project

$ ./docker/bin/create-project.sh project-a.test

Seeding a database

While you run your db container for the first time, you can create and seed a database.

Inside ./docker/mysql/seeds put a database dump file. This will run only once Note that your dump file needs to contain a create database statement, otherwise, the import won't work.

CREATE DATABASE IF NOT EXISTS projectdb;
USE projectdb;

Adding custom configuration file to nginx

Sometimes, your projects needs to have some rewrite rules or you migth add SSL certificates to your local development. All this can be setup in ./docker/nginx/conf.d/project-name.test. In the bellow example, we're adding certificates:

server {
    server_name project-name.test;

    listen 443 ssl;
    listen 80;
    
    root /var/www/$http_host/public;

    ssl_certificate /etc/ssl/certs/project-name.test.crt; 
    ssl_certificate_key /etc/ssl/certs/project-name.test.key;

    error_log  /var/log/nginx/$http_host-error.log;
    access_log /var/log/nginx/$http_host-access.log; 

    location ~ \.php$ {
        fastcgi_pass   project-name.test:9000;
        fastcgi_index  index.php;
        fastcgi_param  SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include        fastcgi_params;
    }

    location / {
        index       index.html index.htm index.php;
        try_files   $uri $uri/ /index.php?$query_string;
    }
}

Adding a custom php.ini

If you need some custom PHP settings you can do this by changing ./docker/php/local.ini Example:

upload_max_filesize=128M
post_max_size=128M

Changing PHP versions for a project

The Dockerfile in the project directory defines the PHP version. But lets suppose you want to uprade php from 7.4 to 8.0 to see if your application is working fine. Position yourself in the project directory and change the Dockerfile begging to FROM php:8.0-fpm

now run docker build --tag=projectname.test:8.0 . while in the project directory. After that, open the docker-compose.yml file from the root directory and change the projectname.test service to:

image: projectname.test:8.0

Now you're application is running on PHP 8

Get shell access to a container

While in the root directoy, simply run:

$ docker-compose exec project.test bash

or if you want to run only one command, you can execute it directly

$ docker-compose exec project.test php -v