From 7e775622a55cc3860c84c233f172b89239dc3154 Mon Sep 17 00:00:00 2001 From: cytopia Date: Sat, 10 Dec 2022 18:43:56 +0100 Subject: [PATCH] Enhance documentation --- doc/available-tools.md | 168 ------------------------------------ doc/base-images.md | 4 +- doc/docker-env-variables.md | 6 +- doc/docker-tags.md | 57 ++++++++++++ doc/docker-volumes.md | 4 +- doc/flavours.md | 4 + 6 files changed, 69 insertions(+), 174 deletions(-) diff --git a/doc/available-tools.md b/doc/available-tools.md index ed0f0932..e48e4ec2 100644 --- a/doc/available-tools.md +++ b/doc/available-tools.md @@ -352,171 +352,3 @@ Additionally to all of the `slim` tools shown above, the following PHP cli tools [lnk_zsh]: ../php_tools/zsh - - -### 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ToolDescription
AnsibleAutomation tool.
asgardcmsAsgardCMS cli installer.
awesome-ciVarious linting and source code analyzing tools.
codeceptionElegant and efficient testing for PHP.
composerDependency Manager for PHP.
deployerDeployment tool for PHP.
drupal-consoleThe Drupal CLI. A tool to generate boilerplate code, interact with and debug Drupal.
drushDrush is a computer software shell-based application used to control, manipulate, and administer Drupal websites.
eslintThe pluggable linting utility for JavaScript and JSX.
gitGit is a version control system for tracking changes in source files.
git-flowGit-flow tools.
gulpGulp command line JS tool.
gruntGrunt command line JS tool.
HomebrewThe Missing Package Manager for macOS (or Linux).
jsonlintJson command line linter.
jqCommand-line JSON processor.
laravel installerA CLI tool to easily install and manage the laravel framework.
linkcheckSearch for URLs in files (optionally limited by extension) and validate their HTTP status code.
mdlMarkdown command line linter.
mdlintMarkdown command line linter.
mysqldump-secureSecury MySQL database backup tool with encryption.
nodejsNode.js is an open-source, cross-platform JavaScript run-time environment for executing JavaScript code server-side.
npmnpm is a package manager for the JavaScript programming language.
phalcon-devtoolsCLI tool to generate code helping to develop faster and easy applications that use with Phalcon framework.
phpcsPHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.
phpcbfPHP Code Beautifier and Fixer.
php-cs-fixerA tool to automatically fix PHP Coding Standards issues.
phpmdPHP Mess Detector.
photonPhoton CMS cli.
sassSass CSS compiler.
stylelintSass/CSS command line linter.
sshOpenSSH command line client.
symfony installerThis is the official installer to start new projects based on the Symfony full-stack framework.
tigText-mode Interface for Git.
webpackA bundler for javascript and friends.
wp-cliWP-CLI is the command-line interface for WordPress.
yamllintYaml command line linter.
yarnFast, reliable and secure dependency management.
diff --git a/doc/base-images.md b/doc/base-images.md index 26bf9e10..fee4f223 100644 --- a/doc/base-images.md +++ b/doc/base-images.md @@ -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) diff --git a/doc/docker-env-variables.md b/doc/docker-env-variables.md index dc040fc1..bbaebef8 100644 --- a/doc/docker-env-variables.md +++ b/doc/docker-env-variables.md @@ -30,7 +30,7 @@ Have a look at the following table to see all supported environment variables fo - base

mods

prod

work + base

mods

prod

slim

work DEBUG_ENTRYPOINT int 0 @@ -52,7 +52,7 @@ Have a look at the following table to see all supported environment variables fo - prod

work + prod

slim

work TIMEZONE string UTC @@ -92,7 +92,7 @@ Have a look at the following table to see all supported environment variables fo - work + slim

work MYSQL_BACKUP_USER string '' diff --git a/doc/docker-tags.md b/doc/docker-tags.md index 2d08ed06..b1a857ab 100644 --- a/doc/docker-tags.md +++ b/doc/docker-tags.md @@ -38,6 +38,7 @@ This repository uses Docker tags to refer to different flavours and types of the :X.Y-base
:X.Y-mods
:X.Y-prod
+ :X.Y-slim
:X.Y-work
Stable
(rolling)

These tags are produced by the master branch of this repository. @@ -48,6 +49,7 @@ This repository uses Docker tags to refer to different flavours and types of the :X.Y-base-<git-tag-name>
:X.Y-mods-<git-tag-name>
:X.Y-prod-<git-tag-name>
+ :X.Y-slim-<git-tag-name>
:X.Y-work-<git-tag-name>
Stable
(fixed)

Every git tag will produce and preserve these Docker tags. @@ -58,6 +60,7 @@ This repository uses Docker tags to refer to different flavours and types of the :X.Y-base-<git-branch-name>
:X.Y-mods-<git-branch-name>
:X.Y-prod-<git-branch-name>
+ :X.Y-slim-<git-branch-name>
:X.Y-work-<git-branch-name>
Feature
(for testing)

Tags produced by unmerged branches. Do not rely on them as they might come and go. @@ -242,6 +245,60 @@ The following table shows a more complete overview about the offered Docker imag devilbox/php-fpm:8.2-prod-<git-tag> + + slim + devilbox/php-fpm:5.2-slim + devilbox/php-fpm:5.2-slim-<git-tag> + + + devilbox/php-fpm:5.3-slim + devilbox/php-fpm:5.3-slim-<git-tag> + + + devilbox/php-fpm:5.4-slim + devilbox/php-fpm:5.4-slim-<git-tag> + + + devilbox/php-fpm:5.5-slim + devilbox/php-fpm:5.5-slim-<git-tag> + + + devilbox/php-fpm:5.6-slim + devilbox/php-fpm:5.6-slim-<git-tag> + + + devilbox/php-fpm:7.0-slim + devilbox/php-fpm:7.0-slim-<git-tag> + + + devilbox/php-fpm:7.1-slim + devilbox/php-fpm:7.1-slim-<git-tag> + + + devilbox/php-fpm:7.2-slim + devilbox/php-fpm:7.2-slim-<git-tag> + + + devilbox/php-fpm:7.3-slim + devilbox/php-fpm:7.3-slim-<git-tag> + + + devilbox/php-fpm:7.4-slim + devilbox/php-fpm:7.4-slim-<git-tag> + + + devilbox/php-fpm:8.0-slim + devilbox/php-fpm:8.0-slim-<git-tag> + + + devilbox/php-fpm:8.1-slim + devilbox/php-fpm:8.1-slim-<git-tag> + + + devilbox/php-fpm:8.2-slim + devilbox/php-fpm:8.2-slim-<git-tag> + + work devilbox/php-fpm:5.2-work diff --git a/doc/docker-volumes.md b/doc/docker-volumes.md index 6d9b3fb0..023d5aca 100644 --- a/doc/docker-volumes.md +++ b/doc/docker-volumes.md @@ -29,7 +29,7 @@ Have a look at the following table to see all offered volumes for each Docker im - prod

work + prod

slim

work /etc/php-custom.d Mount this directory into your host computer and add custom \*.ini files in order to alter php behaviour. @@ -65,7 +65,7 @@ Have a look at the following table to see all offered volumes for each Docker im - work + slim

work /etc/bashrc-devilbox.d Mount this directory into your host computer and add custom configuration files for bash and other tools. diff --git a/doc/flavours.md b/doc/flavours.md index d7c33647..75f4d7b1 100644 --- a/doc/flavours.md +++ b/doc/flavours.md @@ -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.