diff --git a/README.md b/README.md index d4dcbaa..8dc5da8 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ If youโ€™re not sure, you probably want to go for `friendsofredaxo/redaxo:5` ## Environment variables +๐Ÿค– **REDAXO is auto-installed** within the container if the web root is empty and all required environment variables are provided. + System settings: * **`REDAXO_SERVER`** @@ -84,7 +86,6 @@ $ docker run \ Example for REDAXO container with MariaDB container: ```yml -version: '3' services: redaxo: @@ -122,6 +123,16 @@ volumes: db: ``` + +## Extend REDAXO setup via `custom-setup.sh` script ๐Ÿš€ + +After REDAXO has been successfully installed, a `/usr/local/bin/custom-setup.sh` script is executed, if it is available. This can be quite useful for pre-installing REDAXO addOns, updating configuration or further customizing the environment. + +For example, our [website demos](https://github.com/FriendsOfREDAXO/docker-demos) make use of it to auto-install demo packages via CLI. See [`custom-setup.sh`](https://github.com/FriendsOfREDAXO/docker-demos/blob/main/images/base/custom-setup.sh) of the base demo, copied via [`Dockerfile`](https://github.com/FriendsOfREDAXO/docker-demos/blob/main/images/base/Dockerfile) into the container. + +Also, a working recipe: [REDAXO + custom setup with pre-installed addons](https://github.com/FriendsOfREDAXO/docker-redaxo/tree/main/recipes/custom-setup-with-addons) + + ## Recipes ๐Ÿง See [recipes](https://github.com/FriendsOfREDAXO/docker-redaxo/tree/main/recipes) section for further examples!