Skip to content

Commit

Permalink
Merge pull request #255 from devilbox/doc-fixes
Browse files Browse the repository at this point in the history 
Enhance documentation
  • Loading branch information
@cytopia
cytopia authored Dec 10, 2022
2 parents 7cc5e25 + 7e77562 commit ff61a45
Show file tree
Hide file tree
Showing 6 changed files with 69 additions and 174 deletions.
168 changes: 0 additions & 168 deletions doc/available-tools.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -352,171 +352,3 @@ Additionally to all of the `slim` tools shown above, the following PHP cli tools
[lnk_zsh]: ../php_tools/zsh

<!-- TOOLS_WORK_END -->


### PHP Tools (`work`) - deprecated

> **Disclaimer:** It is currently not clear what tools are available in which PHP image (version-dependent). This documentation was done by hand and work has currently started to automate this and keep exact tools up-to-date for each of the provided PHP version.
<table>
<thead>
<tr>
<th width="200">Tool</th>
<th>Description</th>
</tr>
</thead>
<tr>
<td><a href="https://www.ansible.com/">Ansible</a></td>
<td>Automation tool.</td>
</tr>
<tr>
<td><a href="https://asgardcms.com/install">asgardcms</a></td>
<td>AsgardCMS cli installer.</td>
</tr>
<tr>
<td><a href="https://github.com/cytopia/awesome-ci">awesome-ci</a></td>
<td>Various linting and source code analyzing tools.</td>
</tr>
<tr>
<td><a href="https://codeception.com/">codeception</a></td>
<td>Elegant and efficient testing for PHP.</td>
</tr>
<tr>
<td><a href="https://getcomposer.org">composer</a></td>
<td>Dependency Manager for PHP.</td>
</tr>
<tr>
<td><a href="https://deployer.org/">deployer</a></td>
<td>Deployment tool for PHP.</td>
</tr>
<tr>
<td><a href="https://drupalconsole.com">drupal-console</a></td>
<td>The Drupal CLI. A tool to generate boilerplate code, interact with and debug Drupal.</td>
</tr>
<tr>
<td><a href="http://www.drush.org">drush</a></td>
<td>Drush is a computer software shell-based application used to control, manipulate, and administer Drupal websites.</td>
</tr>
<tr>
<td><a href="https://eslint.org">eslint</a></td>
<td>The pluggable linting utility for JavaScript and JSX.</td>
</tr>
<tr>
<td><a href="https://git-scm.com">git</a></td>
<td>Git is a version control system for tracking changes in source files.</td>
</tr>
<tr>
<td><a href="https://github.com/nvie/gitflow">git-flow</a></td>
<td>Git-flow tools.</td>
</tr>
<tr>
<td><a href="https://gulpjs.com/">gulp</a></td>
<td>Gulp command line JS tool.</td>
</tr>
<tr>
<td><a href="https://gruntjs.com/">grunt</a></td>
<td>Grunt command line JS tool.</td>
</tr>
<tr>
<td><a href="https://brew.sh/">Homebrew</a></td>
<td>The Missing Package Manager for macOS (or Linux).</td>
</tr>
<tr>
<td><a href="https://github.com/zaach/jsonlint">jsonlint</a></td>
<td>Json command line linter.</td>
</tr>
<tr>
<td><a href="https://stedolan.github.io/jq/">jq</a></td>
<td>Command-line JSON processor.</td>
</tr>
<tr>
<td><a href="https://github.com/laravel/installer">laravel installer</a></td>
<td>A CLI tool to easily install and manage the laravel framework.</td>
</tr>
<tr>
<td><a href="https://github.com/cytopia/linkcheck">linkcheck</a></td>
<td>Search for URLs in files (optionally limited by extension) and validate their HTTP status code.</td>
</tr>
<tr>
<td><a href="https://github.com/markdownlint/markdownlint">mdl</a></td>
<td>Markdown command line linter.</td>
</tr>
<tr>
<td><a href="https://github.com/ChrisWren/mdlint">mdlint</a></td>
<td>Markdown command line linter.</td>
</tr>
<tr>
<td><a href="https://mysqldump-secure.org">mysqldump-secure</a></td>
<td>Secury MySQL database backup tool with encryption.</td>
</tr>
<tr>
<td><a href="https://nodejs.org">nodejs</a></td>
<td>Node.js is an open-source, cross-platform JavaScript run-time environment for executing JavaScript code server-side.</td>
</tr>
<tr>
<td><a href="https://www.npmjs.com">npm</a></td>
<td>npm is a package manager for the JavaScript programming language.</td>
</tr>
<tr>
<td><a href="https://github.com/phalcon/phalcon-devtools">phalcon-devtools</a></td>
<td>CLI tool to generate code helping to develop faster and easy applications that use with Phalcon framework.</td>
</tr>
<tr>
<td><a href="https://github.com/squizlabs/PHP_CodeSniffer">phpcs</a></td>
<td>PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.</td>
</tr>
<tr>
<td><a href="https://github.com/squizlabs/PHP_CodeSniffer">phpcbf</a></td>
<td>PHP Code Beautifier and Fixer.</td>
</tr>
<tr>
<td><a href="https://github.com/FriendsOfPHP/PHP-CS-Fixer">php-cs-fixer</a></td>
<td>A tool to automatically fix PHP Coding Standards issues.</td>
</tr>
<tr>
<td><a href="https://phpmd.org">phpmd</a></td>
<td>PHP Mess Detector.</td>
</tr>
<tr>
<td><a href="https://photoncms.com/resources/installing">photon</a></td>
<td>Photon CMS cli.</td>
</tr>
<tr>
<td><a href="http://sass-lang.com/">sass</a></td>
<td>Sass CSS compiler.</td>
</tr>
<tr>
<td><a href="https://github.com/stylelint/stylelint">stylelint</a></td>
<td>Sass/CSS command line linter.</td>
</tr>
<tr>
<td><a href="https://www.openssh.com/">ssh</a></td>
<td>OpenSSH command line client.</td>
</tr>
<tr>
<td><a href="https://github.com/symfony/symfony-installer">symfony installer</a></td>
<td>This is the official installer to start new projects based on the Symfony full-stack framework.</td>
</tr>
<tr>
<td><a href="https://github.com/jonas/tig">tig</a></td>
<td>Text-mode Interface for Git.</td>
</tr>
<tr>
<td><a href="https://github.com/webpack/webpack">webpack</a></td>
<td>A bundler for javascript and friends.</td>
</tr>
<tr>
<td><a href="https://wp-cli.org">wp-cli</a></td>
<td>WP-CLI is the command-line interface for WordPress.</td>
</tr>
<tr>
<td><a href="https://github.com/adrienverge/yamllint">yamllint</a></td>
<td>Yaml command line linter.</td>
</tr>
<tr>
<td><a href="https://yarnpkg.com/en">yarn</a></td>
<td>Fast, reliable and secure dependency management.</td>
</tr>
<tbody>
</tbody>
</table>
4 changes: 3 additions & 1 deletion doc/base-images.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ Have a look at the following Devilbox base images for which no official versions

