X-Git-Url: https://git.arvados.org/arvados-workbench2.git/blobdiff_plain/fa73e280e87385b37c9aa9bc3cfee45ff66293d6..9a37cc202448e431064b247d36ac0229a6bfa9b2:/README.md diff --git a/README.md b/README.md index 864a54fa..425d1787 100644 --- a/README.md +++ b/README.md @@ -26,14 +26,37 @@ yarn install yarn build -### Configuration +### Build time configuration You can customize project global variables using env variables. Default values are placed in the `.env` file. Example: ``` -REACT_APP_ARVADOS_API_HOST=localhost:8000 yarn start +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