X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/22152102405a1407355d42a32385efd0d83bbc9c..f3863df1c40a09e092f6caf53e43324e0477bb5d:/README.md
diff --git a/README.md b/README.md
index 998d424662..38a26e54bf 100644
--- a/README.md
+++ b/README.md
@@ -14,10 +14,21 @@ Install [redux-devtools-extension](https://chrome.google.com/webstore/detail/red
### Start project
yarn start
-### Run tests
+### Run unit tests
-yarn install -yarn test +make unit-tests ++ +### Run end-to-end tests + +
+make integration-tests ++ +### Run end-to-end tests in a Docker container + +
+make integration-tests-in-docker### Production build @@ -26,6 +37,12 @@ yarn install yarn build +### Package build +
+make workbench2-build-image +docker run -v$PWD:$PWD -w $PWD arvados/fpm make packages ++ ### Build time configuration You can customize project global variables using env variables. Default values are placed in the `.env` file. @@ -40,10 +57,33 @@ The app will fetch runtime configuration when starting. By default it will try t Currently this configuration schema is supported: ``` { - "API_HOST": "string" + "API_HOST": "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