diff --git a/CHANGELOG.md b/CHANGELOG.md
index 663ee5c..31ddc78 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,14 @@
## Unreleased
+## Release 0.146
+
+This release adds lots of documentation about recently added features.
+
+### Added
+- Documentation
+
+
## Release 0.145
This is a massive restructuring release, which adds another layer on top of Ansible to easily manage/edit/add PHP tools and to configure their respective order of building and installing.
diff --git a/README.md b/README.md
index 49f775c..954d4e6 100644
--- a/README.md
+++ b/README.md
@@ -9,9 +9,11 @@
[](https://opensource.org/licenses/MIT)
-| Upstream Project |
-|------------------|
-|
|
+| PHP-FPM | Reference Implementation |
+|:----------------:|:------------------------:|
+|
|
|
+| Streamlined [PHP-FPM](https://github.com/devilbox/docker-php-fpm) images | The [Devilbox](https://github.com/cytopia/devilbox) |
+
[](https://hub.docker.com/r/devilbox/php-fpm)
@@ -26,6 +28,7 @@ versions and packed with different types of integrated PHP modules. It also solv
This repository also allows you to quickly generate and **build your own custom PHP-FPM Docker image** with whatever PHP extension your desire for whatever PHP version you want and for any platform you're on (`amd64` or `arm64`). Jump to **[#Build your own image](#build-your-own-image)**.
+
| ๐ค Project | +๐ฑ GitHub | +๐ DockerHub | +
|---|---|---|
![]() |
+ Devilbox |
+ + |
![]() |
+ docker-mysql |
+ devilbox/mysql |
+
![]() |
+
+ docker-apache-2.2+ docker-apache-2.4+ docker-nginx-stable+ docker-nginx-mainline
+ |
+
+ devilbox/apache-2.2+ devilbox/apache-2.4+ devilbox/nginx-stable+ devilbox/nginx-mainline
+ |
+
Documentation |
- Chat |
- Forum |
+ ๐ Documentation |
+ ๐ช Chat |
+ ๐ซ Forum |
|---|
| Tool | +PHP 5.2 | +PHP 5.3 | +PHP 5.4 | +PHP 5.5 | +PHP 5.6 | +PHP 7.0 | +PHP 7.1 | +PHP 7.2 | +PHP 7.3 | +PHP 7.4 | +PHP 8.0 | +PHP 8.1 | +PHP 8.2 | +
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Cron | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +
| Postfix | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +
| Postfix PCRE | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +
| Rsyslog | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +
| Socat | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +
| Supervisor | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +โ | +
| Image | -Env Variable | -Type | -Default | -Description | -
|---|---|---|---|---|
| base mods prod slim work |
- DEBUG_ENTRYPOINT |
- int | -0 |
- Set debug level for startup.0 Only warnings and errors are shown.1 All log messages are shown2 All log messages and executed commands are shown. |
-
NEW_UID |
- int | -1000 |
- Assign the PHP-FPM user a new uid in order to syncronize file system permissions with your host computer and the Docker container. You should use a value that matches your host systems local user.(Type id -u for your uid). |
- |
NEW_GID |
- int | -1000 |
- Assign the PHP-FPM group a new gid in order to syncronize file system permissions with your host computer and the Docker container. You should use a value that matches your host systems local group.(Type id -g for your gid). |
- |
| - | ||||
| prod slim work |
- TIMEZONE |
- string | -UTC |
- Set docker OS timezone as well as PHP timezone. (Example: Europe/Berlin) |
-
DOCKER_LOGS |
- bool | -1 |
- By default all Docker images are configured to output their PHP-FPM access and error logs to stdout and stderr. Those which support it can change the behaviour to log into files inside the container. Their respective directories are available as volumes that can be mounted to the host computer. This feature might help developer who are more comfortable with tailing or searching through actual files instead of using docker logs. Set this variable to 0 in order to enable logging to files. Log files are avilable under /var/log/php/ which is also a docker volume that can be mounted locally. |
- |
ENABLE_MODULES |
- string | -'' |
- Comma separated list of PHP modules to enable, which are not enabled by default. Example: ENABLE_MODULES=blackfire, ioncube, psr, phalcon |
- |
DISABLE_MODULES |
- string | -'' |
- Comma separated list of PHP modules to disable. Example: DISABLE_MODULES=swoole,imagick |
- |
ENABLE_MAIL |
- bool | -0 |
- Start local postfix with or without email catch-all.0: Postfix service disabled.1: Postfix service started normally.2: Postfix service started configured for local delivery and all mails sent (even to real domains) will be catched locally. No email will ever go out. They will all be stored in a local devilbox account.Value: 0, 1 or 2 |
- |
FORWARD_PORTS_TO_LOCALHOST |
- string | -- | List of remote ports to forward to 127.0.0.1. Format: <local-port>:<remote-host>:<remote-port>You can separate multiple entries by comma. Example: 3306:mysqlhost:3306, 6379:192.0.1.1:6379 |
- |
| - | ||||
| slim work |
- MYSQL_BACKUP_USER |
- string | -'' |
- Username for mysql backups used for bundled mysqldump-secure | -
MYSQL_BACKUP_PASS |
- string | -'' |
- Password for mysql backups used for bundled mysqldump-secure | -|
MYSQL_BACKUP_HOST |
- string | -'' |
- Hostname for mysql backups used for bundled mysqldump-secure | -|
| Image | -Volumes | -Description | -
|---|---|---|
| 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. |
-
/etc/php-fpm-custom.d |
- Mount this directory into your host computer and add custom PHP-FPM \*.conf files in order to alter PHP-FPM behaviour. |
- |
/etc/php-modules.d |
- Mount this directory into your host computer and add custo \*.so files in order to add your php modules.Note:Your should then also provide a custom \*.ini file in order to actually load your custom provided module. |
- |
/startup.1.d |
- Any executable scripts ending by \*.sh found in this directory will be executed during startup. This is useful to supply additional commands (such as installing custom software) when the container starts up. (will run before /startup.2.d) |
- |
/startup.2.d |
- Any executable scripts ending by \*.sh found in this directory will be executed during startup. This is useful to supply additional commands (such as installing custom software) when the container starts up. (will run after /startup.1.d) |
- |
/var/log/php |
- When setting environment variable DOCKER_LOGS to 0, log files will be available under this directory. |
- |
/var/mail |
- Emails caught be the postfix catch-all (ENABLE_MAIL=2) will be available in this directory. |
- |
/etc/supervisor/custom.d |
- Mount this directory into your host computer and add your own `*.conf` supervisor start-up files. **Note:** Directory and file permission will be recursively set to this of `NEW_UID` and `NEW_GID`. |
- |
| - | ||
| slim work |
- /etc/bashrc-devilbox.d |
- Mount this directory into your host computer and add custom configuration files for bash and other tools. |
-
/shared/backups |
- Mount this directory into your host computer to access MySQL backups created by mysqldump-secure. | -|
/ca |
- Mount this directory into your host computer to bake any *.crt file that is located in there as a trusted SSL entity. | -|