X-Git-Url: https://git.arvados.org/arvados-workbench2.git/blobdiff_plain/8f5943cbb10f0723363981b9b10143ea50f605d2..a1e2b8ba77e4a7273940a3fc542bc42e282618a7:/README.md diff --git a/README.md b/README.md index eaed1894..e8d77701 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,29 @@ yarn install yarn build +### 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" +} +``` + +#### VOCABULARY_URL +Local path, or any URL that allows cross-origin requests. See +[Vocabulary JSON file example](public/vocabulary-example.json). + ### Licensing Arvados is Free Software. See COPYING for information about Arvados Free