Skip to content

Commit b972054

Browse files
README.md updates 📝
Signed-off-by: Sherif Abdel-Naby <sherifabdlnaby@gmail.com>
1 parent f14191b commit b972054

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -114,16 +114,17 @@ OR
114114
However, in an environment where CI/CD pipelines will build the image, they will need to supply some build-time arguments for the image. (tho defaults exist.)
115115

116116
#### Build Time Arguments
117-
| **ARG** | **Description** | **Default** |
118-
|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
119-
| `PHP_VERSION` | PHP Version used in the Image | `7.4` |
120-
| `NGINX_VERSION` | Nginx Version | `1.17.4` |
121-
| `COMPOSER_VERSION` | Composer Version used in Image | `2.0` |
122-
| `COMPOSER_AUTH` | A Json Object with Bitbucket or Github token to clone private Repos with composer.</br>[Reference](https://getcomposer.org/doc/03-cli.md#composer-auth) | `{}` |
123-
| `RUNTIME_DEPS` | List of all OS Packages needed for PHP Runtime | `zip` |
124-
| `XDEBUG_VERSION` | Xdebug Version to use in Development Image | `3.0.3` |
125-
126-
#### Image Targets
117+
| **ARG** | **Description**
118+
| **Default** |
119+
--------------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
120+
| `PHP_VERSION` | PHP Version used in the Image | `7.4` | | `PHP_ALPINE_VERSION` | Alpine
121+
Version for the PHP Image | `3.15` | | `NGINX_VERSION` | Nginx Version | `1.21` | | `COMPOSER_VERSION` |
122+
Composer Version used in Image | `2.0` | | `COMPOSER_AUTH` | A Json Object with Bitbucket or Github token to
123+
clone private Repos with composer.</br>[Reference](https://getcomposer.org/doc/03-cli.md#composer-auth) | `{}`
124+
| | `RUNTIME_DEPS` | List of all OS Packages needed for PHP Runtime | `zip` | | `XDEBUG_VERSION` | Xdebug
125+
Version to use in Development Image | `3.0.3` |
126+
127+
#### Image Targets
127128

128129
| **Target** | Env | Desc | Size | Based On |
129130
|------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|-------------------------------|
@@ -136,7 +137,7 @@ However, in an environment where CI/CD pipelines will build the image, they will
136137
- The image is to be used as a base for your PHP application image, you should modify its Dockerfile to your needs.
137138

138139
1. Install System Packages in the following section in the Dockerfile.
139-
- List OS Packages needed in `RUNTIME_DEPS` ARG in Dockerfile header.
140+
- Add OS Packages needed in `RUNTIME_DEPS` in Dockerfile.
140141
2. Install PHP Extensions In the following section in the Dockerfile.
141142
```dockerfile
142143
# ---------------------------------------- Install / Enable PHP Extensions ---------------------------------------------
@@ -191,16 +192,21 @@ In `docker/` directory there is `post-build-*` and `pre-run-*` scripts that are
191192
- In containerized environment, you need to only run one process inside the container. This allows us to better instrument our application for many reasons like separation of health status, metrics, logs, etc.
192193
193194
2. Image Build Fails as it try to connect to DB.
194-
195-
- A typical application in most Frameworks comes with `Doctrine` ORM, Doctrine if not configured with a DB Version, will try to access the DB at php's script initialization (even at the post-install cmd's), and it will fail when it cannot connect to DB. [Make sure you configure doctrine to avoid this extra DB Check connection.](https://symfony.com/doc/current/reference/configuration/doctrine.html#:~:text=The-,server_version,-option%20was%20added)
195+
196+
- A typical scenario in most frameworks that comes with `Doctrine` ORM is that if Doctrine not configured with a DB
197+
Version, will try to access the DB at php's script initialization (even at the post-install cmd's), and it will
198+
fail when it cannot connect to
199+
DB. [Make sure you configure doctrine to avoid this extra DB Check connection.](https://symfony.com/doc/current/reference/configuration/doctrine.html#:~:text=The-,server_version,-option%20was%20added)
196200
197201
3. Xdebug not working
198202
199-
- Xdebug is configured to work with Linux, to make it work for Mac/Windows, please change Xdebug config in `/docker/php/dev-xdebug.ini` >> `xdebug.client_host` to `host.docker.internal`.
203+
- Xdebug is configured to work with Linux, to make it work for Mac/Windows, please change `XDEBUG_CLIENT_HOST` env
204+
variable to `host.docker.internal` in `docker-compose.yml` file.
200205
201206
# License
207+
202208
[MIT License](https://raw.githubusercontent.com/sherifabdlnaby/kubephp/blob/master/LICENSE)
203-
Copyright (c) 2021 Sherif Abdel-Naby
209+
Copyright (c) 2022 Sherif Abdel-Naby
204210
205211
# Contribution
206212

0 commit comments

Comments
 (0)