* [PHP-FPM 5.2](https://github.com/devilbox/docker-php-fpm-5.2)
* [PHP-FPM 5.3](https://github.com/devilbox/docker-php-fpm-5.3)
* [PHP-FPM 7.4](https://github.com/devilbox/docker-php-fpm-7.4)
* [PHP-FPM 5.4](https://github.com/devilbox/docker-php-fpm-5.4)
* [PHP-FPM 5.5](https://github.com/devilbox/docker-php-fpm-5.5)
* [PHP-FPM 8.0](https://github.com/devilbox/docker-php-fpm-8.0)
* [PHP-FPM 8.1](https://github.com/devilbox/docker-php-fpm-8.1)
* [PHP-FPM 8.2](https://github.com/devilbox/docker-php-fpm-8.2)
* [PHP-FPM 8.3](https://github.com/devilbox/docker-php-fpm-8.3)
6 changes: 3 additions & 3 deletions doc/docker-env-variables.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Have a look at the following table to see all supported environment variables fo
</thead>
<tbody>
<tr>
<td rowspan="3"><strong>base</strong><br/><br/><strong>mods</strong><br/><br/><strong>prod</strong><br/><br/><strong>work</strong></td>
<td rowspan="3"><strong>base</strong><br/><br/><strong>mods</strong><br/><br/><strong>prod</strong><br/><br/><strong>slim</strong><br/><br/><strong>work</strong></td>
<td><code>DEBUG_ENTRYPOINT</code></td>
<td>int</td>
<td><code>0</code></td>
Expand All @@ -52,7 +52,7 @@ Have a look at the following table to see all supported environment variables fo
<td colspan="5"></td>
</tr>
<tr>
<td rowspan="6"><strong>prod</strong><br/><br/><strong>work</strong></td>
<td rowspan="6"><strong>prod</strong><br/><br/><strong>slim</strong><br/><br/><strong>work</strong></td>
<td><code>TIMEZONE</code></td>
<td>string</td>
<td><code>UTC</code></td>
Expand Down Expand Up @@ -92,7 +92,7 @@ Have a look at the following table to see all supported environment variables fo
<td colspan="5"></td>
</tr>
<tr>
<td rowspan="3"><strong>work</strong></td>
<td rowspan="3"><strong>slim</strong><br/><br/><strong>work</strong></td>
<td><code>MYSQL_BACKUP_USER</code></td>
<td>string</td>
<td><code>''</code></td>
Expand Down
57 changes: 57 additions & 0 deletions doc/docker-tags.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ This repository uses Docker tags to refer to different flavours and types of the
<code>:X.Y-base</code><br/>
<code>:X.Y-mods</code><br/>
<code>:X.Y-prod</code><br/>
<code>:X.Y-slim</code><br/>
<code>:X.Y-work</code><br/>
</td>
<td>Stable<br/><sub>(rolling)</sub><br/><br/>These tags are produced by the master branch of this repository.</td>
Expand All @@ -48,6 +49,7 @@ This repository uses Docker tags to refer to different flavours and types of the
<code>:X.Y-base-&lt;git-tag-name&gt;</code><br/>
<code>:X.Y-mods-&lt;git-tag-name&gt;</code><br/>
<code>:X.Y-prod-&lt;git-tag-name&gt;</code><br/>
<code>:X.Y-slim-&lt;git-tag-name&gt;</code><br/>
<code>:X.Y-work-&lt;git-tag-name&gt;</code><br/>
</td>
<td>Stable<br/><sub>(fixed)</sub><br/><br/>Every git tag will produce and preserve these Docker tags.</td>
Expand All @@ -58,6 +60,7 @@ This repository uses Docker tags to refer to different flavours and types of the
<code>:X.Y-base-&lt;git-branch-name&gt;</code><br/>
<code>:X.Y-mods-&lt;git-branch-name&gt;</code><br/>
<code>:X.Y-prod-&lt;git-branch-name&gt;</code><br/>
<code>:X.Y-slim-&lt;git-branch-name&gt;</code><br/>
<code>:X.Y-work-&lt;git-branch-name&gt;</code><br/>
</td>
<td>Feature<br/><sub>(for testing)</sub><br/><br/>Tags produced by unmerged branches. Do not rely on them as they might come and go.</td>
Expand Down Expand Up @@ -242,6 +245,60 @@ The following table shows a more complete overview about the offered Docker imag
<td><code>devilbox/php-fpm:8.2-prod-&lt;git-tag&gt;</code></td>
</tr>

<tr>
<td rowspan="13"><strong>slim</strong></td>
<td><code>devilbox/php-fpm:5.2-slim</code></td>
<td><code>devilbox/php-fpm:5.2-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:5.3-slim</code></td>
<td><code>devilbox/php-fpm:5.3-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:5.4-slim</code></td>
<td><code>devilbox/php-fpm:5.4-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:5.5-slim</code></td>
<td><code>devilbox/php-fpm:5.5-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:5.6-slim</code></td>
<td><code>devilbox/php-fpm:5.6-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:7.0-slim</code></td>
<td><code>devilbox/php-fpm:7.0-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:7.1-slim</code></td>
<td><code>devilbox/php-fpm:7.1-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:7.2-slim</code></td>
<td><code>devilbox/php-fpm:7.2-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:7.3-slim</code></td>
<td><code>devilbox/php-fpm:7.3-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:7.4-slim</code></td>
<td><code>devilbox/php-fpm:7.4-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:8.0-slim</code></td>
<td><code>devilbox/php-fpm:8.0-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:8.1-slim</code></td>
<td><code>devilbox/php-fpm:8.1-slim-&lt;git-tag&gt;</code></td>
</tr>
<tr>
<td><code>devilbox/php-fpm:8.2-slim</code></td>
<td><code>devilbox/php-fpm:8.2-slim-&lt;git-tag&gt;</code></td>
</tr>

<tr>
<td rowspan="13"><strong>work</strong></td>
<td><code>devilbox/php-fpm:5.2-work</code></td>
Expand Down
4 changes: 2 additions & 2 deletions doc/docker-volumes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Have a look at the following table to see all offered volumes for each Docker im
</thead>
<tbody>
<tr>
<td rowspan="8"><strong>prod</strong><br/><br/><strong>work</strong></td>
<td rowspan="8"><strong>prod</strong><br/><br/><strong>slim</strong><br/><br/><strong>work</strong></td>
<td><code>/etc/php-custom.d</code></td>
<td>Mount this directory into your host computer and add custom <code>\*.ini</code> files in order to alter php behaviour.</td>
</tr>
Expand Down Expand Up @@ -65,7 +65,7 @@ Have a look at the following table to see all offered volumes for each Docker im
<td colspan="3"></td>
</tr>
<tr>
<td rowspan="3"><strong>work</strong></td>
<td rowspan="3"><strong>slim</strong><br/><br/><strong>work</strong></td>
<td><code>/etc/bashrc-devilbox.d</code></td>
<td>Mount this directory into your host computer and add custom configuration files for <code>bash</code> and other tools.</td>
</tr>
Expand Down
4 changes: 4 additions & 0 deletions doc/flavours.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ Generic PHP-FPM image with fully loaded extensions. Use it to derive your own ph

Devilbox production image. This Docker image comes with many injectables, port-forwardings, mail-catch-all and user/group rewriting.

#### Image: slim

Devilbox intranet-ready image. Similar to `prod`, but contains least subset of required cli tools to make the Devilbox intranet work.

#### Image: work

Devilbox development image. Same as prod, but comes with lots of locally installed tools to make development inside the container as convenient as possible. See [Integrated Development Environment](../README.md#integrated-development-environment) for more information about this.

0 comments on commit ff61a45

Please sign in to comment.