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_assets: false
  70   assets.compile: false
  71   assets.digest: true
  72   i18n.fallbacks: true
  73   active_support.deprecation: :notify
  74   profiling_enabled: false
  75
  76   arvados_insecure_https: false
  77
  78   data_import_dir: /data/arvados-workbench-upload/data
  79   data_export_dir: /data/arvados-workbench-download/data
  80
  81   # API server configuration
  82   arvados_login_base: ~
  83   arvados_v1_base: ~
  84   arvados_insecure_https: ~
  85
  86   site_name: Arvados Workbench
  87
  88 test:
  89   cache_classes: true
  90   eager_load: false
  91   serve_static_assets: true
  92   static_cache_control: public, max-age=3600
  93   consider_all_requests_local: true
  94   action_controller.perform_caching: false
  95   action_dispatch.show_exceptions: false
  96   action_controller.allow_forgery_protection: false
  97   action_mailer.delivery_method: :test
  98   active_support.deprecation: :stderr
  99   profiling_enabled: true
 100   secret_token: <%= rand(2**256).to_s(36) %>
 101   secret_key_base: <%= rand(2**256).to_s(36) %>
 102   # This setting is to allow workbench start when running tests, it should be
 103   # set to a correct value when testing relevant features.
 104   keep_web_url: http://example.com/c=%{uuid_or_pdh}
 105
 106   # When you run the Workbench's integration tests, it starts the API
 107   # server as a dependency.  These settings should match the API
 108   # server's Rails defaults.  If you adjust those, change these
 109   # settings in application.yml to match.
 110   arvados_login_base: https://localhost:3000/login
 111   arvados_v1_base: https://localhost:3000/arvados/v1
 112   arvados_insecure_https: true
 113
 114   site_name: Workbench:test
 115
 116   # Enable user profile with one required field
 117   user_profile_form_fields:
 118     - key: organization
 119       type: text
 120       form_field_title: Institution
 121       form_field_description: Your organization
 122       required: true
 123     - key: role
 124       type: select
 125       form_field_title: Your role
 126       form_field_description: Choose the category that best describes your role in your organization.
 127       options:
 128         - Bio-informatician
 129         - Computational biologist
 130         - Biologist or geneticist
 131         - Software developer
 132         - IT
 133         - Other
 134
 135 common:
 136   assets.js_compressor: false
 137   assets.css_compressor: false
 138   data_import_dir: /tmp/arvados-workbench-upload
 139   data_export_dir: /tmp/arvados-workbench-download
 140   arvados_login_base: https://arvados.local/login
 141   arvados_v1_base: https://arvados.local/arvados/v1
 142   arvados_insecure_https: true
 143   activation_contact_link: mailto:info@arvados.org
 144   arvados_docsite: http://doc.arvados.org
 145   arvados_public_data_doc_url: http://arvados.org/projects/arvados/wiki/Public_Pipelines_and_Datasets
 146   arvados_theme: default
 147   show_user_agreement_inline: false
 148   secret_token: ~
 149   secret_key_base: false
 150   default_openid_prefix: https://www.google.com/accounts/o8/id
 151   send_user_setup_notification_email: true
 152
 153   # Scratch directory used by the remote repository browsing
 154   # feature. If it doesn't exist, it (and any missing parents) will be
 155   # created using mkdir_p.
 156   repository_cache: <%= File.expand_path 'tmp/git', Rails.root %>
 157
 158   # Set user_profile_form_fields to enable and configure the user
 159   # profile page. Default is set to false. A commented example with
 160   # full description is provided below.
 161   user_profile_form_fields: false
 162
 163   # Below is a sample setting of user_profile_form_fields config parameter.
 164   # This configuration parameter should be set to either false (to disable) or
 165   # to an array as shown below.
 166   # Configure the list of input fields to be displayed in the profile page
 167   # using the attribute "key" for each of the input fields.
 168   # This sample shows configuration with one required and one optional form fields.
 169   # For each of these input fields:
 170   #   You can specify "type" as "text" or "select".
 171   #   List the "options" to be displayed for each of the "select" menu.
 172   #   Set "required" as "true" for any of these fields to make them required.
 173   # If any of the required fields are missing in the user's profile, the user will be
 174   # redirected to the profile page before they can access any Workbench features.
 175   #user_profile_form_fields:
 176   #  - key: organization
 177   #    type: text
 178   #    form_field_title: Institution/Company
 179   #    form_field_description: Your organization
 180   #    required: true
 181   #  - key: role
 182   #    type: select
 183   #    form_field_title: Your role
 184   #    form_field_description: Choose the category that best describes your role in your organization.
 185   #    options:
 186   #      - Bio-informatician
 187   #      - Computational biologist
 188   #      - Biologist or geneticist
 189   #      - Software developer
 190   #      - IT
 191   #      - Other
 192
 193   # Use "user_profile_form_message" to configure the message you want to display on
 194   # the profile page.
 195   user_profile_form_message: Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.
 196
 197   # Override the automatic version string. With the default value of
 198   # false, the version string is read from git-commit.version in
 199   # Rails.root (included in vendor packages) or determined by invoking
 200   # "git log".
 201   source_version: false
 202
 203   # report notification to and from addresses
 204   issue_reporter_email_from: arvados@example.com
 205   issue_reporter_email_to: arvados@example.com
 206   support_email_address: arvados@example.com
 207
 208   # generic issue email from
 209   email_from: arvados@example.com
 210
 211   # Mimetypes of applications for which the view icon
 212   # would be enabled in a collection's show page.
 213   # It is sufficient to list only applications here.
 214   # No need to list text and image types.
 215   application_mimetypes_with_view_icon: [cwl, fasta, go, javascript, json, pdf, python, r, rtf, sam, sh, vnd.realvnc.bed, xml, xsl]
 216
 217   # the maximum number of bytes to load in the log viewer
 218   log_viewer_max_bytes: 1000000
 219
 220   # Set anonymous_user_token to enable anonymous user access. You can get
 221   # the token by running "bundle exec ./script/get_anonymous_user_token.rb"
 222   # in the directory where your API server is running.
 223   anonymous_user_token: false
 224
 225   # when anonymous_user_token is configured, show public projects page
 226   enable_public_projects_page: true
 227
 228   # by default, disable the "Getting Started" popup which is specific to the public beta install
 229   enable_getting_started_popup: false
 230
 231   # Ask Arvados API server to compress its response payloads.
 232   api_response_compression: true
 233
 234   # Timeouts for API requests.
 235   api_client_connect_timeout: 120
 236   api_client_receive_timeout: 300
 237
 238   # ShellInABox service endpoint URL for a given VM.  If false, do not
 239   # offer web shell logins.
 240   #
 241   # E.g., using a path-based proxy server to forward connections to shell hosts:
 242   # https://webshell.uuid_prefix.arvadosapi.com/%{hostname}
 243   #
 244   # E.g., using a name-based proxy server to forward connections to shell hosts:
 245   # https://%{hostname}.webshell.uuid_prefix.arvadosapi.com/
 246   shell_in_a_box_url: false
 247
 248   # Format of preview links. If false, use keep_web_download_url
 249   # instead, and disable inline preview.
 250   # If both are false, Workbench won't start, this is a mandatory configuration.
 251   #
 252   # Examples:
 253   # keep_web_url: https://%{uuid_or_pdh}.collections.uuid_prefix.arvadosapi.com
 254   # keep_web_url: https://%{uuid_or_pdh}--collections.uuid_prefix.arvadosapi.com
 255   #
 256   # Example supporting only public data and collection-sharing links
 257   # (other data will be handled as downloads via keep_web_download_url):
 258   # keep_web_url: https://collections.uuid_prefix.arvadosapi.com/c=%{uuid_or_pdh}
 259   keep_web_url: false
 260
 261   # Format of download links. If false, use keep_web_url with
 262   # disposition=attachment query param.
 263   #
 264   # The host part of the keep_web_download_url value here must match
 265   # the -attachment-only-host argument given to keep-web: if
 266   # keep_web_download_url is "https://FOO.EXAMPLE/c=..." then keep-web
 267   # must run with "-attachment-only-host=FOO.EXAMPLE".
 268   #
 269   # If keep_web_download_url is false, and keep_web_url uses a
 270   # single-origin form, then Workbench will show an error page
 271   # when asked to download or preview private data.
 272   #
 273   # Example:
 274   # keep_web_download_url: https://download.uuid_prefix.arvadosapi.com/c=%{uuid_or_pdh}
 275   keep_web_download_url: false
 276
 277   # In "trust all content" mode, Workbench will redirect download
 278   # requests to keep-web, even in the cases when keep-web would have
 279   # to expose XSS vulnerabilities in order to handle the redirect.
 280   #
 281   # When enabling this setting, the -trust-all-content flag on the
 282   # keep-web server must also be enabled.  For more detail, see
 283   # https://godoc.org/github.com/curoverse/arvados/services/keep-web
 284   #
 285   # This setting has no effect in the recommended configuration, where
 286   # the host part of keep_web_url begins with %{uuid_or_pdh}: in this
 287   # case XSS protection is provided by browsers' same-origin policy.
 288   #
 289   # The default setting (false) is appropriate for a multi-user site.
 290   trust_all_content: false
 291
 292   # Maximum number of historic log records of a running job to fetch
 293   # and display in the Log tab, while subscribing to web sockets.
 294   running_job_log_records_to_fetch: 2000
 295
 296   # In systems with many shared projects, loading of dashboard and topnav
 297   # cab be slow due to collections indexing; use the following parameters
 298   # to suppress these properties
 299   show_recent_collections_on_dashboard: true
 300   show_user_notifications: true
 301
 302   # Token to be included in all healthcheck requests. Disabled by default.
 303   # Workbench expects request header of the format "Authorization: Bearer xxx"
 304   ManagementToken: false