Laradhoc is a Docker-based basic LEMP development environment designed for Laravel applications.
Looking for a similar Docker environment for WordPress? Then give a try to Dockpress!
Preferisci leggere in italiano? 🇮🇹
- Nginx
- PHP (7.2 / 7.3 / 7.4) with OPCache
- MySQL / MariaDB
- phpMyAdmin
- Mailhog
- Redis
- Custom domain name (es.
http://laradhoc.test
orhttps://laradhoc.test
) - HTTP or HTTPS (with self-signed SSL certificate)
- npm
- gulp (for old projects)
You can choose which version of PHP (for example, 7.4
) to run by setting $PHP_VERSION
variable in your
.env
file (see .env.example
for details).
Likewise, you can choose your database (for example, MariaDB 10.2
) by setting $DATABASE_IMAGE
variable in your
.env
file (see .env.example
for details)
In case you want to customize your Docker configuration (e.g. adding some mount),
just run cp docker-compose.yml docker-compose.override.yml
then edit your
docker-compose.override.yml
. It will be used by Docker.
- MacOS, Linux or Windows with WSL
- Docker
openssl
(when using HTTPS)
Just clone this repo.
Let's pretend your Laravel application will be accessible at laradhoc.test
:
git clone git@github.com:eleftrik/laradhoc.git laradhoc.test
cd laradhoc.test
Create an .env
file from .env.example
cp .env.example .env
# Customize every variable according to your needs
# See comments to each variable in .env.example file
According to the value of ${APP_HOST}
, add your test domain (e.g. laradhoc.test
) to your hosts file
sudo /bin/bash -c 'echo -e "127.0.0.1 laradhoc.test" >> /etc/hosts'
Choose if you want to run your application over HTTP or HTTPS.
- HTTPS: set
NGINX_ENABLE_HTTPS=1
- HTTP: set
NGINX_ENABLE_HTTPS=0
With HTTPS enabled, a self-signed SSL certificate will be generate.
Under .docker/images/nginx/ssl
you will find
${APP_HOST}.test.crt
${APP_HOST}.test.key
NOTE: you need to import/install the .crt
file so it will be trusted by
your operating system / browser.
Build all Docker containers and start them
.docker/scripts/init
Ok, let's talk now about your Laravel application!
New or existing?
New Laravel project from scratch? No problem, just run:
./.docker/scripts/install-laravel
A fresh Laravel app will be downloaded in ${APP_SRC}
, configured and available at http://${APP_HOST}
or https://${APP_HOST}
Do you have an existing Laravel Project?
Just copy it or clone it into ${APP_SRC}
so your Laravel application
is inside that directory.
Then run:
./.docker/scripts/init-laravel
Laradhoc will search for an .env
file (if not found, it will try to copy .env.example
).
Then, it will update your Laravel .env
with the values taken from
the main .env
file.
After this, it will install Composer dependencies and a key will
be generated by the usual Artisan command.
Remember to run manually your migrations / seeds:
./.docker/scripts/artisan migrate --seed
Do whatever your Laravel application needs to run correctly. For example:
./.docker/scripts/artisan passport:install --force
./.docker/scripts/node npm install && ./.docker/scripts/node npm run dev
- etc.
Finished working? Just stop everything:
./.docker/scripts/stop
Next time you need to run your application, if you haven't changed any setting, just run
.docker/scripts/start
Please note Nginx will proxy all request from socket.io
to laravel-echo
container.
When updating from a previous version, follow these steps:
-
update your code
- via
git pull
if you're still referencing this repository, a fork or a private one - manually downloading the desired release
In both cases, the
src/
folder won't be affected - via
-
see
CHANGELOG.md
-
update your
./.env
file according to./.env.example
(new variables may have been introduced) -
if you have overridden
docker-compose.yml
usingdocker-compose.override.yml
, seedocker-compose.yml
to check if something has added, changed or deleted, compared to the previous version ofdocker-compose.yml
you were using before updating -
launch
.docker/scripts/start --build
Laradhoc provides some useful scripts, located in .docker/scripts
.
Run them from your Laradhoc base folder.
.docker/scripts/init
It will
- check
openssl
is installed on your host machine (if you setNGINX_ENABLE_HTTPS=1
) - create a self-signed certificate (if you set
NGINX_ENABLE_HTTPS=1
) - build and start the containers
.docker/scripts/start
It's a shortcut to
docker-compose up -d
You can add the flag --build
if you want to build the images, otherwise
.docker/scripts/start
is enough to bring up the environment
Tired of working? Stop the environment
.docker/scripts/stop
It's useful to bring up a new Laravel project.
It will prepare a fresh Laravel app in your ${APP_SRC}
,
create a ${APP_SRC}/.env
file holding the same values which are in the main .env
file
.docker/scripts/install-laravel
Update the Laravel .env
with the environment values coming from
the main .env
file
.docker/scripts/init-laravel
It will execute an artisan command inside the php-fpm container. For example:
.docker/scripts/artisan make:migration create_example_table
It will execute a composer command through the composer
container.
For example:
.docker/scripts/composer install
It will execute commands through the node
container.
For example:
.docker/scripts/node yarn run production
Need to run some "old" project still using gulp
?
No problem: this command will run Gulp and compile
your assets.
For example:
.docker/scripts/gulp watch
Want to throw away anything?
This command will stop all containers, delete volumes and the entire $APP_SRC
.
So, before executing this command, BE SURE you understood very well that you're going to lose all your Laravel codebase and the related database!
.docker/scripts/nah
To throw away anything and start again from the scratch, use
.docker/scripts/nah && .docker/scripts/init && .docker/scripts/wp-install
You can use phpMyAdmin: http://${APP_HOST}:${PHPMYADMIN_PORT}
For example: http://laradhoc.test:8080
You can connect to your database via command line or using a tool.
For example, from the command line:
source .env
mysql -u$MYSQL_USER -p$MYSQL_PASSWORD -h127.0.0.1 $MYSQL_DATABASE
I bet you prefer to use your favorite tool, for example:
- TablePlus
- SequelPro
- HeidiSQL
etc.
Just use the parameters stored in your .env file.
To catch all outgoing emails via MailHog, configure your Laravel .env
file
with these parameters:
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=
MAIL_PASSWORD=
MailHog web interface is available at
http://${APP_HOST}:${MAILHOG_PORT}
For example: http://laradhoc.test:8081
Suggestions, reviews, bug reports are very welcome. We never stop learning :-)
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Thanks to Mauro Cerone for the inspiration