Repository files navigation

A pretty simplified Docker Compose workflow that sets up a LEMP network of containers for local Laravel development. You can view the full article that inspired this repohere.

To get started, make sure you haveDocker installed on your system, and then clone this repository.

Next, navigate in your terminal to the directory you cloned this, and spin up the containers for the web server by runningdocker-compose up -d --build app.

After that completes, follow the steps from thesrc/README.md file to get your Laravel project added in (or create a new blank one).

Note: Your MySQL database host name should bemysql,notlocalhost. The username and database should both behomestead with a password ofsecret.

Bringing up the Docker Compose network withapp instead of just usingup, ensures that only our site's containers are brought up at the start, instead of all of the command containers as well. The following are built for our web server, with their exposed ports detailed:

• nginx -:80
• mysql -:3306
• php -:9000
• redis -:6379
• mailhog -:8025

Three additional containers are included that handle Composer, NPM, and Artisan commandswithout having to have these platforms installed on your local computer. Use the following command examples from your project root, modifying them to fit your particular use case.

• docker-compose run --rm composer update
• docker-compose run --rm npm run dev
• docker-compose run --rm artisan migrate

If you encounter any issues with filesystem permissions while visiting your application or running a container command, try completing one of the sets of steps below.

If you are using your server or local environment as the root user:

• Bring any container(s) down withdocker-compose down
• Replace any instance ofphp.dockerfile in the docker-compose.yml file withphp.root.dockerfile
• Re-build the containers by runningdocker-compose build --no-cache

If you are using your server or local environment as a user that is not root:

• Bring any container(s) down withdocker-compose down
• In your terminal, runexport UID=$(id -u) and thenexport GID=$(id -g)
• If you see any errors about readonly variables from the above step, you can ignore them and continue
• Re-build the containers by runningdocker-compose build --no-cache

Then, either bring back up your container network or re-run the command you were trying before, and see if that fixes it.

By default, whenever you bring down the Docker network, your MySQL data will be removed after the containers are destroyed. If you would like to have persistent data that remains after bringing containers down and back up, do the following:

1. Create amysql folder in the project root, alongside thenginx andsrc folders.
2. Under the mysql service in yourdocker-compose.yml file, add the following lines:

volumes:  - ./mysql:/var/lib/mysql

While I originally created this template for local development, it's robust enough to be used in basic Laravel application deployments. The biggest recommendation would be to ensure that HTTPS is enabled by making additions to thenginx/default.conf file and utilizing something likeLet's Encrypt to produce an SSL certificate.

This configuration should be able to compile assets with bothlaravel mix andvite. In order to get started, you first need to add --host 0.0.0.0 after the end of your relevant dev command inpackage.json. So for example, with a Laravel project using Vite, you should see:

"scripts": {"dev":"vite --host 0.0.0.0","build":"vite build"},

Then, run the following commands to install your dependencies and start the dev server:

• docker-compose run --rm npm install
• docker-compose run --rm --service-ports npm run dev

After that, you should be able to use@vite directives to enable hot-module reloading on your local Laravel application.

Want to build for production? Simply rundocker-compose run --rm npm run build.

The current version of Laravel (9 as of today) uses MailHog as the default application for testing email sending and general SMTP work during local development. Using the provided Docker Hub image, getting an instance set up and ready is simple and straight-forward. The service is included in thedocker-compose.yml file, and spins up alongside the webserver and database services.

To see the dashboard and view any emails coming through the system, visitlocalhost:8025 after runningdocker-compose up -d site.