Skip to content

Commit

Permalink
Merge pull request #93 from FriendsOfREDAXO/schuer-docs
Browse files Browse the repository at this point in the history
Documentation updates
  • Loading branch information
schuer authored Oct 6, 2024
2 parents f77f804 + b18d792 commit e685cf6
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`**
Expand Down Expand Up @@ -84,7 +86,6 @@ $ docker run \
Example for REDAXO container with MariaDB container:

```yml
version: '3'
services:

redaxo:
Expand Down Expand Up @@ -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!
Expand Down

0 comments on commit e685cf6

Please sign in to comment.