diff --git a/README.md b/README.md index 2edbd57..8d0132d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Dockerfile driven template project for building and running container images for Chevereto V4 projects. -> **Warning**: Do not publish generated image to a public registry as the Chevereto License restricts re-distribution rights. +> **Warning**: Do not publish image to a public registry as the Chevereto License restricts re-distribution rights. ## Requirements diff --git a/docs/BUILDING.md b/docs/BUILDING.md index ff7e91a..fe566bd 100644 --- a/docs/BUILDING.md +++ b/docs/BUILDING.md @@ -13,6 +13,12 @@ Available options: * NAMESPACE=local * VERSION=4.0 +Example: + +```sh +make image VERSION=4.0 NAMESPACE=donchecho +``` + ## Make custom images Same as production, but it sources the software from `./chevereto` rather than downloading it. @@ -27,6 +33,12 @@ Available options: * VERSION=4.0 * TAG_BASENAME=${NAMESPACE}_chevereto-build:${VERSION} +Example: + +```sh +make image-custom VERSION=4.0 NAMESPACE=donchecho TAG_BASENAME=mywea +``` + ## Make custom HTTP To build your custom [httpd.conf](../httpd/httpd.conf), edit the contents of [chevereto.conf](../httpd/chevereto.conf) and run: diff --git a/docs/DOCKER-COMPOSE.md b/docs/DOCKER-COMPOSE.md index 98db6e5..f6cbccf 100644 --- a/docs/DOCKER-COMPOSE.md +++ b/docs/DOCKER-COMPOSE.md @@ -15,6 +15,12 @@ Available options: * HOSTNAME_PATH=/ * PROTOCOL=http +Example: + +```sh +make up HOSTNAME=que.chevere.org PORT=80 +``` + ## Up ```sh diff --git a/docs/PERSISTENT.md b/docs/PERSISTENT.md index ca0d939..b1af5a3 100644 --- a/docs/PERSISTENT.md +++ b/docs/PERSISTENT.md @@ -2,12 +2,12 @@ ## Using Services -Chevereto supports using external storage providers for user provided content and website assets. It support any mixture of configurations as you may need to customize. +Chevereto supports external storage providers for user generated content and website assets. It support any mixture of configurations as you may need to customize. For more information: -* [External Storage](https://v3-docs.chevereto.com/features/integrations/external-storage.html) documentation -* [Assets Variables](https://v3-docs.chevereto.com/setup/system/environment.html#assets-variables) reference +* [External Storage](https://v4-admin.chevereto.com/features/external-storage.html) documentation +* [Assets Variables](https://v4-docs.chevereto.com/application/configuration/environment.html#assets-variables) reference ## Using Volumes diff --git a/docs/UPDATING.md b/docs/UPDATING.md index 6f825d1..1cba1fb 100644 --- a/docs/UPDATING.md +++ b/docs/UPDATING.md @@ -29,7 +29,7 @@ To update Chevereto make sure to update this repository, then follow these steps ### Flush application volume -Run the following command to wipe the application volume: +Run the following command to wipe the application volume. This only affects the application layer. ```sh make chevereto-volume-rm