apps/workbench/config/application.default.yml

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