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