Skip to content

Commit 2c92029

Browse files
authored
Merge pull request #8 from wesleyhf/fixing-readme
Improving README
2 parents b3aabde + 616a130 commit 2c92029

1 file changed

Lines changed: 30 additions & 15 deletions

File tree

README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Description
2-
31
![CI/CD](https://github.com/kool-dev/docker-php/workflows/CI/CD/badge.svg)
42

3+
## Description
4+
55
Minimal PHP Docker image focused on Laravel applications. It's use is intended for [kool.dev](https://github.com/kool-dev/kool), but can fit in any other PHP use-case.
66

77
## Available Tags
@@ -52,19 +52,34 @@ Minimal PHP Docker image focused on Laravel applications. It's use is intended f
5252

5353
## Environment Variables
5454

55-
- **ASUSER** - Changes the user id that executes the commands
56-
- **UID** - Changes the user id that executes the commands **(ignored if ASUSER is provided)**
57-
- **COMPOSER_ALLOW_SUPERUSER** - Allows composer to run with super user
58-
- **ENABLE_XDEBUG** - Enables the Xdebug extension **(only prod versions)**
59-
- **PHP_MEMORY_LIMIT** - Changes PHP memory limit
60-
- **PHP_MAX_INPUT_VARS** - Changes how many input variables may be accepted on PHP
61-
- **PHP_UPLOAD_MAX_FILESIZE** - Changes PHP maximum size of an uploaded file
62-
- **PHP_POST_MAX_SIZE** - Changes PHP max size of post data allowed
63-
- **PHP_MAX_EXECUTION_TIME** - Changes PHP maximum time is allowed to run a script
64-
- **PHP_FPM_LISTEN** - Changes the PORT address of the FastCGI requests
65-
- **PHP_FPM_MAX_CHILDREN** - Changes the number of child processes to be used on FPM
66-
- **PHP_FPM_REQUEST_TERMINATE_TIMEOUT** - Changes FPM timeout to serve a single request
67-
- **PHP_FPM_REQUEST_TERMINATE_TIMEOUT** - Changes FPM timeout to serve a single request
55+
Variable | Default Value | Description
56+
--- | --- | ---
57+
**ASUSER** | `0` | Changes the user id that executes the commands
58+
**UID** | `0` | Changes the user id that executes the commands **(ignored if ASUSER is provided)**
59+
**COMPOSER_ALLOW_SUPERUSER** | `1` | Allows composer to run with super user
60+
**COMPOSER_MEMORY_LIMIT** | `-1` | Changes composer memory limit
61+
**ENABLE_XDEBUG** | `false` | Enables the Xdebug extension
62+
**PHP_MEMORY_LIMIT** | `256M` | Changes PHP memory limit
63+
**PHP_MAX_INPUT_VARS** | `1000`  | Changes how many input variables may be accepted on PHP
64+
**PHP_UPLOAD_MAX_FILESIZE** | `25M` | Changes PHP maximum size of an uploaded file
65+
**PHP_POST_MAX_SIZE** | `25M` | Changes PHP max size of post data allowed
66+
**PHP_MAX_EXECUTION_TIME** | `30` | Changes PHP maximum time is allowed to run a script
67+
**PHP_FPM_LISTEN** | `9000` | Changes the PORT address of the FastCGI requests
68+
**PHP_FPM_MAX_CHILDREN** | `10` | Changes the number of child processes to be used on FPM
69+
**PHP_FPM_REQUEST_TERMINATE_TIMEOUT** | `60` | Changes FPM timeout to serve a single request
70+
71+
### NGINX
72+
73+
Variable | Default Value | Description
74+
--- | --- | ---
75+
**NGINX_LISTEN** | `80` | Changes the PORT address
76+
**NGINX_ROOT** | `/app/public` | Changes NGINX root directive
77+
**NGINX_INDEX** | `index.php` | Changes the index directive
78+
**NGINX_CLIENT_MAX_BODY_SIZE** | `25M` | Changes maximum allowed size of the client request body
79+
**NGINX_PHP_FPM** | `unix:/run/php-fpm.sock` | Changes the address of a FastCGI server
80+
**NGINX_FASTCGI_READ_TIMEOUT** | `60s` | Changes a timeout for reading a response from the FastCGI server
81+
**NGINX_FASTCGI_BUFFERS** | `8 8k` | Changes the number and size of the buffers used for reading a response
82+
**NGINX_FASTCGI_BUFFER_SIZE** | `16k` | Changes the size of the buffer used for reading the first part of the response received
6883

6984
## Usage
7085

0 commit comments

Comments
 (0)