+# Copyright (C) The Arvados Authors. All rights reserved.
+#
+# SPDX-License-Identifier: AGPL-3.0
+
# Do not use this file for site configuration. Create application.yml
# instead (see application.yml.example).
+# Below is a sample setting for diagnostics testing.
+# Configure workbench URL as "arvados_workbench_url"
+# Configure test user tokens as "user_tokens".
+# At this time the tests need an "active" user token.
+# Also, configure the pipelines to be executed as "pipelines_to_test".
+# For each of the pipelines identified by the name of your choice
+# ("pipeline_1" and "pipeline_2" in this sample), provide the following:
+# template_uuid: is the uuid of the template to be executed
+# input_paths: an array of inputs for the pipeline. Use either a collection's "uuid"
+# or a file's "uuid/file_name" path in this array. If the pipeline does not require
+# any inputs, this can be omitted.
+# max_wait_seconds: max time in seconds to wait for the pipeline run to complete.
+# Default value of 30 seconds is used when this value is not provided.
+diagnostics:
+ arvados_workbench_url: https://localhost:3031
+ user_tokens:
+ active: eu33jurqntstmwo05h1jr3eblmi961e802703y6657s8zb14r
+ pipelines_to_test:
+ pipeline_1:
+ template_uuid: zzzzz-p5p6p-rxj8d71854j9idn
+ input_paths: [zzzzz-4zz18-nz98douzhaa3jh2]
+ max_wait_seconds: 10
+ pipeline_2:
+ template_uuid: zzzzz-p5p6p-1xbobfobk94ppbv
+ input_paths: [zzzzz-4zz18-nz98douzhaa3jh2, zzzzz-4zz18-gpw9o5wpcti3nib]
+ container_requests_to_test:
+ container_request_1:
+ workflow_uuid: zzzzz-7fd4e-60e96shgwspt4mw
+ input_paths: []
+ max_wait_seconds: 10
+
+# Below is a sample setting for performance testing.
+# Configure workbench URL as "arvados_workbench_url"
+# Configure test user token as "user_token".
+performance:
+ arvados_workbench_url: https://localhost:3031
+ user_token: eu33jurqntstmwo05h1jr3eblmi961e802703y6657s8zb14r
+
development:
cache_classes: false
eager_load: true
assets.debug: true
profiling_enabled: true
site_name: Arvados Workbench (dev)
- local_modified: <%= '-modified' if `git status -s` %>
+
+ # API server configuration
+ arvados_login_base: ~
+ arvados_v1_base: ~
+ arvados_insecure_https: ~
production:
force_ssl: true
data_import_dir: /data/arvados-workbench-upload/data
data_export_dir: /data/arvados-workbench-download/data
+ # API server configuration
+ arvados_login_base: ~
+ arvados_v1_base: ~
+ arvados_insecure_https: ~
+
site_name: Arvados Workbench
test:
action_controller.allow_forgery_protection: false
action_mailer.delivery_method: :test
active_support.deprecation: :stderr
- profiling_enabled: false
+ profiling_enabled: true
secret_token: <%= rand(2**256).to_s(36) %>
secret_key_base: <%= rand(2**256).to_s(36) %>
+ # This setting is to allow workbench start when running tests, it should be
+ # set to a correct value when testing relevant features.
+ keep_web_url: http://example.com/c=%{uuid_or_pdh}
# When you run the Workbench's integration tests, it starts the API
# server as a dependency. These settings should match the API
# server's Rails defaults. If you adjust those, change these
# settings in application.yml to match.
- arvados_login_base: https://localhost:3001/login
- arvados_v1_base: https://localhost:3001/arvados/v1
+ arvados_login_base: https://localhost:3000/login
+ arvados_v1_base: https://localhost:3000/arvados/v1
arvados_insecure_https: true
site_name: Workbench:test
arvados_insecure_https: true
activation_contact_link: mailto:info@arvados.org
arvados_docsite: http://doc.arvados.org
+ arvados_public_data_doc_url: http://arvados.org/projects/arvados/wiki/Public_Pipelines_and_Datasets
arvados_theme: default
show_user_agreement_inline: false
secret_token: ~
default_openid_prefix: https://www.google.com/accounts/o8/id
send_user_setup_notification_email: true
- # Set user_profile_form_fields to enable and configure the user profile page.
- # Default is set to false. A commented setting with full description is provided below.
+ # Scratch directory used by the remote repository browsing
+ # feature. If it doesn't exist, it (and any missing parents) will be
+ # created using mkdir_p.
+ repository_cache: <%= File.expand_path 'tmp/git', Rails.root %>
+
+ # Set user_profile_form_fields to enable and configure the user
+ # profile page. Default is set to false. A commented example with
+ # full description is provided below.
user_profile_form_fields: false
# Below is a sample setting of user_profile_form_fields config parameter.
# This configuration parameter should be set to either false (to disable) or
- # to an array as shown below.
+ # to an array as shown below.
# Configure the list of input fields to be displayed in the profile page
# using the attribute "key" for each of the input fields.
# This sample shows configuration with one required and one optional form fields.
# the profile page.
user_profile_form_message: Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.
- # source_version
- source_version: "<%= `git log -n 1 --format=%h` %>"
- local_modified: false
+ # Override the automatic version string. With the default value of
+ # false, the version string is read from git-commit.version in
+ # Rails.root (included in vendor packages) or determined by invoking
+ # "git log".
+ source_version: false
# report notification to and from addresses
issue_reporter_email_from: arvados@example.com
issue_reporter_email_to: arvados@example.com
support_email_address: arvados@example.com
-# # Configuration for diagnostics testing. See the "diagnostics" section for more explanation.
-# arvados_workbench_url: false
-# diagnostics_testing_user_tokens: false
-# diagnostics_testing_pipeline_fields: false
+ # generic issue email from
+ email_from: arvados@example.com
- # filename suffixes for which view icon would be shown in collection show page
- filename_suffixes_with_view_icon: [txt, gif, jpeg, jpg, png, html, htm, pdf]
+ # Mimetypes of applications for which the view icon
+ # would be enabled in a collection's show page.
+ # It is sufficient to list only applications here.
+ # No need to list text and image types.
+ application_mimetypes_with_view_icon: [cwl, fasta, go, javascript, json, pdf, python, r, rtf, sam, sh, vnd.realvnc.bed, xml, xsl]
-# Below is a sample setting for diagnostics testing.
-# Configure test user tokens as "diagnostics_testing_user_tokens".
-# At this time the tests need an "active" user token.
-# Also, configure the pipelines to be executed as "diagnostics_testing_pipeline_fields".
-# For each of the pipelines identified by the name of your choice
-# ("tutorial pipeline" and "tutorial pipeline 2" in this sample):
-# template_uuid: is the uuid of the template to be executed
-# input_paths: an array of inputs for the pipeline. Use either a collection's "uuid"
-# or a file's "uuid/file_name" path in this array. If the pipeline does not require
-# any inputs, this can be omitted.
-# max_wait_seconds: max time in seconds to wait for the pipeline run to complete.
-# Default value of 30 seconds is used when this value is not provided.
+ # the maximum number of bytes to load in the log viewer
+ log_viewer_max_bytes: 1000000
-diagnostics:
- arvados_workbench_url: https://localhost:3000/
- diagnostics_testing_user_tokens:
- active: eu33jurqntstmwo05h1jr3eblmi961e802703y6657s8zb14r
- diagnostics_testing_pipeline_fields:
- tutorial pipeline 1:
- template_uuid: zzzzz-p5p6p-rxj8d71854j9idn
- input_paths: [zzzzz-4zz18-nz98douzhaa3jh2]
- max_wait_seconds: 10
- tutorial pipeline 2:
- template_uuid: zzzzz-p5p6p-1xbobfobk94ppbv
- input_paths: [zzzzz-4zz18-nz98douzhaa3jh2, zzzzz-4zz18-gpw9o5wpcti3nib]
+ # Set anonymous_user_token to enable anonymous user access. You can get
+ # the token by running "bundle exec ./script/get_anonymous_user_token.rb"
+ # in the directory where your API server is running.
+ anonymous_user_token: false
+
+ # when anonymous_user_token is configured, show public projects page
+ enable_public_projects_page: true
+
+ # by default, disable the "Getting Started" popup which is specific to the public beta install
+ enable_getting_started_popup: false
+
+ # Ask Arvados API server to compress its response payloads.
+ api_response_compression: true
+
+ # Timeouts for API requests.
+ api_client_connect_timeout: 120
+ api_client_receive_timeout: 300
+
+ # ShellInABox service endpoint URL for a given VM. If false, do not
+ # offer web shell logins.
+ #
+ # E.g., using a path-based proxy server to forward connections to shell hosts:
+ # https://webshell.uuid_prefix.arvadosapi.com/%{hostname}
+ #
+ # E.g., using a name-based proxy server to forward connections to shell hosts:
+ # https://%{hostname}.webshell.uuid_prefix.arvadosapi.com/
+ shell_in_a_box_url: false
+
+ # Format of preview links. If false, use keep_web_download_url
+ # instead, and disable inline preview.
+ # If both are false, Workbench won't start, this is a mandatory configuration.
+ #
+ # Examples:
+ # keep_web_url: https://%{uuid_or_pdh}.collections.uuid_prefix.arvadosapi.com
+ # keep_web_url: https://%{uuid_or_pdh}--collections.uuid_prefix.arvadosapi.com
+ #
+ # Example supporting only public data and collection-sharing links
+ # (other data will be handled as downloads via keep_web_download_url):
+ # keep_web_url: https://collections.uuid_prefix.arvadosapi.com/c=%{uuid_or_pdh}
+ keep_web_url: false
+
+ # Format of download links. If false, use keep_web_url with
+ # disposition=attachment query param.
+ #
+ # The host part of the keep_web_download_url value here must match
+ # the -attachment-only-host argument given to keep-web: if
+ # keep_web_download_url is "https://FOO.EXAMPLE/c=..." then keep-web
+ # must run with "-attachment-only-host=FOO.EXAMPLE".
+ #
+ # If keep_web_download_url is false, and keep_web_url uses a
+ # single-origin form, then Workbench will show an error page
+ # when asked to download or preview private data.
+ #
+ # Example:
+ # keep_web_download_url: https://download.uuid_prefix.arvadosapi.com/c=%{uuid_or_pdh}
+ keep_web_download_url: false
+
+ # In "trust all content" mode, Workbench will redirect download
+ # requests to keep-web, even in the cases when keep-web would have
+ # to expose XSS vulnerabilities in order to handle the redirect.
+ #
+ # When enabling this setting, the -trust-all-content flag on the
+ # keep-web server must also be enabled. For more detail, see
+ # https://godoc.org/github.com/curoverse/arvados/services/keep-web
+ #
+ # This setting has no effect in the recommended configuration, where
+ # the host part of keep_web_url begins with %{uuid_or_pdh}: in this
+ # case XSS protection is provided by browsers' same-origin policy.
+ #
+ # The default setting (false) is appropriate for a multi-user site.
+ trust_all_content: false
+
+ # Maximum number of historic log records of a running job to fetch
+ # and display in the Log tab, while subscribing to web sockets.
+ running_job_log_records_to_fetch: 2000
+
+ # In systems with many shared projects, loading of dashboard and topnav
+ # cab be slow due to collections indexing; use the following parameters
+ # to suppress these properties
+ show_recent_collections_on_dashboard: true
+ show_user_notifications: true
+
+ # Token to be included in all healthcheck requests. Disabled by default.
+ # Workbench expects request header of the format "Authorization: Bearer xxx"
+ ManagementToken: false