ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2024-12-22 14:12:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
ed2d12dbba
devilbox/docs/Usage.md

16 KiB
Raw Blame History

Devilbox Documentation

Overview | Quickstart | Install | Update | Configure | Run | Usage | OS | Backups | Examples | Technical | Hacking | FAQ

Usage

  1. Mounted directories
  2. Work on the Docker host
  3. Work inside the PHP container
    1. As devilbox user
    2. As root user
    3. Available tools
    4. Available URLs
  4. Managing Projects explained
    1. How does it work?
    2. Directory structure explained
  5. Creating new Projects
    1. From Docker Host
    2. From inside the PHP container
    3. Using symlinks
    4. Adding DNS records
      1. /etc/hosts
      2. Auto-DNS
  6. Switching container versions
    1. Httpd versions
    2. PHP versions
    3. SQL versions
    4. NoSQL versions
  7. Emails
  8. Log files
    1. Mounted logs
    2. Docker logs
  9. Intranet
    1. Overview
    2. vHosts
    3. Tools

1. Mounted directories

Mounted directories are the bridge between the container and your host computer. All your projects will be available on your host computer as well as inside the Docker container.

That makes it possible to work from the Docker host, by for example editing your files with your favorite editor/IDE and to run any commands, such as npm, composer or others inside the PHP container with the correct PHP version.

2. Work on the Docker host

If you do not need to run any command line tools manually (composer, node, etc), it is sufficient to stay on the host. All you need is a browser and an editor/IDE.

  1. Open your browser at http://localhost
  2. Open your project inside your editor
  3. Start coding

Note: If you want to do some command-line PHP tasks and you have PHP installed on your host, make sure it is the same version as your currently started PHP Docker container. If not, just enter the PHP Docker and do the tasks there.

You could however also invoke the Docker's PHP executeable (or any other binary) from your host via:

# Call a generic command
$ docker-compose exec --user devilbox php <command>
       |           |         |         |        | 
      use        execute    use     container  the
 docker-compose    cmd    built-in    name     actual
                  on the    user       to      command
                  docker   devilbox   exec     to
                 container            command  execute

Here is an example to list the PHP inside the container from the Docker host.

# Print PHP version
$ docker-compose exec --user devilbox php php -v

However, instead of having to type all of the above for a simple command execution, you might be better off to simply enter the PHP container and work on a normal shell. Going into the container is as simple as this:

$ ./shell.sh

Read more about this in the next section.

3. Work inside the PHP container

If you need to run some command line tasks manually such as drush, composer or anything similar which is not available on your host computer, you can do that inside the PHP container, which comes with lots of useful pre-install tools.

The situation inside the container is not different from on the Docker host. All services and port bindings are available there as well on 127.0.0.1. Read up on Technical to find out more about the syncronization of both.

FYI: You will always find your projects inside the PHP container at /shared/httpd/.

3.1 As devilbox user

In the devilbox git directory you will find a bash script called shell.sh. Just execute this script and it will take you directly into the PHP docker container at the project root directory.

host> ./shell.sh
devilbox@php-7.0.19 in /shared/httpd $

As you can see, the PS1 prompt will also show you the current configured PHP version.

3.2 As root user

In case you need to perform some tasks that are only possible with root rights (such as installing or updating software), you can do so via password-less sudo.

host> ./shell.sh
devilbox@php-7.0.19 in /shared/httpd $ sudo su -
root@php-7.0.19 in /shared/httpd $

Note: Performing installations and updates are only temporary for the current session. Any change will be lost at the next start/restart of the devilbox. If you permanently require additional software refer to Hacking.

3.3 Available tools

For your convenience a few selected tools have been pre-installed in their current version that you can use for your daily development tasks. Some of them are:

Binary Tool name
composer composer
drush drush
drupal drupal-consol
git git
laravel laravel installer
mysqldump-secure mysqldump-secure
node node
npm npm
phalcon phalcon devtools
symfony symfony installer
wp wp-cli

The complete list of tools including their version can be found at the PHP docker containers git repository Readme:

PHP 5.4 | PHP 5.5 | PHP 5.6 | PHP 7.0 | PHP 7.1 | PHP 7.2 | HHVM

If you permanently require additional software refer to Hacking.

