Skip to content

Commit 5b51aa6

Browse files
authored
Update README.md
1 parent 941f8dd commit 5b51aa6

File tree

1 file changed

+27
-11
lines changed

1 file changed

+27
-11
lines changed

README.md

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -64,23 +64,39 @@ docker-compose stop
6464

6565
Build options are specified by passing --build-arg FOO=BAR for each argument you want to pass. Available build arguments are:
6666

67-
Host UID (required)
68-
- `HOST_UID`=num\
69-
Example 1: to set the current user's UID `--build-arg HOST_UID=$(id -u)`
67+
`HOST_UID`=num\ (required)
68+
69+
The HOST_UID is used to ensure that the host user and the docker www-data user have the same User ID and keep permissions the same. You'd usually want to use the same user ID as the current logged in user in the host in which case you can just do set the value to `$(id -u)` which should work in most \*NIX systems.
70+
71+
Example 1: to set the current user's UID `--build-arg HOST_UID=$(id -u)`\
7072
Example 2: to set a specific UID `--build-arg HOST_UID=1001`
7173

72-
Web Servers:
73-
- `WEB`=**httpd** | nginx
74-
- `APP_HOSTNAME`=**myapp** | _string_
74+
- `APP_HOSTNAME`=**myapp** | _string_ (optional)
75+
76+
The host name that you want to use for for your application. This makes your web server accessible via **appname.local** on your host machine. Default value is **myapp** which makes the web server accessible via **myapp.local**
77+
78+
- `WEB`=**httpd** | nginx (optional)
79+
80+
The web server that you want to use. Available values are httpd (apache) or nginx. Default is httpd.
81+
82+
- `DB`=**mariadb** | mysql (optional)
7583

76-
Database Management System:
77-
- `DB`=**mariadb** | mysql
78-
- `DB_VERSION`=**latest** | _num_
84+
The DBMS that you want to use. Default is **mariadb** but you can also choose mysql.
85+
86+
Warning: Switching DBMS on an existing container is most likely to cause errors due to incompatibility in data formats. It's best to dump the database first, clear the contents of `app/db`, switch DBMS and reimport the sql dump.
87+
88+
- `DB_VERSION`=**latest** | _num_ (optional)
89+
90+
The DBMS version that you want to use. Default version is **latest**. For a list of available versions, see https://hub.docker.com/_/mariadb and https://hub.docker.com/_/mysql.
91+
92+
Warning: Switching DBMS on an existing container is most likely to cause errors due to incompatibility in data formats. It's best to dump the database first, clear the contents of `app/db`, switch DBMS and reimport the sql dump.
7993

80-
PHP
8194
- `PHP_VERSION`=**7** | 7.4 | 7.3 | 7.2 | 7.1 | 7.0 | 5.6
8295

83-
To build PHP 5.6, Nginx (latest) and MySQL 5.6, the build command would be:
96+
The PHP version that you want to use. Currently supports 5.6, 7.0, 7.1, 7.2, 7.3 and 7.4. Setting the version to just *7* will setup the latest PHP 7 available (ie 7.4)
97+
98+
99+
Build Example: To build PHP 5.6, Nginx (latest) and MySQL 5.6, the build command would be:
84100

85101
```sh
86102
docker-compose build --build-arg HOST_UID=$(id -u) \

0 commit comments

Comments
 (0)