From 241d96828ddadb856453a08a93633dbedba1c02a Mon Sep 17 00:00:00 2001 From: Robert Dailey Date: Mon, 28 Oct 2019 08:05:53 -0500 Subject: [PATCH] Clarify some aspects of the setup instruction example An example is provided for the path to the YML file so that `NEXTCLOUD_PROJECT_NAME` in the example makes sense. --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9387249..03e9957 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ everything using [Docker Compose](https://docs.docker.com/compose/). Below is an example of how you set up your `docker-compose.yml` to work with Nextcloud using this container. Note that the `app` service is greatly simplified for example purposes. It is only to -show usage of the cronjob image in conjunction with your Nextcloud container. +show usage of the cronjob image in conjunction with your Nextcloud container. Note for this example, +the `docker-compose.yml` file is located at `~/docker_services/nextcloud/docker-compose.yml`. ```yml version: '3.7' @@ -41,10 +42,14 @@ services: In this example, the `cron` service runs with a dependency on `app` (which is Nextcloud itself). Every 15 minutes (default) the `cron` service will execute `php -f /var/www/html/cron.php` via the `docker exec` command. The `NEXTCLOUD_CONTAINER_NAME` and `NEXTCLOUD_PROJECT_NAME` work together to -help identify the right container to execute the command in. +help identify the right container to execute the command in. In this case, my project name is +`nextcloud` because Docker Compose uses the name of the directory containing the +`docker-compose.yml` file to prefix the name of the image. And container name is `app` because +that's what I named the service in the YAML file. Note that if you don't use Docker Compose, you can leave `NEXTCLOUD_PROJECT_NAME` blank or omitted -entirely. +entirely. Please see the Environment Variables section below for more details on configuration and +how this all works. ## Environment Variables