apps/workbench/config/application.default.yml

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 # Do not use this file for site configuration. Create application.yml
   6 # instead (see application.yml.example).
   7
   8 # Below is a sample setting for diagnostics testing.
   9 # Configure workbench URL as "arvados_workbench_url"
  10 # Configure test user tokens as "user_tokens".
  11 #   At this time the tests need an "active" user token.
  12 # Also, configure the pipelines to be executed as "pipelines_to_test".
  13 # For each of the pipelines identified by the name of your choice
  14 #     ("pipeline_1" and "pipeline_2" in this sample), provide the following:
  15 #   template_uuid: is the uuid of the template to be executed
  16 #   input_paths: an array of inputs for the pipeline. Use either a collection's "uuid"
  17 #     or a file's "uuid/file_name" path in this array. If the pipeline does not require
  18 #     any inputs, this can be omitted.
  19 #   max_wait_seconds: max time in seconds to wait for the pipeline run to complete.
  20 #     Default value of 30 seconds is used when this value is not provided.
  21 diagnostics:
  22   arvados_workbench_url: https://localhost:3031
  23   user_tokens:
  24     active: eu33jurqntstmwo05h1jr3eblmi961e802703y6657s8zb14r
  25   pipelines_to_test:
  26     pipeline_1:
  27       template_uuid: zzzzz-p5p6p-rxj8d71854j9idn
  28       input_paths: [zzzzz-4zz18-nz98douzhaa3jh2]
  29       max_wait_seconds: 10
  30     pipeline_2:
  31       template_uuid: zzzzz-p5p6p-1xbobfobk94ppbv
  32       input_paths: [zzzzz-4zz18-nz98douzhaa3jh2, zzzzz-4zz18-gpw9o5wpcti3nib]
  33   container_requests_to_test:
  34     container_request_1:
  35       workflow_uuid: zzzzz-7fd4e-60e96shgwspt4mw
  36       input_paths: []
  37       max_wait_seconds: 10
  38
  39 # Below is a sample setting for performance testing.
  40 # Configure workbench URL as "arvados_workbench_url"
  41 # Configure test user token as "user_token".
  42 performance:
  43   arvados_workbench_url: https://localhost:3031
  44   user_token: eu33jurqntstmwo05h1jr3eblmi961e802703y6657s8zb14r
  45
  46 development:
  47   cache_classes: false
  48   eager_load: true
  49   consider_all_requests_local: true
  50   action_controller.perform_caching: false
  51   action_mailer.raise_delivery_errors: false
  52   active_support.deprecation: :log
  53   action_dispatch.best_standards_support: :builtin
  54   assets.debug: true
  55   profiling_enabled: true
  56   site_name: Arvados Workbench (dev)
  57
  58   # API server configuration
  59   arvados_login_base: ~
  60   arvados_v1_base: ~
  61   arvados_insecure_https: ~
  62
  63 production:
  64   force_ssl: true
  65   cache_classes: true
  66   eager_load: true
  67   consider_all_requests_local: false
  68   action_controller.perform_caching: true
  69   serve_static_files: false
  70   assets.compile: false
  71   assets.digest: true
  72   i18n.fallbacks: true
  73   active_support.deprecation: :notify
  74   profiling_enabled: false
  75   log_level: info
  76
  77   arvados_insecure_https: false
  78
  79   data_import_dir: /data/arvados-workbench-upload/data
  80   data_export_dir: /data/arvados-workbench-download/data
  81
  82   # API server configuration
  83   arvados_login_base: ~
  84   arvados_v1_base: ~
  85   arvados_insecure_https: ~
  86
  87   site_name: Arvados Workbench
  88
  89 test:
  90   cache_classes: true
  91   eager_load: false
  92   serve_static_files: true
  93   static_cache_control: public, max-age=3600
  94   consider_all_requests_local: true
  95   action_controller.perform_caching: false
  96   action_dispatch.show_exceptions: false
  97   action_controller.allow_forgery_protection: false
  98   action_mailer.delivery_method: :test
  99   active_support.deprecation: :stderr
 100   profiling_enabled: true
 101   secret_token: <%= rand(2**256).to_s(36) %>
 102   secret_key_base: <%= rand(2**256).to_s(36) %>
 103   # This setting is to allow workbench start when running tests, it should be
 104   # set to a correct value when testing relevant features.
 105   keep_web_url: http://example.com/c=%{uuid_or_pdh}
 106
 107   # When you run the Workbench's integration tests, it starts the API
 108   # server as a dependency.  These settings should match the API
 109   # server's Rails defaults.  If you adjust those, change these
 110   # settings in application.yml to match.
 111   arvados_login_base: https://localhost:3000/login
 112   arvados_v1_base: https://localhost:3000/arvados/v1
 113   arvados_insecure_https: true
 114
 115   site_name: Workbench:test
 116
 117   # Enable user profile with one required field
 118   user_profile_form_fields:
 119     - key: organization
 120       type: text
 121       form_field_title: Institution
 122       form_field_description: Your organization
 123       required: true
 124     - key: role
 125       type: select
 126       form_field_title: Your role
 127       form_field_description: Choose the category that best describes your role in your organization.
 128       options:
 129         - Bio-informatician
 130         - Computational biologist
 131         - Biologist or geneticist
 132         - Software developer
 133         - IT
 134         - Other
 135
 136 common:
 137   assets.js_compressor: false
 138   assets.css_compressor: false
 139   data_import_dir: /tmp/arvados-workbench-upload
 140   data_export_dir: /tmp/arvados-workbench-download
 141   arvados_login_base: https://arvados.local/login
 142   arvados_v1_base: https://arvados.local/arvados/v1
 143   arvados_insecure_https: true
 144   activation_contact_link: mailto:info@arvados.org
 145   arvados_docsite: http://doc.arvados.org
 146   arvados_public_data_doc_url: http://arvados.org/projects/arvados/wiki/Public_Pipelines_and_Datasets
 147   arvados_theme: default
 148   show_user_agreement_inline: false
 149   secret_token: ~
 150   secret_key_base: false
 151   default_openid_prefix: https://www.google.com/accounts/o8/id
 152   send_user_setup_notification_email: true
 153
 154   # Scratch directory used by the remote repository browsing
 155   # feature. If it doesn't exist, it (and any missing parents) will be
 156   # created using mkdir_p.
 157   repository_cache: <%= File.expand_path 'tmp/git', Rails.root %>
 158
 159   # Set user_profile_form_fields to enable and configure the user
 160   # profile page. Default is set to false. A commented example with
 161   # full description is provided below.
 162   user_profile_form_fields: false
 163
 164   # Below is a sample setting of user_profile_form_fields config parameter.
 165   # This configuration parameter should be set to either false (to disable) or
 166   # to an array as shown below.
 167   # Configure the list of input fields to be displayed in the profile page
 168   # using the attribute "key" for each of the input fields.
 169   # This sample shows configuration with one required and one optional form fields.
 170   # For each of these input fields:
 171   #   You can specify "type" as "text" or "select".
 172   #   List the "options" to be displayed for each of the "select" menu.
 173   #   Set "required" as "true" for any of these fields to make them required.
 174   # If any of the required fields are missing in the user's profile, the user will be
 175   # redirected to the profile page before they can access any Workbench features.
 176   #user_profile_form_fields:
 177   #  - key: organization
 178   #    type: text
 179   #    form_field_title: Institution/Company
 180   #    form_field_description: Your organization
 181   #    required: true
 182   #  - key: role
 183   #    type: select
 184   #    form_field_title: Your role
 185   #    form_field_description: Choose the category that best describes your role in your organization.
 186   #    options:
 187   #      - Bio-informatician
 188   #      - Computational biologist
 189   #      - Biologist or geneticist
 190   #      - Software developer
 191   #      - IT
 192   #      - Other
 193
 194   # Use "user_profile_form_message" to configure the message you want to display on
 195   # the profile page.
 196   user_profile_form_message: Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.
 197
 198   # Override the automatic version string. With the default value of
 199   # false, the version string is read from git-commit.version in
 200   # Rails.root (included in vendor packages) or determined by invoking
 201   # "git log".
 202   source_version: false
 203
 204   # Override the automatic package string. With the default value of
 205   # false, the package string is read from package-build.version in
 206   # Rails.root (included in vendor packages).
 207   package_version: false
 208
 209   # report notification to and from addresses
 210   issue_reporter_email_from: arvados@example.com
 211   issue_reporter_email_to: arvados@example.com
 212   support_email_address: arvados@example.com
 213
 214   # generic issue email from
 215   email_from: arvados@example.com
 216
 217   # Mimetypes of applications for which the view icon
 218   # would be enabled in a collection's show page.
 219   # It is sufficient to list only applications here.
 220   # No need to list text and image types.
 221   application_mimetypes_with_view_icon: [cwl, fasta, go, javascript, json, pdf, python, r, rtf, sam, x-sh, vnd.realvnc.bed, xml, xsl]
 222
 223   # the maximum number of bytes to load in the log viewer
 224   log_viewer_max_bytes: 1000000
 225
 226   # Set anonymous_user_token to enable anonymous user access. You can get
 227   # the token by running "bundle exec ./script/get_anonymous_user_token.rb"
 228   # in the directory where your API server is running.
 229   anonymous_user_token: false
 230
 231   # when anonymous_user_token is configured, show public projects page
 232   enable_public_projects_page: true
 233
 234   # by default, disable the "Getting Started" popup which is specific to the public beta install
 235   enable_getting_started_popup: false
 236
 237   # Ask Arvados API server to compress its response payloads.
 238   api_response_compression: true
 239
 240   # Timeouts for API requests.
 241   api_client_connect_timeout: 120
 242   api_client_receive_timeout: 300
 243
 244   # ShellInABox service endpoint URL for a given VM.  If false, do not
 245   # offer web shell logins.
 246   #
 247   # E.g., using a path-based proxy server to forward connections to shell hosts:
 248   # https://webshell.uuid_prefix.arvadosapi.com/%{hostname}
 249   #
 250   # E.g., using a name-based proxy server to forward connections to shell hosts:
 251   # https://%{hostname}.webshell.uuid_prefix.arvadosapi.com/
 252   shell_in_a_box_url: false
 253
 254   # Format of preview links. If false, use keep_web_download_url
 255   # instead, and disable inline preview.
 256   # If both are false, Workbench won't start, this is a mandatory configuration.
 257   #
 258   # Examples:
 259   # keep_web_url: https://%{uuid_or_pdh}.collections.uuid_prefix.arvadosapi.com
 260   # keep_web_url: https://%{uuid_or_pdh}--collections.uuid_prefix.arvadosapi.com
 261   #
 262   # Example supporting only public data and collection-sharing links
 263   # (other data will be handled as downloads via keep_web_download_url):
 264   # keep_web_url: https://collections.uuid_prefix.arvadosapi.com/c=%{uuid_or_pdh}
 265   keep_web_url: false
 266
 267   # Format of download links. If false, use keep_web_url with
 268   # disposition=attachment query param.
 269   #
 270   # The host part of the keep_web_download_url value here must match
 271   # the -attachment-only-host argument given to keep-web: if
 272   # keep_web_download_url is "https://FOO.EXAMPLE/c=..." then keep-web
 273   # must run with "-attachment-only-host=FOO.EXAMPLE".
 274   #
 275   # If keep_web_download_url is false, and keep_web_url uses a
 276   # single-origin form, then Workbench will show an error page
 277   # when asked to download or preview private data.
 278   #
 279   # Example:
 280   # keep_web_download_url: https://download.uuid_prefix.arvadosapi.com/c=%{uuid_or_pdh}
 281   keep_web_download_url: false
 282
 283   # In "trust all content" mode, Workbench will redirect download
 284   # requests to keep-web, even in the cases when keep-web would have
 285   # to expose XSS vulnerabilities in order to handle the redirect.
 286   #
 287   # When enabling this setting, the -trust-all-content flag on the
 288   # keep-web server must also be enabled.  For more detail, see
 289   # https://godoc.org/github.com/curoverse/arvados/services/keep-web
 290   #
 291   # This setting has no effect in the recommended configuration, where
 292   # the host part of keep_web_url begins with %{uuid_or_pdh}: in this
 293   # case XSS protection is provided by browsers' same-origin policy.
 294   #
 295   # The default setting (false) is appropriate for a multi-user site.
 296   trust_all_content: false
 297
 298   # Maximum number of historic log records of a running job to fetch
 299   # and display in the Log tab, while subscribing to web sockets.
 300   running_job_log_records_to_fetch: 2000
 301
 302   # In systems with many shared projects, loading of dashboard and topnav
 303   # cab be slow due to collections indexing; use the following parameters
 304   # to suppress these properties
 305   show_recent_collections_on_dashboard: true
 306   show_user_notifications: true
 307
 308   # Token to be included in all healthcheck requests. Disabled by default.
 309   # Workbench expects request header of the format "Authorization: Bearer xxx"
 310   ManagementToken: false
 311
 312   # Enable/disable "multi-site search" in top nav (true/false), or
 313   # link it to the multi-site search on a remote Workbench site.
 314   #
 315   # Example:
 316   # multi_site_search: https://workbench.qr1hi.arvadosapi.com/collections/multisite
 317   multi_site_search: false
 318
 319   #
 320   # Link to use for Arvados Workflow Composer app, or false if not available.
 321   #
 322   composer_url: false
 323
 324   #
 325   # Should workbench allow management of local git repositories? Set to false if
 326   # the jobs api is disabled and there are no local git repositories.
 327   #
 328   repositories: true
 329
 330   #
 331   # Add an item to the user menu pointing to workbench2_url, if not false.
 332   #
 333   # Example:
 334   # workbench2_url: https://workbench2.qr1hi.arvadosapi.com
 335   #
 336   workbench2_url: false