README.md
1[](https://github.com/TYPO3/CmsComposerInstallers/actions?query=workflow%3ACI)
2
3TYPO3 CMS Composer installers
4=============================
5
6This package acts as composer plugin in order to download and install
7TYPO3 core and extensions and put them into a directory structure
8which is suitable for TYPO3 to work correctly.
9
10The behavior of the installer can be influenced by configuration in the `extra` section of the root `composer.json`
11
12```
13 "extra": {
14 "typo3/cms": {
15 "web-dir": "public"
16 }
17 }
18```
19
20#### `web-dir`
21You can specify a relative path from the base directory, where the public document root should be located.
22
23*The default value* is `"public"`, which means a `"public"` directory at the same level as your root `composer.json`.
24
25#### `app-dir`
26You can specify a relative path from the base directory, where the TYPO3 application directory should be located.
27This directory will contain the TYPO3 folders `var` and `config`.
28It is **not** recommended to change this directory. If you have to, e.g. to simplify a CI setup for TYPO3 extensions,
29the `web-dir` path **must** be a subdirectory of `app-dir`. Otherwise the `app-dir` directive will be ignored.
30
31*The default value* is the base directory, which means at the same level as your root `composer.json`.
32
33## Feedback/ Bug reports/ Contribution
34
35Bug reports, feature requests and pull requests are welcome in the Github repository: https://github.com/TYPO3/CmsComposerInstallers/
36
){kind=link}