ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2025-01-18 18:56:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation: DNS

Browse Source
This commit is contained in:
cytopia 2018-03-27 09:10:07 +02:00
parent 33082a98ed
commit 7d5e4feada
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
6 changed files with 246 additions and 709 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

599
docs/Examples.md
View File

@ -1,599 +0,0 @@
# Devilbox Documentation
[Overview](README.md) |
[Quickstart](Quickstart.md) |
[Install](Install.md) |
[Update](Update.md) |
[Configure](Configure.md) |
[Run](Run.md) |
[Usage](Usage.md) |
[OS](OS.md) |
[Backups](Backups.md) |
Examples |
[Technical](Technical.md) |
[Hacking](Hacking.md) |
[FAQ](FAQ.md)
---
## Examples
1. [Introduction](#1-introduction)
1. [Framework/CMS tools](#11-framework-cms-tools)
2. [Code analysis tools](#12-code-analysis-tools)
2. [Project setup](#2-project-setup)
1. [Setup CakePHP](#21-setup-cakephp)
2. [Setup Drupal](#22-setup-drupal)
3. [Setup Joomla](#23-setup-joomla)
4. [Setup Laravel](#24-setup-laravel)
5. [Setup Phalcon](#25-setup-phalcon)
6. [Setup Symfony](#26-setup-symfony)
7. [Setup Wordpress](#27-setup-wordpress)
8. [Setup Yii](#28-setup-yii)
9. [Setup Zend](#29-setup-zend)
3. [Code analysis](#3-code-analysis)
1. [awesome-ci](#31-awesome-ci)
2. [phpcs](#32-phpcs)
3. [eslint](#33-eslint)
---
## 1. Introduction
The devilbox provides popular tools for setting up and managing major frameworks or content management systems, as well as tools for static code analysis. The following bundled tools are available inside each PHP|HHVM Docker container:
#### 1.1 Framework/CMS tools
You can use the following tools to setup or manage your Frameworks/CMS.
| Binary | Tool name | Framework/CMS |
|------------|-------------------|--------------------|
| `composer` | [composer](https://getcomposer.org) | CakePHPi, Symfony, Yii, Zend and others |
| `drush` | [drush](http://www.drush.org/) | Drupal |
| `drupal` | [drupal-consol](https://drupalconsole.com) | Drupal |
| `git` | [git](https://git-scm.com) | Everything available on github and other git servers |
| `laravel` | [laravel installer](https://github.com/laravel/installer) | Laravel |
| `phalcon` | [phalcon devtools](https://github.com/phalcon/phalcon-devtools) | Phalcon |
| `symfony` | [symfony installer](https://github.com/symfony/symfony-installer) | Symfony |
| `wp` | [wp-cli](https://wp-cli.org/) | Wordpress |
#### 1.2 Code analysis tools
You can use the following tools to analyse and fix your source code files.
| Binary | Tool name | Description |
|------------|-------------------|--------------------|
| `file-cr`, `file-crlf`, `file-empty`, `file-nullbyte-char`, `file-trailing-newline`, `file-trailing-single-newline`, `file-trailing-space`, `file-utf8`, `file-utf8-bom`, `git-conflicts`, `git-ignored`, `inline-css`, `inline-js`, `regex-grep`, `regex-perl`, `syntax-bash`, `syntax-css`, `syntax-js`, `syntax-json`, `syntax-markdown`, `syntax-perl`, `syntax-php`, `syntax-python`, `syntax-ruby`, `syntax-scss`, `syntax-sh` | [awesome-ci](https://github.com/cytopia/awesome-ci) | General file, code and repository analysis and linting (Some of them also support to fix the problems) |
| `phpcs` | [phpcs](https://github.com/squizlabs/PHP_CodeSniffer) | Lint and optionally fix your PHP files |
| `eslint` | [eslint](http://eslint.org/) | Lint and optionally fix your JS files |
## 2. Project Setup
#### 2.1 Setup CakePHP
> **[Official CakePHP Documentation](https://book.cakephp.org/3.0/en/installation.html)**
The following configuration will be used:
| Project name | VirtualHost directory | Database | TLD_SUFFIX | Url |
|--------------|-----------------------|------------|------------|-----|
| my-cake | /shared/httpd/my-cake | my_cake | loc | http://my-cake.loc |
It will be ready in eight simple steps:
1. Enter the PHP container
2. Create a new VirtualHost directory
3. Install CakePHP via `composer`
4. Symlink webroot directory
5. Add MySQL database
6. Configure datbase connection
7. Setup DNS record
8. Visit http://my-cake.loc in your browser
```shell
# 1. Enter the PHP container
host> ./shell.sh
# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-cake
devilbox@php-7.0.20 in /shared/httpd $ cd my-cake
# 3. Install CakePHP via composer
devilbox@php-7.0.20 in /shared/httpd/my-cake $ composer create-project --prefer-dist cakephp/app cakephp
# 4. Symlink webroot directory
devilbox@php-7.0.20 in /shared/httpd/my-cake $ ln -s cakephp/webroot/ htdocs
# 5. Add MySQL datbase
devilbox@php-7.0.20 in /shared/httpd/my-cake $ mysql -u root -h 127.0.0.1 -p -e 'CREATE DATABASE my_cake;'
# 6. Configure datbase connection
devilbox@php-7.0.20 in /shared/httpd/my-cake $ vi cakephp/config/app.php
```
```php
<?php
'Datasources' => [
'default' => [
'className' => 'Cake\Database\Connection',
'driver' => 'Cake\Database\Driver\Mysql',
'persistent' => false,
'host' => '127.0.0.1',
/**
* CakePHP will use the default DB port based on the driver selected
* MySQL on MAMP uses port 8889, MAMP users will want to uncomment
* the following line and set the port accordingly
*/
//'port' => 'non_standard_port_number',
'username' => 'root',
'password' => 'secret',
'database' => 'my_cake',
'encoding' => 'utf8',
'timezone' => 'UTC',
'flags' => [],
'cacheMetadata' => true,
```
**7. DNS record**
If you do not have auto-DNS configured, you will need to add the following line to your Host computer's `/etc/hosts`:
```shell
127.0.0.1 my-cake.loc
```
**8. Open your browser**
All set now, you can visit http://my-cake.loc in your browser.
#### 2.2 Setup Drupal
> **[Official Drupal Documentation](https://www.drupal.org/docs/7/install)**
The following configuration will be used:
| Project name | VirtualHost directory | Database | TLD_SUFFIX | Url |
|--------------|-----------------------|------------|------------|-----|
| my-drupal | /shared/httpd/my-drupal | my_drupal| loc | http://my-drupal.loc |
It will be ready in six simple steps:
1. Enter the PHP container
2. Create a new VirtualHost directory
3. Install Drupal via `drush`
4. Symlink Drupal directory
5. Setup DNS record
6. Visit http://my-drupal.loc in your browser and follow instructions
```shell
# 1. Enter the PHP container
host> ./shell.sh
# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-drupal
devilbox@php-7.0.20 in /shared/httpd $ cd my-drupal
# 3. Install Drupal via drush
devilbox@php-7.0.20 in /shared/httpd/my-drupal $ drush dl drupal
# 4. Symlink Drupal directory
devilbox@php-7.0.20 in /shared/httpd/my-drupal $ ln -s drupal-8.3.3 htdocs
```
**5. DNS record**
If you do not have auto-DNS configured, you will need to add the following line to your Host computer's `/etc/hosts`:
```shell
127.0.0.1 my-drupal.loc
```
**6. Open your browser**
Open your browser at http://my-drupal.loc and follow the Drupal installation steps.
**Note:** For MySQL host choose `127.0.0.1`.
#### 2.3 Setup Joomla
> **[Official Joomla Documentation](https://docs.joomla.org/J3.x:Installing_Joomla)**
The following configuration will be used:
| Project name | VirtualHost directory | Database | TLD_SUFFIX | Url |
|--------------|-----------------------|------------|------------|-----|
| my-joomla | /shared/httpd/my-joomla | - | loc | http://my-joomla.loc |
It will be ready in six simple steps:
1. Enter the PHP container
2. Create a new VirtualHost directory
3. Download and extract Joomla
4. Symlink public directory
5. Setup DNS record
6. Visit http://my-joomla.loc in your browser
```shell
# 1. Enter the PHP container
host> ./shell.sh
# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-joomla
devilbox@php-7.0.20 in /shared/httpd $ cd my-joomla
# 3. Download and extract Joomla
devilbox@php-7.0.20 in /shared/httpd/my-joomla $ wget -O joomla.tar.gz https://downloads.joomla.org/cms/joomla3/3-8-0/joomla_3-8-0-stable-full_package-tar-gz?format=gz
devilbox@php-7.0.20 in /shared/httpd/my-joomla $ mkdir joomla/
devilbox@php-7.0.20 in /shared/httpd/my-joomla $ tar xvfz joomla.tar.gz -C joomla/
# 4. Symlink Joomla directory
devilbox@php-7.0.20 in /shared/httpd/my-joomla $ ln -s joomla htdocs
```
**5. DNS record**
If you do not have auto-DNS configured, you will need to add the following line to your Host computer's `/etc/hosts`:
```shell
127.0.0.1 my-joomla.loc
```
**6. Open your browser**
Open your browser at http://my-joomla.loc
#### 2.4 Setup Laravel
> **[Official Laravel Documentation](https://laravel.com/docs/5.4/installation)**
The following configuration will be used:
| Project name | VirtualHost directory | Database | TLD_SUFFIX | Url |
|--------------|-----------------------|------------|------------|-----|
| my-laravel | /shared/httpd/my-laravel | - | loc | http://my-laravel.loc |
It will be ready in six simple steps:
1. Enter the PHP container
2. Create a new VirtualHost directory
3. Install Laravel via `laravel`
4. Symlink public directory
5. Setup DNS record
6. Visit http://my-laravel.loc in your browser
```shell
# 1. Enter the PHP container
host> ./shell.sh
# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-laravel
devilbox@php-7.0.20 in /shared/httpd $ cd my-laravel
# 3. Install Laravel via laravel
devilbox@php-7.0.20 in /shared/httpd/my-laravel $ laravel new laravel-project
# 4. Symlink public directory
devilbox@php-7.0.20 in /shared/httpd/my-laravel $ ln -s laravel-project/public htdocs
```
**5. DNS record**
If you do not have auto-DNS configured, you will need to add the following line to your Host computer's `/etc/hosts`:
```shell
127.0.0.1 my-laravel.loc
```
**6. Open your browser**
Open your browser at http://my-laravel.loc
#### 2.5 Setup Phalcon
> **[Official Phalcon Documentation](https://docs.phalconphp.com/en/3.2/devtools-usage)**
The following configuration will be used:
| Project name | VirtualHost directory | Database | TLD_SUFFIX | Url |
|--------------|-----------------------|------------|------------|-----|
| my-phalcon | /shared/httpd/my-phalcon | - | loc | http://my-phalcon.loc |
It will be ready in six simple steps:
1. Enter the PHP container
2. Create a new VirtualHost directory
3. Install Phalcon via `phalcon`
4. Symlink public directory
5. Setup DNS record
6. Visit http://my-phalcon.loc in your browser
```shell
# 1. Enter the PHP container
host> ./shell.sh
# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-phalcon
devilbox@php-7.0.20 in /shared/httpd $ cd my-phalcon
# 3. Install Phalcon via phalcon
devilbox@php-7.0.20 in /shared/httpd/my-phalcon $ phalcon project phalconphp
# 4. Symlink public directory
devilbox@php-7.0.20 in /shared/httpd/my-phalcon $ ln -s phalconphp/public htdocs
```
**5. DNS record**
If you do not have auto-DNS configured, you will need to add the following line to your Host computer's `/etc/hosts`:
```shell
127.0.0.1 my-phalcon.loc
```
**6. Open your browser**
Open your browser at http://my-phalcon.loc
#### 2.6 Setup Symfony
> **[Official Symfony Documentation](https://symfony.com/doc/current/setup.html)**
The following configuration will be used:
| Project name | VirtualHost directory | Database | TLD_SUFFIX | Url |
|--------------|-----------------------|------------|------------|-----|
| my-symfony | /shared/httpd/my-symfony | - | loc | http://my-symfony.loc |
It will be ready in six simple steps:
1. Enter the PHP container
2. Create a new VirtualHost directory
3. Install Symfony via `symfony`
4. Symlink web directory
5. Enable Symfony prod (app.php)
6. Setup DNS record
7. Visit http://my-symfony.loc in your browser
```shell
# 1. Enter the PHP container
host> ./shell.sh
# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-symfony
devilbox@php-7.0.20 in /shared/httpd $ cd my-symfony
# 3. Install Symfony via symfony
devilbox@php-7.0.20 in /shared/httpd/my-symfony $ symfony new symfony
# 4. Symlink web directory
devilbox@php-7.0.20 in /shared/httpd/my-symfony $ ln -s symfony/web htdocs
# 5. Enable Symfony production (app.php)
devilbox@php-7.0.20 in /shared/httpd/my-symfony $ cd symfony/web
devilbox@php-7.0.20 in /shared/httpd/my-symfony/symfony/web $ ln -s app.php index.php
```
**6. DNS record**
If you do not have auto-DNS configured, you will need to add the following line to your Host computer's `/etc/hosts`:
```shell
127.0.0.1 my-symfony.loc
```
**7. Open your browser**
Open your browser at http://my-symfony.loc
#### 2.7 Setup Wordpress
> **[Official Wordpress Documentation](https://codex.wordpress.org/Installing_WordPress)**
The following configuration will be used:
| Project name | VirtualHost directory | Database | TLD_SUFFIX | Url |
|--------------|-----------------------|------------|------------|-----|
| my-wp | /shared/httpd/my-wp | my_wp | loc | http://my-wp.loc |
It will be ready in six simple steps:
1. Enter the PHP container
2. Create a new VirtualHost directory
3. Download Wordpress via `git`
4. Symlink wordpress git directory
5. Setup DNS record
6. Visit http://my-wp.loc in your browser
```shell
# 1. Enter the PHP container
host> ./shell.sh
# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-wp
devilbox@php-7.0.20 in /shared/httpd $ cd my-wp
# 3. Download Wordpress via git
devilbox@php-7.0.20 in /shared/httpd/my-wp $ git clone https://github.com/WordPress/WordPress wordpress.git
# 4. Symlink wordpress git directory
devilbox@php-7.0.20 in /shared/httpd/my-wp $ ln -s wordpress.git htdocs
```
**5. DNS record**
If you do not have auto-DNS configured, you will need to add the following line to your Host computer's `/etc/hosts`:
```shell
127.0.0.1 my-wp.loc
```
**6. Open your browser**
Open your browser at http://my-wp.loc
#### 2.8 Setup Yii
> **[Official Yii Documentation](http://www.yiiframework.com/doc-2.0/guide-start-installation.html)**
The following configuration will be used:
| Project name | VirtualHost directory | Database | TLD_SUFFIX | Url |
|--------------|-----------------------|------------|------------|-----|
| my-yii | /shared/httpd/my-yii | - | loc | http://my-yii.loc |
It will be ready in six simple steps:
1. Enter the PHP container
2. Create a new VirtualHost directory
3. Install Yii2 via `composer`
4. Symlink web directory
5. Setup DNS record
6. Visit http://my-yii.loc in your browser
```shell
# 1. Enter the PHP container
host> ./shell.sh
# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-yii
devilbox@php-7.0.20 in /shared/httpd $ cd my-yii
# 3. Install Yii2 via composer
devilbox@php-7.0.20 in /shared/httpd/my-yii $ composer create-project --prefer-dist --stability=dev yiisoft/yii2-app-basic yii2-dev
# 4. Symlink web directory
devilbox@php-7.0.20 in /shared/httpd/my-yii $ ln -s yii2-dev/web htdocs
```
**5. DNS record**
If you do not have auto-DNS configured, you will need to add the following line to your Host computer's `/etc/hosts`:
```shell
127.0.0.1 my-yii.loc
```
**6. Open your browser**
Open your browser at http://my-yii.loc
#### 2.9 Setup Zend
> **[Official Zend Documentation](https://docs.zendframework.com/tutorials/getting-started/skeleton-application/)**
The following configuration will be used:
| Project name | VirtualHost directory | Database | TLD_SUFFIX | Url |
|--------------|-----------------------|------------|------------|-----|
| my-zend | /shared/httpd/my-zend | - | loc | http://my-zend.loc |
It will be ready in six simple steps:
1. Enter the PHP container
2. Create a new VirtualHost directory
3. Install Zendframework via `composer`
4. Symlink public directory
5. Setup DNS record
6. Visit http://my-zend.loc in your browser
```shell
# 1. Enter the PHP container
host> ./shell.sh
# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-zend
devilbox@php-7.0.20 in /shared/httpd $ cd my-zend
# 3. Install Zendframework via composer
devilbox@php-7.0.20 in /shared/httpd/my-zend $ composer create-project --prefer-dist zendframework/skeleton-application zend
# 4. Symlink public directory
devilbox@php-7.0.20 in /shared/httpd/my-zend $ ln -s zend/public htdocs
```
**5. DNS record**
If you do not have auto-DNS configured, you will need to add the following line to your Host computer's `/etc/hosts`:
```shell
127.0.0.1 my-zend.loc
```
**6. Open your browser**
Open your browser at http://my-zend.loc
## 3. Code analysis
#### 3.1 awesome-ci
**[awesome-ci](https://github.com/cytopia/awesome-ci)** is a collection of tools for analysing your workspace and its files. You can for example check for:
* git conflicts
* git ignored files that have not been removed from the git index
* trailing spaces and newlines
* non-utf8 files or utf8 files with bom
* windows line feeds
* null-byte characters
* empty files
* syntax errors for various languages
* inline css or js code
* customized regex
Some of the bundled tools allow for automatic fixing. See the project page for how to use it: [https://github.com/cytopia/awesome-ci](https://github.com/cytopia/awesome-ci).
The following shows an example how to use it with the devilbox:
```shell
# 1. Enter your PHP/HHVM container
host> ./bash
# 2. Go to your project folder
devilbox@php-7.0.20 $ cd /shared/httpd/my-project
# 3. Run the tools
devilbox@php-7.0.20 $ git-conflicts --path=.
devilbox@php-7.0.20 $ git-ignored --path=.
devilbox@php-7.0.20 $ file-cr --path=.
devilbox@php-7.0.20 $ file-crlf --path=.
devilbox@php-7.0.20 $ file-empty --path=.
# 4. Run tools with more options
devilbox@php-7.0.20 $ syntax-php --path=. --extension=php
devilbox@php-7.0.20 $ syntax-php --path=. --shebang=php
...
```
#### 3.2 phpcs
**[phpcs](https://github.com/squizlabs/PHP_CodeSniffer)** is also available the devilbox:
```shell
# 1. Enter your PHP/HHVM container
host> ./bash
# 2. Go to your project folder
devilbox@php-7.0.20 $ cd /shared/httpd/my-project
# 3. Run it
devilbox@php-7.0.20 $ phpcs .
```
For more details visit its project page [https://github.com/squizlabs/PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
#### 3.3 eslint
**[eslint](http://eslint.org/)** is also available the devilbox:
```shell
# 1. Enter your PHP/HHVM container
host> ./bash
# 2. Go to your project folder
devilbox@php-7.0.20 $ cd /shared/httpd/my-project
# 3. Run it
devilbox@php-7.0.20 $ eslint .
```
For more details visit its project page [http://eslint.org](http://eslint.org).

108
docs/Technical.md
View File

@ -1,108 +0,0 @@
# Devilbox Documentation
[Overview](README.md) |
[Quickstart](Quickstart.md) |
[Install](Install.md) |
[Update](Update.md) |
[Configure](Configure.md) |
[Run](Run.md) |
[Usage](Usage.md) |
[OS](OS.md) |
[Backups](Backups.md) |
[Examples](Examples.md) |
Technical |
[Hacking](Hacking.md) |
[FAQ](FAQ.md)
---
## Technical
1. [Networking](#1-networking)
2. [Ports and forwarding](#2-ports-and-forwarding)
1. [PHP Container](#21-php-container)
2. [Docker Host](#22-docker-host)
3. [Works the same on Host and PHP Container](#3-works-the-same-on-host-and-php-container)
---
## 1. Networking
It is best to use the hostnames and not to rely on the ip addresses as they might change. In most cases however you can use `127.0.0.1` for all connections. Read up to find out why.
> E.g.: When you want to setup a MySQL database connection use `mysql` or `127.0.0.1` as the hostname.
| Container | Container name | Hostname | IP Address |
|-----------------------------|-----------------|-----------|----------------|
| DNS | bind | bind | 172.16.238.100 |
| PHP / HHVM | php | php | 172.16.238.10 |
| Apache / Nginx | http | http | 172.16.238.11 |
| MySQL / MariaDB / PerconaDB | mysql | mysql | 172.16.238.12 |
| PostgreSQL | pgsql | pgsql | 172.16.238.13 |
| Redis | redis | redis | 172.16.238.14 |
| Memcached | memcd | memcd | 172.16.238.15 |
| MongoDB | mongo | mongo | 172.16.238.16 |
## 2. Ports and forwarding
#### 2.1 PHP Container
The `php` container is the center of all container. Everything happens in there.
This is also the reason it does some more magic than actually required.
**Remote ports and remote sockets are made available to the `php` container.**
The PHP container is using [socat](https://linux.die.net/man/1/socat) to
1. forward the remote mysql port `3306` (on the mysql container) to its own `127.0.0.1:3306`
2. forward the remote pgsql port `5432` (on the pgsql container) to its own `127.0.0.1:5432`
3. forward the remote redis port `6379` (on the redis container) to its own `127.0.0.1:6379`
4. forward the remote memcached port `11211` (on the memcd container) to its own `127.0.0.1:11211`
5. forward the remote mongodb port `27017` (on the mongo container) to its own `127.0.0.1:27017`
The following container can be reached from within the PHP container via the following methods:
| Container | Hostname | IP Address | IP Address | Port |
|-----------------------------|-----------|----------------|------------|-------|
| DNS | bind | 172.16.238.100 | - | 53 |
| PHP / HHVM | php | 172.16.238.10 | - | 9000 |
| Apache / Nginx | http | 172.16.238.11 | - | 80 |
| MySQL / MariaDB / PerconaDB | mysql | 172.16.238.12 | 127.0.0.1 | 3306 |
| PostgreSQL | pgsql | 172.16.238.13 | 127.0.0.1 | 5432 |
| Redis | redis | 172.16.238.14 | 127.0.0.1 | 6379 |
| Memcached | memcd | 172.16.238.15 | 127.0.0.1 | 11211 |
| MongoDB | mongo | 172.16.238.16 | 127.0.0.1 | 27017 |
#### 2.2 Docker Host
The docker host (your computer) does exactly the same as the `php` container.
1. container mysql port `3306` is exposed to the host on port `127.0.0.1:3306`
2. container pgsql port `5432` is exposed to the host on port `127.0.0.1:5432`
3. container redis port `6379` is exposed to the host on port `127.0.0.1:6379`
3. container memcd port `11211` is exposed to the host on port `127.0.0.1:11211`
3. container mongo port `27017` is exposed to the host on port `127.0.0.1:27017`
The following container can be reached from the Docker host via the following methods:
| Container | IP Address | Port |
|-----------------------------|------------|-------|
| DNS | 127.0.0.1 | 1053 |
| PHP / HHVM | - | 9000 |
| Apache / Nginx | 127.0.0.1 | 80 |
| MySQL / MariaDB / PerconaDB | 127.0.0.1 | 3306 |
| PostgreSQL | 127.0.0.1 | 5432 |
| Redis | 127.0.0.1 | 6379 |
| Memcached | 127.0.0.1 | 11211 |
| MongoDB | 127.0.0.1 | 27017 |
## 3. Works the same on Host and PHP Container
As you might have noticed, the ports and addresses will be exactly the same inside the PHP container and on the docker host (when using `127.0.0.1`) for most container. That way it is possible to write your php application like this:
```php
<?php
mysql_connect('127.0.0.1', 'user', 'pass');
```

2
docs/configuration-files/env-file.rst
View File

@ -894,6 +894,8 @@ to something else if 27017 is already in use on your host operating system.
+----------------------+-------------------+------------------+
.. _env_host_port_bind:
HOST_PORT_BIND
--------------

89
docs/configuration-global/auto-dns.rst
View File

@ -3,3 +3,92 @@
********
Auto-DNS
********
If you don't want to add DNS records manually for every project, you can also use the bundled
DNS server and use it's DNS catch-all feature to have all DNS records automatically available.
.. important::
By default, the DNS server is set to listen on ``1053`` to avoid port collisions during startup.
You need to change it to ``53`` in ``.env`` via :ref:`env_host_port_bind`.
**Table of Contents**
.. contents:: :local:
Native Docker
=============
The webserver as well as the DNS server must at least be available on ``127.0.0.``.
The DNS server port must be set to ``53``.
* Ensure :ref:`env_local_listen_addr` is set accordingly
* Ensure :ref:`env_host_port_bind` is set accordingly
* No other DNS resolver should listen on ``127.0.0.1:53``
Linux
-----
First you need to ensure that :ref:`env_host_port_bind` is set to ``53``.
.. code-block:: bash
:caption: .env
:name: .env
:emphasize-lines: 3
host> cd path/to/devilbox
host> vi .env
HOST_PORT_BIND=53
Before starting up the Devilbox, ensure that port ``53`` is not already used on ``127.0.0.1``.
.. code-block:: bash
:emphasize-lines: 2
host> netstat -an | grep -E 'LISTEN\s*$'
tcp 0 0 127.0.0.1:53 0.0.0.0:* LISTEN
tcp 0 0 127.0.0.1:43477 0.0.0.0:* LISTEN
tcp 0 0 127.0.0.1:50267 0.0.0.0:* LISTEN
If you see port ``53`` already being used as in the above example, ensure to stop any
DNS resolver, otherwise it does not work.
The output should look like this (It is only important that there is no ``:53``.
.. code-block:: bash
host> netstat -an | grep -E 'LISTEN\s*$'
tcp 0 0 127.0.0.1:43477 0.0.0.0:* LISTEN
tcp 0 0 127.0.0.1:50267 0.0.0.0:* LISTEN
If everything is set, you can edit ``/etc/resolv.conf`` with root or sudo privileges
and add the Devilbox DNS server line by adding a ``nameserver`` directive
which points to ``127.0.0.1``:
.. code-block:: bash
:caption: /etc/resolv.conf
:name: /etc/resolv.conf
:emphasize-lines: 4
host> sudi vi /etc/resolv.conf
# Dynamic resolv.conf(5) file for glibc resolver(3) generated by resolvconf(8)
# DO NOT EDIT THIS FILE BY HAND -- YOUR CHANGES WILL BE OVERWRITTEN
nameserver 127.0.0.1
nameserver 192.168.0.10
search local
.. important::
Keep all other ``nameserver`` entries intact. The Devilbox DNS nameserver will only work
once the Devilbox is running. If you remove all others and don't run the Devilbox,
you won't be able to resolve any DNS names anymore.
.. important::
The Devilbox ``nameserver`` entry should be the very first one.
If you now start the Devilbox you don't need to take care about manually adding DNS records
anymore. Auto-DNS is now setup working.
Docker Toolbox
==============

153
docs/configuration-project/dns-records.rst
View File

@ -3,3 +3,156 @@
***********
DNS records
***********
Project DNS records are required, because each project is using its own virtual host with its own
unique server name.
The server name is constructed by a ``<project-directory>`` and the :ref:`env_tld_suffix` and
requires the same DNS record to be present in order to access it.
.. seealso::
This section gives you an overview about how to create separate DNS records for each project.
It has to be done for each project, however if you want to automate the process, refer
to :ref:`global_configuration_auto_dns`.
**Table of Contents**
.. contents:: :local:
Examples
========
In order to better illustrate the process, we are going to use two projects as an example.
See the following table for project directories and TLD_SUFFIX.
+-------------------+------------+--------------------------+-----------------------+
| Project directory | TLD_SUFFIX | Project URL | Required DNS name |
+===================+============+==========================+=======================+
| project-1 | ``loc`` | http://project-1.loc | ``project-1.loc`` |
+-------------------+------------+--------------------------+-----------------------+
| www.project-1 | ``loc`` | http://www.project-1.loc | ``www.project-1.loc`` |
+-------------------+------------+--------------------------+-----------------------+
.. note::
When you have created the above two projects, you can check the vhost page on the
Devilbox intranet. It will tell you exactly what DNS record to add.
.. image:: /_static/img/devilbox-vhosts-dns.png
.. important:: The IP address ``127.0.0.1`` is different for :ref:`docker_toolbox`
Creating DNS records
====================
When creating DNS records for your host operating system, there are two distinctions to be made.
If you use Native Docker (the default and recommended Docker), you can always use ``127.0.0.1``
as your IP address for the DNS record. If however your use Docker Toolbox, you first need to
find out the IP address of the Docker Toolbox virtual machine.
.. seealso:: :ref:`docker_toolbox`
Native Docker
-------------
Linux
^^^^^
Use your favorite editor and open ``/etc/hosts`` with root privileges. The following example
uses vim to add the two example DNS records.
.. code-block:: bash
host> sudo vim /etc/hosts
127.0.0.1 project-1.loc
127.0.0.1 www.project-1.loc
MacOS
^^^^^
Use your favorite editor and open ``/etc/hosts`` with root privileges. The following example
uses vim to add the two example DNS records.
.. code-block:: bash
host> sudo vim /etc/hosts
127.0.0.1 project-1.loc
127.0.0.1 www.project-1.loc
Windows
^^^^^^^
On Windows you need to open ``C:\Windows\System32\drivers\etc`` with administrative privileges
and add the following two lines:
.. code-block:: bash
127.0.0.1 project-1.loc
127.0.0.1 www.project-1.loc
Docker Toolbox
--------------
When using Docker Toolbox the Devilbox runs inside a virtual machine and therefore the webserver
port (80) is not exposed to your host operating system. So your DNS record must point to the
virtual machine instead of your host system.
1. Find out the IP address the virtual machine is running on
2. Add a DNS entry to your host operating system for this IP address.
For the sake of this example, let’s assume the virtual machine is running on ``192.16.0.1``
MacOS
^^^^^
Use your favorite editor and open ``/etc/hosts`` with root privileges. The following example
uses vim to add the two example DNS records.
.. code-block:: bash
host> sudo vim /etc/hosts
192.16.0.1 project-1.loc
192.16.0.1 www.project-1.loc
Windows
^^^^^^^
On Windows you need to open ``C:\Windows\System32\drivers\etc`` with administrative privileges
and add the following two lines:
.. code-block:: bash
192.16.0.1 project-1.loc
192.16.0.1 www.project-1.loc
Verify
======
After settings the DNS records, you can use the ``ping`` command to verify if everything works.
.. code-block:: bash
host> ping -c1 project-1.loc
PING project-1.loc (127.0.0.1) 56(84) bytes of data.
64 bytes from localhost (127.0.0.1): icmp_seq=1 ttl=64 time=0.066 ms
.. code-block:: bash
host> ping -c1 www.project-1.loc
PING www.project-1.loc (127.0.0.1) 56(84) bytes of data.
64 bytes from localhost (127.0.0.1): icmp_seq=1 ttl=64 time=0.066 ms

4
docs/getting-started/create-your-first-project.rst
View File

@ -45,7 +45,7 @@ In your Devilbox git directory, navigate to ``./data/www`` and create a new dire
# create a new project directory named: project-1
host> mkdir project-1
Vist the vhost page again and see what has changed: http://localhost/vhosts.php
Visit the vhost page again and see what has changed: http://localhost/vhosts.php
.. image:: /_static/img/devilbox-vhosts-directory.png
@ -202,7 +202,7 @@ Alternatively create an ``index.php`` file in ``data/www/project-1/htdocs`` with
<?php echo 'hello world';
Vist your project url again and see what has changed: http://project-1.loc
Visit your project url again and see what has changed: http://project-1.loc
.. image:: /_static/img/devilbox-project-hello-world.png