[GitHub] csantanapr closed pull request #101: Add information on some env variables to README

[GitBox <gi...@apache.org>]

csantanapr closed pull request #101: Add information on some env variables to README
URL: https://github.com/apache/incubator-openwhisk-devtools/pull/101
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docker-compose/README.md b/docker-compose/README.md
index 19d7af5..7d0d08d 100644
--- a/docker-compose/README.md
+++ b/docker-compose/README.md
@@ -40,10 +40,19 @@ At the end of the execution it prints the output of the function:
 }
 ```
 
-If `PROJECT_HOME` variable is set ( i.e. `PROJECT_HOME=/path/to/openwhisk make quick-start`)
+If `OPENWHISK_PROJECT_HOME` variable is set ( i.e. `OPENWHISK_PROJECT_HOME=/path/to/openwhisk make quick-start`)
 then the command skips downloading the `master` branch and uses instead the source code found in the `PROJECT_HOME` folder.
 This is useful for working with a local clone, making changes to the code, and run it with `docker-compose`.
 
+This is the set of environment variables that can be set:
+
+* `OPENWHISK_PROJECT_HOME` - a checkout of [openwhisk](https://github.com/apache/incubator-openwhisk)
+* `OPENWHISK_CATALOG_HOME` - a checkout of [openwhisk-catalog](https://github.com/apache/incubator-openwhisk-catalog)
+* `WSK_CLI` - the directory where the [`wsk` command line tool](https://github.com/apache/incubator-openwhisk-cli) can be found
+* `DOCKER_IMAGE_PREFIX` - the prefix of the docker images used for actions. If you are building and testing checkouts of runtimes locally, then consider setting this to `whisk`.
+
+Note that these are all optional and only need to be set if you have a local checkout that you want to use.
+
 ## Updating OpenWhisk Invoker or Controller
 
 To update the OpenWhisk Invoker or Controller without restarting everything, run:


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services