15718: Adds API revision number from discovery doc to sessions.

[arvados-workbench2.git] / README.md

diff --git a/README.md b/README.md
index ea9bc02fc1f0f038b016f5fd8f5ade2ab38ad2f9..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.
 
@@ -41,10 +47,32 @@ Currently this configuration schema is supported:
 ```
 {
     "API_HOST": "string",
-    "VOCABULARY_URL": "string"
+    "VOCABULARY_URL": "string",
+    "FILE_VIEWERS_CONFIG_URL": "string",
 }
 ```
 
+#### 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
+[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:
+
+[File viewers config file example](public/file-viewers-example.json)
+
+[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