Update package build

[arvados-workbench2.git] / README.md

diff --git a/README.md b/README.md
index 425d1787848e5b9dad4e077eed23b2f73aea47ea..8e720520aa4dec15d6ab089cd46b551d0235d794 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,6 +26,12 @@ yarn install
 yarn build
 </pre>
 
+### Package build
+<pre>
+docker build -t arvados/fpm .
+docker run -v$PWD:$PWD -w $PWD arvados/fpm make packages
+</pre>
+
 ### Build time configuration
 You can customize project global variables using env variables. Default values are placed in the `.env` file.
 
@@ -46,10 +52,18 @@ Currently this configuration schema is supported:
 }
 ```
 
+#### API_HOST
+
+The Arvados base URL.
+
+The `REACT_APP_ARVADOS_API_HOST` environment variable can be used to set the default URL if the run time configuration is unreachable.
+
 #### VOCABULARY_URL
-Local path, or any URL that allows cross-origin requests. See 
+Local path, or any URL that allows cross-origin requests. See
 [Vocabulary JSON file example](public/vocabulary-example.json).
 
+To use the URL defined in the Arvados cluster configuration, remove the entire `VOCABULARY_URL` entry from the runtime configuration. Found in `/config.json` by default.
+
 ### FILE_VIEWERS_CONFIG_URL
 Local path, or any URL that allows cross-origin requests. See:
 
@@ -57,6 +71,8 @@ Local path, or any URL that allows cross-origin requests. See:
 
 [File viewers config scheme](src/models/file-viewers-config.ts)
 
+To use the URL defined in the Arvados cluster configuration, remove the entire `FILE_VIEWERS_CONFIG_URL` entry from the runtime configuration. Found in `/config.json` by default.
+
 ### Licensing
 
 Arvados is Free Software. See COPYING for information about Arvados Free