Merge branch 'origin/master' into 14478-log-in-into-clusters

[arvados-workbench2.git] / README.md

diff --git a/README.md b/README.md
index eaed189471536f0a90efc8bebe71b9df6e28c7e9..425d1787848e5b9dad4e077eed23b2f73aea47ea 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,6 +26,37 @@ yarn install
 yarn build
 </pre>
 
+### Build time configuration
+You can customize project global variables using env variables. Default values are placed in the `.env` file.
+
+Example:
+```
+REACT_APP_ARVADOS_CONFIG_URL=config.json yarn build
+```
+
+### Run time configuration
+The app will fetch runtime configuration when starting. By default it will try to fetch `/config.json`. You can customize this url using build time configuration.
+
+Currently this configuration schema is supported:
+```
+{
+    "API_HOST": "string",
+    "VOCABULARY_URL": "string",
+    "FILE_VIEWERS_CONFIG_URL": "string",
+}
+```
+
+#### VOCABULARY_URL
+Local path, or any URL that allows cross-origin requests. See 
+[Vocabulary JSON file example](public/vocabulary-example.json).
+
+### 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)
+
 ### Licensing
 
 Arvados is Free Software. See COPYING for information about Arvados Free