Documentation: Auto-DNS

This commit is contained in:
cytopia 2018-03-25 23:40:28 +02:00
parent 71899930aa
commit 33082a98ed
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
6 changed files with 100 additions and 12 deletions

View File

@ -912,7 +912,7 @@ to something else if ``53`` is already in use on your host operating system.
on port ``53`` which would result in a failure when this BIND server is starting.
You only need to set BIND to port ``53`` when you want to use the ``Auto-DNS`` feautre of the
Devilbox. When doing so, read this article with care: :ref:`tutorial_enable_auto_dns`.
Devilbox. When doing so, read this article with care: :ref:`global_configuration_auto_dns`.
Container settings

View File

@ -49,7 +49,6 @@ devilbox documentation
tutorials/change-document-root
tutorials/change-container-versions
tutorials/work-inside-the-container
tutorials/enable-auto-dns
tutorials/enable-xdebug
tutorials/customize-vhost
tutorials/custom-apache-modules

View File

@ -221,7 +221,7 @@ See here how to do that for Linux, MacOS or Windows:
:ref:`getting_started_create_your_first_project_dns_entry`
This however is not really convenient. If you have basically infinite sub domains (via catch-all),
you should consider using Auto-DNS instead: :ref:`tutorial_enable_auto_dns`.
you should consider using Auto-DNS instead: :ref:`global_configuration_auto_dns`.
Step 2: Adjust apache22.yml
"""""""""""""""""""""""""""
@ -395,7 +395,7 @@ See here how to do that for Linux, MacOS or Windows:
:ref:`getting_started_create_your_first_project_dns_entry`
This however is not really convenient. If you have basically infinite sub domains (via catch-all),
you should consider using Auto-DNS instead: :ref:`tutorial_enable_auto_dns`.
you should consider using Auto-DNS instead: :ref:`global_configuration_auto_dns`.
Step 2: Adjust nginx.yml

View File

@ -1,7 +0,0 @@
.. _tutorial_enable_auto_dns:
***************
Enable Auto-DNS
***************
Todo

View File

@ -0,0 +1,96 @@
.. _tutorial_static_code_analysis:
********************
Static Code Analysis
********************
This tutorial gives you a general overview how to do static code analysis from within the PHP
container.
.. seealso::
* :ref:`available_tools`
* :ref:`tutorial_work_inside_the_php_container`
**Table of Contents**
.. contents:: :local:
Awesome-ci
==========
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 even allow for automatic fixing.
.. seealso:: `awesome-ci <https://github.com/cytopia/awesome-ci>`_
.. code-block:: bash
# 1. Enter your PHP 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
PHPCS
=====
PHPCS is a code style analyser for PHP.
.. seealso:: `PHPCS <https://github.com/squizlabs/PHP_CodeSniffer>`_
.. code-block:: bash
# 1. Enter your PHP 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 .
ESLint
======
ESLint is a Javascript static source code analyzer.
.. seealso:: `ESLint <http://eslint.org>`_
.. code-block:: bash
# 1. Enter your PHP 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 .

View File

@ -270,7 +270,7 @@ The PHP container is hooked up by default to the bundled DNS server and makes us
.. seealso::
You can achieve the same on your host operating system by explicitly enabling auto-dns.
See also: :ref:`global_configuration_auto_dns` and :ref:`tutorial_enable_auto_dns`.
See also: :ref:`global_configuration_auto_dns`.
Checklist