Skip to content

Latest commit

 

History

History
128 lines (87 loc) · 5.78 KB

features.md

File metadata and controls

128 lines (87 loc) · 5.78 KB
Raw

Architecture | Features | Examples | Environment variables | Volumes

Documentation: Features

☆ Automated mass Virtual hosts

  1. Automated virtual hosts can be enabled by providing the following environment variable to the docker container MASS_VHOST_ENABLE=1.
  2. You should mount a local project directory into the Docker under /shared/httpd (-v /local/path:/shared/httpd).
  3. You can optionally specify a global server name suffix via e.g.: -e MASS_VHOST_TLD_SUFFIX=.loc
  4. You can optionally specify a global subdirectory from which the virtual host will servve the documents via e.g.: -e MASS_VHOST_DOCROOT_DIR=www
  5. Allow the Docker to expose its port via -p 80:80.
  6. Have DNS names point to the IP address the container runs on (e.g. via /etc/hosts)

With the above described settings, whenever you create a local directory under your projects dir such as /local/path/mydir, there will be a new virtual host created by the same name http://mydir. You can also specify a global suffix for the vhost names via -e MASS_VHOST_TLD_SUFFIX=.loc, afterwards your above created vhost would be reachable via http://mydir.loc.

Just to give you a few examples:

Assumption: /local/path is mounted to /shared/httpd

Directory MASS_VHOST_DOCROOT_DIR MASS_VHOST_TLD_SUFFIX Serving from (*) Via
work1/ htdocs/ /local/path/work1/htdocs http://work1
work1/ www/ /local/path/work1/www http://work1
work1/ htdocs/ .loc /local/path/work1/htdocs http://work1.loc
work1/ www/ .loc /local/path/work1/www http://work1.loc

(*) This refers to the directory on your host computer

Assumption: /tmp is mounted to /shared/httpd

Directory MASS_VHOST_DOCROOT_DIR MASS_VHOST_TLD_SUFFIX Serving from (*) Via
api/ htdocs/ /tmp/api/htdocs http://api
api/ www/ /tmp/api/www http://api
api/ htdocs/ .test.com /tmp/api/htdocs http://api.test.com
api/ www/ .test.com /tmp/api/www http://api.test.com

(*) This refers to the directory on your host computer

You would start it as follows:

docker run -it \
    -p 80:80 \
    -e MASS_VHOST_ENABLE=1 \
    -e MASS_VHOST_DOCROOT_DIR=www \
    -e MASS_VHOST_TLD_SUFFIX=.loc \
    -v /local/path:/shared/httpd \
    devilbox/apache-2.4

☆ Automated PHP-FPM setup

PHP-FPM is not included inside this Docker image, but can be enabled to contact a remote PHP-FPM server. To do so, you need to configure one of the two backends (main or mass vhost).

# Create a test script
mkdir -p www/htdocs
echo '<?php echo "it works";' > www/htdocs/index.php

# Start a PHP-FPM server
docker run -d -it \
    --name phpserver \
    -v $(pwd)/www:/var/www/default \
    devilbox/php-fpm:8.2-base

# Start the webserver
# Where 'phpserver' is the hostname or IP address of the PHP-FPM server
docker run -it \
    -p 80:80 \
    -v $(pwd)/www:/var/www/default \
    -e MAIN_VHOST_BACKEND='conf:phpfpm:tcp:phpserver:9000' \
    --link phpserver \
    devilbox/apache-2.4

☆ Automated Reverse Proxy Setup

Reverse Proxies are configured in a similar way to how PHP-FPM is setup as a remote backend. All you have to do is to specify the backend in the following form:

MAIN_VHOST_BACKEND:conf:rproxy:<protocol>:<server-addr>:<server-port>

Where <procotol> can by one of http, https, ws or wss (depending what your backend provides. <server-addr> and <serer-port> specify the hostname, IPv4 or IPv6 address of your upstream server, followed by its TCP port.

Note: When specifying ws or wss, the webserver will automatically be configured to be capable of communicating with web sockets.

☆ Customization per virtual host

Each virtual host is generated from templates by vhost-gen. As vhost-gen is really flexible and allows combining multiple templates, you can copy and alter an existing template and then place it in a subdirectory of your project folder. The subdirectory is specified by MASS_VHOST_TEMPLATE_DIR.

Assumption: /local/path is mounted to /shared/httpd

Directory MASS_VHOST_TEMPLATE_DIR Templates are then read from (*)
work1/ cfg/ /local/path/work1/cfg/
api/ cfg/ /local/path/api/cfg/
work1/ conf/ /local/path/work1/conf/
api/ conf/ /local/path/api/conf/

(*) This refers to the directory on your host computer

☆ Customization for the default virtual host

The default virtual host can also be overwritten with a custom template. Use MAIN_VHOST_TEMPLATE_DIR variable in order to set the subdirectory to look for template files.

☆ Disabling the default virtual host

If you only want to server you custom projects and don't need the default virtual host, you can disable it by -e MAIN_VHOST_ENABLE=0.