diff README.md @ 3:d4ae83dedb14 draft

planemo upload for repository https://github.com/TAMU-CPT/galaxy-webapollo commit 4ac38d0b6dba1183f3e78eb5c224c7051064b4a5
author eric-rasche
date Thu, 12 Jan 2017 11:52:28 -0500
parents 6002cc0df04e
children
line wrap: on
line diff
--- a/README.md	Tue May 03 13:48:11 2016 -0400
+++ b/README.md	Thu Jan 12 11:52:28 2017 -0500
@@ -1,7 +1,20 @@
-# galaxy-webapollo
+# galaxy-apollo
+
+Galaxy tools to interface with Apollo
+The webapollo.py file is also [separately available](https://github.com/erasche/python-apollo) as a pip-installable package.
+
+## ENV
+
+The following environment variables must be set:
 
-Galaxy tools to interface with WebApollo
-The webapollo.py file is also [separately available](https://github.com/erasche/python-apollo) as a pip-installable package.
+
+ENV                           | Use
+---                           | ---
+ `$GALAXY_WEBAPOLLO_URL`      | The URL at which Apollo is accessible, internal to Galaxy and where the tools run. Must be absolute, with FQDN and protocol.
+ `$GALAXY_WEBAPOLLO_USER`     | The admin user which Galaxy should use to talk to Apollo.
+ `$GALAXY_WEBAPOLLO_PASSWORD` | The password for the admin user.
+ `$GALAXY_WEBAPOLLO_EXT_URL`  | The external URL at which Apollo is accessible to end users. May be relative or absolute.
+ `$GALAXY_SHARED_DIR`         | Directory shared between Galaxy and Apollo, used to exchange JBrowse instances.
 
 ## License