If you think additional tools should always be bundled, create an issue.

3.4 Available URLs

Your projects will be available by the same URL as they are available from your docker host computer. There is no need to edit the PHP container's /etc/hosts file, as it is automatically provide via the DNS container bind.

For example, by doing curl http://project1.loc from either your host computer or from inside the PHP container will return the same URL.

4. Managing Projects explained

Devilbox setup and workflow

4.1 How does it work?

Creating new projects is really simple and just involves a few steps.

  1. Create a new project folder for your VirtualHost
  2. Create a subfolder named htdocs/ for the DocumentRoot
  3. Create a DNS record pointing to your VirtualHost (via /etc/hosts)

The project folder will be the name of your VirtualHost. The htdocs/ folder holds all files that will be server by the VirtualHost (called DocumentRoot). The DNS record will be the domain name that points to the webserver's IP address (127.0.0.1).

4.2 Directory structure explained

Your project folder is determined by the value of HOST_PATH_TO_HTTPD_DATADIR which can be set in .env. The default is ./data/www.

Location Project directory
Host system HOST_PATH_TO_HTTPD_DATADIR (default: ./data/www)
PHP Docker /shared/httpd
HTTPD Docker /shared/httpd

What directory structure is required to serve a new project?

  1. Each folder inside your project directory is an independent VirtualHost.
  2. Each VirtualHost folder requires the htdocs/ folder which is the DocumentRoot.

In order to make the following examples easier let's work with some assumed default values. The first one represents the project base directory and the second one is for the project domains.

  1. HOST_PATH_TO_HTTPD_DATADIR=./data/www
  2. TLD_SUFFIX=loc
VirtualHost directory DocumentRoot directory URL
./data/www/project1 ./data/www/project1/htdocs http://project1.loc
./data/www/project2 ./data/www/project2/htdocs http://project2.loc
./data/www/wordpress ./data/www/wordpress/htdocs http://wordpress.loc

The VirtualHost directory make a new VirtualHost available under the specified URL. However the actual files that will be served are always expected to be in a subfolder called htdocs/. By having an additional sub-directory for the Document root you are able to store non-www files inside the project folder and even symlink you www dir to htdocs.

5. Creating new Projetcs

This is a general overview about creating projects. If you want to see some real examples how to setup Wordpress, Drupal, CakePHP, Yii, Symfony and others, visit the Example Section.

5.1 From Docker host

The following will create a VirtualHost for http://project1.loc.

# replace HOST_PATH_TO_HTTPD_DATADIR with the actual project base dir
$ cd HOST_PATH_TO_HTTPD_DATADIR
$ mkdir project1
$ mkdir project1/htdocs

If you want to know how to change the TLD_SUFFIX loc to something else, refer to Configure.

5.2 From inside the PHP container

If you prefer to work directly inside the PHP Docker container, you can do the same. The following will create a VirtualHost for http://project1.loc.

$ cd /shared/httpd
$ mkdir project1
$ mkdir project1/htdocs

If you want to know how to go into the PHP container, check the section above 2. Work inside the PHP container.

5.3 Using symlinks

Instead of creating a htdocs/ folder explicitly, you can also make a symlink by the same name. This is required as some frameworks have nested www folders.

Keep the actual versioned wordpress name and symlink it to htdocs.

$ ls -l
drwxrwxr-x 2 cytopia 4096 Jun 14 08:29 wordpress-4.8
lrwxrwxrwx 1 cytopia   11 Jun 14 08:29 htdocs -> wordpress-4.8/

CakePHP serves its files from a nested folder, a symlink is required here.

$ ls -l
drwxrwxr-x 2 cytopia 4096 Jun 14 08:29 cakephp
lrwxrwxrwx 1 cytopia   11 Jun 14 08:29 htdocs -> cakephp/app/webroot/

5.4 Adding DNS record

In order to actually visit the newly created project in your browser, there must be a DNS entry pointing to the webserver's listening IP address. This can either be done automatically by a DNS server or you can do it manually for each project by editing your /etc/hosts file every time you create a new project.

5.4.1 /etc/hosts

If you have not setup Auto-DNS, you will need to create your own DNS records for every project. Let's assume your TLD_SUFFIX is set to loc.

