Wallogit.com
2017 © Pedro Peláez
This skeleton allows to have a working Laravel or Lumen application running inside a Docker container completely out of the box, and configurable through environment variables., (*1)
make or make run will run the project as web servicemake command ARGS={your command} will execute your arguments as a Artisan commandXDEBUG_ env varscurl -o- -s -L https://gbmcarlos.com/skellington.sh | bashEvery project reads its environment variables from the file src/.env, which is not tracked in the repository by git. A list of the required environment variables is kept in the file src/.env.example., (*2)
This project makes use of gbmcarlos/toolkit as a library, which is installed as a git submodule., (*3)
When working on the web service, use make or make logs. This script will:, (*4)
When working on a background process, use make command ARGS={your command}. This script will do the same as make logs, but instead of spinning up the web server, it will run the specified Artisan command with the given options. For example, (*5)
./local/run.sh my-command
These environment variables are used to configure how the project is built and ran, and they are given a default value optimized for production in the Dockerfile. Makefile gives them a default value optimized for local development which overrides the one in the Dockerfile., (*6)
| ENV VAR | Default value production \production \ | local) | Description |
|---|---|---|---|
| APP_PORT | 80 | The port Docker will use as the host port in the network bridge. This is the external port, the one you will use to call your app. | |
| APP_DEBUG | true |
Use to toggle the application debug configuration | |
| APP_NAME | Name of the project's root folder | Used to name the docker image and docker container. | |
| APP_RELEASE | Current commit hash `HEAD` / latest
|
Used at build time to persist the environment variable into the image. | |
| BASIC_AUTH_ENABLED |
true / false
|
Enables Basic Authentication with Nginx. If enabled, it will use htpasswd with BASIC_AUTH_USERNAME and BASIC_AUTH_PASSWORD to encrypt with bcrypt cost 10. |
|
| BASIC_AUTH_USERNAME | admin | Username for the Basic Auth | |
| BASIC_AUTH_PASSWORD |
APP_NAME_password |
Password for the Basic Auth | |
| XDEBUG_ENABLED |
false / true
|
Enables Xdebug inside the container. | |
| XDEBUG_REMOTE_HOST | host.docker.internal | Used as the xdebug.remote_host PHP ini configuration value. |
|
| XDEBUG_REMOTE_PORT | 10000 | Used as the xdebug.remote_port PHP ini configuration value. |
|
| XDEBUG_IDE_KEY |
APP_NAME_PHPSTORM |
Used as the xdebug.idekey PHP ini configuration value. |
|
APP_PORT=8000 BASIC_AUTH_ENABLED=true BASIC_AUTH_USERNAME=user BASIC_AUTH_PASSWORD=secure_password XDEBUG_ENABLED=true make
To run a arbitrary command inside your web service container, you can do so with:, (*7)
docker exec -it {container-name} bash -c "{command}"
Or you can execute an interactive terminal in the container with:, (*8)
docker exec -it {container-name} bash
When installing a new package let Composer choose the exact version by running composer require {package} inside the container see the "Running commands" section. Then extract the composer.json and composer.lock from inside the container see the "Updating dependencies" section., (*9)
To update the dependencies, run composer update inside the web service container see the "Running commands" section. Then extract the composer.lock file with:, (*10)
docker cp {container-name}:/var/task/composer.lock .
To update the NPM dependencies, run npm update inside the web service container see the "Running commands" section. Then extract the package-lock.json file with:, (*11)
docker cp {container-name}:/var/www/package-lock.json .
Then you can copy the result into your .env as the value of the variable APP_KEY, (*12)
Even though the project runs inside a Docker container, it still provides support for debugging with Xdebug. By telling Xdebug the remote location of your IDE and configuring this one to listen to a certain port, they can communicate with one another., (*13)
Use the XDEBUG_ environment variables to configure your project's debugging. The default values on the local start-up scripts are optimized for PhpStorm on Mac., (*14)
Check this documentation to configure your IDE. Use the XDEBUG_ and APP_NAME environment variables and the path mappings:, (*15)
/var/task/src
/opt/vendor
This project is licensed under the terms of the MIT license., (*16)