boro/nginx-php-fpm repository overview

⁠Overview

This is a Dockerfile/image to build a container for nginx and php-fpm, with the ability to pull website code from git when the container is created, as well as allowing the container to push and pull changes to the code to and from git. The container also has the ability to update templated files with variables passed to docker in order to update your code and settings. There is support for lets encrypt SSL configurations, custom nginx configs, core nginx/PHP variable overrides for running preferences, X-Forwarded-For headers and UID mapping for local volume support.

If you have improvements or suggestions please open an issue or pull request on the GitHub project page.

⁠Versioning

⁠Links

• https://github.com/ngineered/nginx-php-fpm⁠
• https://registry.hub.docker.com/u/richarvey/nginx-php-fpm/⁠

⁠Quick Start

To pull from docker hub:

docker pull richarvey/nginx-php-fpm

⁠Running

To simply run the container:

sudo docker run -d boro/nginx-php-fpm:php7

You can then browse to http://<DOCKER_HOST> to view the default install files. To find your DOCKER_HOST use the docker inspect to get the IP address.

⁠Available Configuration Parameters

The following flags are a list of all the currently supported options that can be changed by passing in the variables to docker with the -e flag.

• GIT_REPO : URL to the repository containing your source code. If you are using a personal token, this is the https URL without https://, e.g github.com/project/ for ssh prepend with git@ e.g [email protected]⁠:project.git
• GIT_BRANCH : Select a specific branch (optional)
• GIT_EMAIL : Set your email for code pushing (required for git to work)
• GIT_NAME : Set your name for code pushing (required for git to work)
• SSH_KEY : Private SSH deploy key for your repository base64 encoded (requires write permissions for pushing)
• GIT_PERSONAL_TOKEN : Personal access token for your git account (required for HTTPS git access)
• GIT_USERNAME : Git username for use with personal tokens. (required for HTTPS git access)
• WEBROOT : Change the default webroot directory from /var/www/html to your own setting
• ERRORS : Set to 1 to display PHP Errors in the browser
• HIDE_NGINX_HEADERS : Disable by setting to 0, default behaviour is to hide nginx + php version in headers
• PHP_MEM_LIMIT : Set higher PHP memory limit, default is 128 Mb
• PHP_POST_MAX_SIZE : Set a larger post_max_size, default is 100 Mb
• PHP_UPLOAD_MAX_FILESIZE : Set a larger upload_max_filesize, default is 100 Mb
• DOMAIN : Set domain name for Lets Encrypt scripts
• RUN_SCRIPTS : Set to 1 to execute scripts

⁠Dynamically Pulling code from git

To dynamically pull code from git (master branch) when starting:

docker run -d -e 'GIT_EMAIL=email_address' -e 'GIT_NAME=full_name' -e 'GIT_USERNAME=git_username' -e 'GIT_REPO=github.com/project' -e 'GIT_PERSONAL_TOKEN=<long_token_string_here>' boro/nginx-php-fpm:php7

To pull a repository and specify a branch add the GIT_BRANCH environment variable:

docker run -d -e 'GIT_EMAIL=email_address' -e 'GIT_NAME=full_name' -e 'GIT_USERNAME=git_username' -e 'GIT_REPO=github.com/project' -e 'GIT_PERSONAL_TOKEN=<long_token_string_here>' -e 'GIT_BRANCH=stage' richarvey/nginx-php-fpm:latest

⁠Personal Access token

You can pass the container your personal access token from your git account using the GIT_PERSONAL_TOKEN flag. This token must be setup with the correct permissions in git in order to push and pull code.

Since the access token acts as a password with limited access, the git push/pull uses HTTPS to authenticate. You will need to specify your GIT_USERNAME and GIT_PERSONAL_TOKEN variables to push and pull. You'll need to also have the GIT_EMAIL, GIT_NAME and GIT_REPO common variables defined.

⁠Custom Nginx Config files

Sometimes you need a custom config file for nginx to achieve this read the Nginx config guide⁠

⁠Scripting and Templating

Please see the Scripting and templating guide⁠ for more details.

⁠Special Git Features

Specify the GIT_EMAIL and GIT_NAME variables for this to work. They are used to set up git correctly and allow the following commands to work.

⁠Push code to Git

To push code changes made within the container back to git run:

sudo docker exec -t -i <CONTAINER_NAME> /usr/bin/push

⁠Pull code from Git (Refresh)

In order to refresh the code in a container and pull newer code from git run:

sudo docker exec -t -i <CONTAINER_NAME> /usr/bin/pull

⁠Logging and Errors

⁠Logging

All logs should now print out in stdout/stderr and are available via the docker logs command:

docker logs <CONTAINER_NAME>

You can then browse to http://<DOCKER_HOST> to view the default install files. To find your DOCKER_HOST use the docker inspect to get the IP address (normally 172.17.0.2)

For more detailed examples and explanations please refer to the documentation.

⁠Documentation

• Building from source⁠
• Versioning⁠
• Config Flags⁠
• Git Auth⁠
• Personal Access token⁠
• SSH Keys⁠
• Git Commands⁠
• Push⁠
• Pull⁠
• Repository layout / webroot⁠
• webroot⁠
• User / Group Identifiers⁠
• Custom Nginx Config files⁠
• REAL IP / X-Forwarded-For Headers⁠
• Scripting and Templating⁠
• Environment Variables⁠
• Lets Encrypt Support⁠
• Setup⁠
• Renewal⁠
• PHP Modules⁠
• Logging and Errors⁠

⁠Guides

• Running in Kubernetes⁠
• Using Docker Compose⁠