Skip to content

Commit 885bcac

Browse files
committed
Add documentation
1 parent d48f268 commit 885bcac

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ Nginx and PHP are compiled in a specific version. Consult the [CHANGELOG.md](./C
1010
for further version details. [PHP Composer](https://getcomposer.org/) is already installed and ready
1111
for use.
1212

13+
Xdebug is installed as shared extension, but not activated. Start the container with env
14+
ENABLE_XDEBUG=1 to enable the extension.
15+
1316
The Nginx and PHP-FPM master processes are controlled by [Honcho](https://github.com/nickstenning/honcho).
1417
Honcho was chosen over Supervisor, because honcho will exit and kill the container if either Nginx
1518
or PHP's master process dye for any reason. If you want have to have the container restarted
@@ -42,6 +45,12 @@ Mount your custom `nginx.conf` file at `/usr/local/nginx/conf/nginx.conf`.
4245
* Mount your custom `www.conf` file at `/usr/local/etc/www.conf`.
4346
* Mount your custom `php.ini` file at `/usr/local/php/php.ini`.
4447

48+
### Xdebug
49+
50+
Xdebug was installed mainly with the idea of providing code coverage for PHPUnit. Thus it's not
51+
configured for any specific use case. You can [configure Xdebug](https://xdebug.org/docs/all) via
52+
`php.ini` if desired.
53+
4554
### Honcho
4655

4756
If you want to overwrite the default Honcho configuration - mount your custom `Procfile` file at `/`.

0 commit comments

Comments
 (0)