Project folder /etc/hosts entry
my-project1 127.0.0.1 my-project1.loc
drupal-test 127.0.0.1 drupal-test.loc
playground 127.0.0.1 playground.loc
5.4.2 Auto-DNS

When using the devilbox built-in DNS server, there is nothing to do. DNS catch-all records for your TLD_SUFFIX exist and will always point to 127.0.0.1. See Configure for how to setup Auto-DNS.

6. Switching container versions

Being able to combine all kinds of different container version is one of the main goals of the devilbox. Changing the versions is kept simple and consistent for all container.

  1. Open the .env file in your favorite editor
  2. Find the *_SERVER= block for the container to change the version
  3. Comment all lines you do not want to activate
  4. Uncomment the one line you want to use.
  5. Restart the devilbox for the changes to take effect

Be aware that if multiple lines are uncommented, the last one takes effect.

For an in-depth explanation about how to configure each service, you should have a look at Configure.

6.1 Httpd versions

  1. Open the .env file in your favorite editor
  2. Find the HTTPD_SERVER= block

You can choose between Apache and Nginx in different version. All of them are configured to work the same, there is nothing to worry about when changing them.

6.2 PHP versions

  1. Open the .env file in your favorite editor
  2. Find the PHP_SERVER= block

You can choose between different PHP versions and HHVM.

Important: Keep in mind that if you have a custom php.ini config at ./cfg/php-*/, it is only effective for one version. Custom php configurations are separted per version.

6.3 SQL versions

  1. Open the .env file in your favorite editor
  2. Find the MYSQL_SERVER= or PGSQL_SERVER= block

Important: Each version has a different data directory. This is a security precautions. Imagine you startup MySQL 5.5 for the first time. New databases will be created. Now you startup MySQL 8. All existing databases would be upgraded to work flawlessly with MySQL 8, however this is not downwards compatible. So by startup up MySQL 5.5 again, it would say the database is corrupt.

6.4 NoSQL versions

  1. Open the .env file in your favorite editor
  2. Find the MONGO_SERVER=, 'MEMCD_SERVER= orREDIS_SERVER=` block

There is nothing to pay attention to here.

7. Emails

All your projects can send emails to whatever recipient. You do not have to worry that they will actually being sent. Each PHP container runs a local postfix mailserver that intercepts all outgoing mails and puts them all in the local devilbox user mail account.

In order to view sent emails open up the devilbox intranet http://localhost/mail.php. There you can also test email sending and verify that they really stay locally.

8. Log files

8.1 Mounted logs

Log files are available on the Host system and separated per service version. See ./log/ (inside devilbox git directory). The ./log/ folder itself will contain subdirectories in the form <service>-<version> which will then hold all available log files.

Example:

log/
  apache-2.2/
    access_log
    error_log
    localhost-access.log
    localhost-error.log
    other-error.log
  apache-2.4/
    access_log
    error_log
    localhost-access.log
    localhost-error.log
    other-error.log
  mariadb-10.3/
    error.log
    query.log
    slow.log
  php-fpm-7.0/
    php-fpm.err
    www-access.log
    www-error.log

8.2 Docker logs

All output printed to stdout or stderr by the started services will be available in docker logs. In order to view them constantly in a terminal session use:

docker-compose logs -f

Docker logs are currently only being used to display the initial startup including the chosen settings. All other logging is written to file and mounted to the docker host.

9. Intranet

The devilbox bundled intranet is not required for project management or creation, however it offers a few useful tools.

9.1 Overview

The overview page presents you the current state of the running stack and any errors it might have encountered.

http://localhost

9.2 vHosts

The vHost page shows you all available projects and any configuation errors that need to be resolved. Errors could be: missing htdocs/ folder and incorrect DNS settings. So make sure to first visit this page if any of your vHost does not work.

http://localhost/vhosts.php

9.3 Tools

The intranet also offers a few common as well as self-made tools. These include:

  • phpMyAdmin
  • Adminer
  • Mail viewer
  • OpCacheGUI
  • SQL/NoSQL database viewer
  • Info pages (showing detailed configurations for the attached container)

If you are interested in doing database backups, either use phpMyAdmin or Adminer. You can however also use the PHP container itself. Read more about this on Backups