Skip to content

Commit d586967

Browse files
committed
Document basic requirements of installation
1 parent 06e6a85 commit d586967

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,29 @@ This POSIX compliant sh script gets php-fpm status page using `cgi-fcgi` tool, p
66

77
## Installation
88

9+
### Enable php-fpm status page
10+
11+
On you php-fpm pool configuration add: `pm.status_path = /status`
12+
13+
For instance on the official php image you can alter the file `/usr/local/etc/php-fpm.d/zz-docker.conf`
14+
15+
[See a simple example](https://github.com/renatomefi/php-fpm-healthcheck/blob/master/test/Dockerfile#L7)
16+
17+
[More about PHP fpm pool configuration](http://php.net/manual/en/install.fpm.configuration.php)
18+
19+
### Requirements
20+
21+
The script is POSIX sh but also uses some tools from your operating system, being:
22+
23+
- cgi-fcgi
24+
- sed
25+
- tail
26+
- grep
27+
28+
In case you're using alpine you only need to make sure you have installed `busybox` and `fcgi` packages.
29+
30+
[See a simple Dockerfile based on the official PHP image](https://github.com/renatomefi/php-fpm-healthcheck/blob/master/test/Dockerfile)
31+
932
### Download
1033

1134
```sh

0 commit comments

Comments
 (0)