1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
5 # Do not use this file for site configuration. Create
6 # /etc/arvados/config.yml instead.
8 # The order of precedence (highest to lowest):
9 # 1. Legacy component-specific config files (deprecated)
10 # 2. /etc/arvados/config.yml
11 # 3. config.default.yml
17 # Token to be included in all healthcheck requests. Disabled by default.
18 # Server expects request header of the format "Authorization: Bearer xxx"
23 # In each of the service sections below, the keys under
24 # InternalURLs are the endpoints where the service should be
25 # listening, and reachable from other hosts in the cluster.
28 "http://example.host:12345": {}
62 # Base URL for Workbench inline preview. If blank, use
63 # WebDAVDownload instead, and disable inline preview.
64 # If both are empty, downloading collections from workbench
67 # It is important to properly configure the download service
68 # to migitate cross-site-scripting (XSS) attacks. A HTML page
69 # can be stored in collection. If an attacker causes a victim
70 # to visit that page through Workbench, it will be rendered by
71 # the browser. If all collections are served at the same
72 # domain, the browser will consider collections as coming from
73 # the same origin and having access to the same browsing data,
74 # enabling malicious Javascript on that page to access Arvados
75 # on behalf of the victim.
77 # This is mitigating by having separate domains for each
78 # collection, or limiting preview to circumstances where the
79 # collection is not accessed with the user's regular
82 # Serve preview links using uuid or pdh in subdomain
83 # (requires wildcard DNS and TLS certificate)
84 # https://*.collections.uuid_prefix.arvadosapi.com
86 # Serve preview links using uuid or pdh in main domain
87 # (requires wildcard DNS and TLS certificate)
88 # https://*--collections.uuid_prefix.arvadosapi.com
90 # Serve preview links by setting uuid or pdh in the path.
91 # This configuration only allows previews of public data or
92 # collection-sharing links, because these use the anonymous
93 # user token or the token is already embedded in the URL.
94 # Other data must be handled as downloads via WebDAVDownload:
95 # https://collections.uuid_prefix.arvadosapi.com
101 # Base URL for download links. If blank, serve links to WebDAV
102 # with disposition=attachment query param. Unlike preview links,
103 # browsers do not render attachments, so there is no risk of XSS.
105 # If WebDAVDownload is blank, and WebDAV uses a
106 # single-origin form, then Workbench will show an error page
108 # Serve download links by setting uuid or pdh in the path:
109 # https://download.uuid_prefix.arvadosapi.com
121 # ShellInABox service endpoint URL for a given VM. If empty, do not
122 # offer web shell logins.
124 # E.g., using a path-based proxy server to forward connections to shell hosts:
125 # https://webshell.uuid_prefix.arvadosapi.com
127 # E.g., using a name-based proxy server to forward connections to shell hosts:
128 # https://*.webshell.uuid_prefix.arvadosapi.com
144 # max concurrent connections per arvados server daemon
147 # All parameters here are passed to the PG client library in a connection string;
148 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
156 # Maximum size (in bytes) allowed for a single API request. This
157 # limit is published in the discovery document for use by clients.
158 # Note: You must separately configure the upstream web server or
159 # proxy to actually enforce the desired maximum request size on the
161 MaxRequestSize: 134217728
163 # Limit the number of bytes read from the database during an index
164 # request (by retrieving and returning fewer rows than would
165 # normally be returned in a single response).
166 # Note 1: This setting never reduces the number of returned rows to
167 # zero, no matter how big the first data row is.
168 # Note 2: Currently, this is only checked against a specific set of
169 # columns that tend to get large (collections.manifest_text,
170 # containers.mounts, workflows.definition). Other fields (e.g.,
171 # "properties" hashes) are not counted against this limit.
172 MaxIndexDatabaseRead: 134217728
174 # Maximum number of items to return when responding to a APIs that
175 # can return partial result sets using limit and offset parameters
176 # (e.g., *.index, groups.contents). If a request specifies a "limit"
177 # parameter higher than this value, this value is used instead.
178 MaxItemsPerResponse: 1000
180 # Maximum number of concurrent requests to accept in a single
181 # service process, or 0 for no limit. Currently supported only
183 MaxConcurrentRequests: 0
185 # Maximum number of 64MiB memory buffers per keepstore server
186 # process, or 0 for no limit.
187 MaxKeepBlobBuffers: 128
189 # API methods to disable. Disabled methods are not listed in the
190 # discovery document, and respond 404 to all requests.
191 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
194 # Interval (seconds) between asynchronous permission view updates. Any
195 # permission-updating API called with the 'async' parameter schedules a an
196 # update on the permission view in the future, if not already scheduled.
197 AsyncPermissionsUpdateInterval: 20s
199 # Maximum number of concurrent outgoing requests to make while
200 # serving a single incoming multi-cluster (federated) request.
201 MaxRequestAmplification: 4
203 # RailsSessionSecretToken is a string of alphanumeric characters
204 # used by Rails to sign session tokens. IMPORTANT: This is a
205 # site secret. It should be at least 50 characters.
206 RailsSessionSecretToken: ""
208 # Maximum wall clock time to spend handling an incoming request.
211 # Websocket will send a periodic empty event after 'SendTimeout'
212 # if there is no other activity to maintain the connection /
213 # detect dropped connections.
216 WebsocketClientEventQueue: 64
217 WebsocketServerEventQueue: 4
219 # Timeout on requests to internal Keep services.
220 KeepServiceRequestTimeout: 15s
223 # Config parameters to automatically setup new users. If enabled,
224 # this users will be able to self-activate. Enable this if you want
225 # to run an open instance where anyone can create an account and use
226 # the system without requiring manual approval.
228 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
229 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
230 AutoSetupNewUsers: false
231 AutoSetupNewUsersWithVmUUID: ""
232 AutoSetupNewUsersWithRepository: false
233 AutoSetupUsernameBlacklist:
242 # When NewUsersAreActive is set to true, new users will be active
243 # immediately. This skips the "self-activate" step which enforces
244 # user agreements. Should only be enabled for development.
245 NewUsersAreActive: false
247 # The e-mail address of the user you would like to become marked as an admin
248 # user on their first login.
249 # In the default configuration, authentication happens through the Arvados SSO
250 # server, which uses OAuth2 against Google's servers, so in that case this
251 # should be an address associated with a Google account.
252 AutoAdminUserWithEmail: ""
254 # If AutoAdminFirstUser is set to true, the first user to log in when no
255 # other admin users exist will automatically become an admin user.
256 AutoAdminFirstUser: false
258 # Email address to notify whenever a user creates a profile for the
260 UserProfileNotificationAddress: ""
261 AdminNotifierEmailFrom: arvados@example.com
262 EmailSubjectPrefix: "[ARVADOS] "
263 UserNotifierEmailFrom: arvados@example.com
264 NewUserNotificationRecipients: {}
265 NewInactiveUserNotificationRecipients: {}
267 # Set AnonymousUserToken to enable anonymous user access. You can get
268 # the token by running "bundle exec ./script/get_anonymous_user_token.rb"
269 # in the directory where your API server is running.
270 AnonymousUserToken: ""
273 # Time to keep audit logs, in seconds. (An audit log is a row added
274 # to the "logs" table in the PostgreSQL database each time an
275 # Arvados object is created, modified, or deleted.)
277 # Currently, websocket event notifications rely on audit logs, so
278 # this should not be set lower than 300 (5 minutes).
281 # Maximum number of log rows to delete in a single SQL transaction.
283 # If MaxDeleteBatch is 0, log entries will never be
284 # deleted by Arvados. Cleanup can be done by an external process
285 # without affecting any Arvados system processes, as long as very
286 # recent (<5 minutes old) logs are not deleted.
288 # 100000 is a reasonable batch size for most sites.
291 # Attributes to suppress in events and audit logs. Notably,
292 # specifying {"manifest_text": {}} here typically makes the database
293 # smaller and faster.
295 # Warning: Using any non-empty value here can have undesirable side
296 # effects for any client or component that relies on event logs.
297 # Use at your own risk.
298 UnloggedAttributes: {}
302 # Logging threshold: panic, fatal, error, warn, info, debug, or
306 # Logging format: json or text
309 # Maximum characters of (JSON-encoded) query parameters to include
310 # in each request log entry. When params exceed this size, they will
311 # be JSON-encoded, truncated to this size, and logged as
313 MaxRequestLogParamsSize: 2000
317 # Enable access controls for data stored in Keep. This should
318 # always be set to true on a production cluster.
321 # BlobSigningKey is a string of alphanumeric characters used to
322 # generate permission signatures for Keep locators. It must be
323 # identical to the permission key given to Keep. IMPORTANT: This
324 # is a site secret. It should be at least 50 characters.
326 # Modifying BlobSigningKey will invalidate all existing
327 # signatures, which can cause programs to fail (e.g., arv-put,
328 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
329 # when no such processes are running.
332 # Enable garbage collection of unreferenced blobs in Keep.
335 # Time to leave unreferenced blobs in "trashed" state before
336 # deleting them, or 0 to skip the "trashed" state entirely and
337 # delete unreferenced blobs.
339 # If you use any Amazon S3 buckets as storage volumes, this
340 # must be at least 24h to avoid occasional data loss.
341 BlobTrashLifetime: 336h
343 # How often to check for (and delete) trashed blocks whose
344 # BlobTrashLifetime has expired.
345 BlobTrashCheckInterval: 24h
347 # Maximum number of concurrent "trash blob" and "delete trashed
348 # blob" operations conducted by a single keepstore process. Each
349 # of these can be set to 0 to disable the respective operation.
351 # If BlobTrashLifetime is zero, "trash" and "delete trash"
352 # happen at once, so only the lower of these two values is used.
353 BlobTrashConcurrency: 4
354 BlobDeleteConcurrency: 4
356 # Maximum number of concurrent "create additional replica of
357 # existing blob" operations conducted by a single keepstore
359 BlobReplicateConcurrency: 4
361 # Default replication level for collections. This is used when a
362 # collection's replication_desired attribute is nil.
363 DefaultReplication: 2
365 # Lifetime (in seconds) of blob permission signatures generated by
366 # the API server. This determines how long a client can take (after
367 # retrieving a collection record) to retrieve the collection data
368 # from Keep. If the client needs more time than that (assuming the
369 # collection still has the same content and the relevant user/token
370 # still has permission) the client can retrieve the collection again
371 # to get fresh signatures.
373 # Modifying BlobSigningTTL invalidates existing signatures; see
374 # BlobSigningKey note above.
376 # The default is 2 weeks.
379 # Default lifetime for ephemeral collections: 2 weeks. This must not
380 # be less than BlobSigningTTL.
381 DefaultTrashLifetime: 336h
383 # Interval (seconds) between trash sweeps. During a trash sweep,
384 # collections are marked as trash if their trash_at time has
385 # arrived, and deleted if their delete_at time has arrived.
386 TrashSweepInterval: 60s
388 # If true, enable collection versioning.
389 # When a collection's preserve_version field is true or the current version
390 # is older than the amount of seconds defined on PreserveVersionIfIdle,
391 # a snapshot of the collection's previous state is created and linked to
392 # the current collection.
393 CollectionVersioning: false
395 # 0s = auto-create a new version on every update.
396 # -1s = never auto-create new versions.
397 # > 0s = auto-create a new version when older than the specified number of seconds.
398 PreserveVersionIfIdle: -1s
400 # Managed collection properties. At creation time, if the client didn't
401 # provide the listed keys, they will be automatically populated following
402 # one of the following behaviors:
404 # * UUID of the user who owns the containing project.
405 # responsible_person_uuid: {Function: original_owner, Protected: true}
407 # * Default concrete value.
408 # foo_bar: {Value: baz, Protected: false}
410 # If Protected is true, only an admin user can modify its value.
412 SAMPLE: {Function: original_owner, Protected: true}
414 # In "trust all content" mode, Workbench will redirect download
415 # requests to WebDAV preview link, even in the cases when
416 # WebDAV would have to expose XSS vulnerabilities in order to
417 # handle the redirect (see discussion on Services.WebDAV).
419 # This setting has no effect in the recommended configuration,
420 # where the WebDAV is configured to have a separate domain for
421 # every collection; in this case XSS protection is provided by
422 # browsers' same-origin policy.
424 # The default setting (false) is appropriate for a multi-user site.
425 TrustAllContent: false
427 # Cache parameters for WebDAV content serving:
428 # * TTL: Maximum time to cache manifests and permission checks.
429 # * UUIDTTL: Maximum time to cache collection state.
430 # * MaxBlockEntries: Maximum number of block cache entries.
431 # * MaxCollectionEntries: Maximum number of collection cache entries.
432 # * MaxCollectionBytes: Approximate memory limit for collection cache.
433 # * MaxPermissionEntries: Maximum number of permission cache entries.
434 # * MaxUUIDEntries: Maximum number of UUID cache entries.
439 MaxCollectionEntries: 1000
440 MaxCollectionBytes: 100000000
441 MaxPermissionEntries: 1000
445 # These settings are provided by your OAuth2 provider (eg
446 # Google) used to perform upstream authentication.
447 ProviderAppSecret: ""
450 # The cluster ID to delegate the user database. When set,
451 # logins on this cluster will be redirected to the login cluster
452 # (login cluster must appear in RemoteHosts with Proxy: true)
455 # How long a cached token belonging to a remote cluster will
456 # remain valid before it needs to be revalidated.
457 RemoteTokenRefresh: 5m
460 # Path to git or gitolite-shell executable. Each authenticated
461 # request will execute this program with the single argument "http-backend"
462 GitCommand: /usr/bin/git
464 # Path to Gitolite's home directory. If a non-empty path is given,
465 # the CGI environment will be set up to support the use of
466 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
467 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
468 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
471 # Git repositories must be readable by api server, or you won't be
472 # able to submit crunch jobs. To pass the test suites, put a clone
473 # of the arvados tree in {git_repositories_dir}/arvados.git or
474 # {git_repositories_dir}/arvados/.git
475 Repositories: /var/lib/arvados/git/repositories
483 # List of supported Docker Registry image formats that compute nodes
484 # are able to use. `arv keep docker` will error out if a user tries
485 # to store an image with an unsupported format. Use an empty array
486 # to skip the compatibility check (and display a warning message to
489 # Example for sites running docker < 1.10: {"v1": {}}
490 # Example for sites running docker >= 1.10: {"v2": {}}
491 # Example for disabling check: {}
492 SupportedDockerImageFormats:
496 # Include details about job reuse decisions in the server log. This
497 # causes additional database queries to run, so it should not be
498 # enabled unless you expect to examine the resulting logs for
499 # troubleshooting purposes.
500 LogReuseDecisions: false
502 # Default value for keep_cache_ram of a container's runtime_constraints.
503 DefaultKeepCacheRAM: 268435456
505 # Number of times a container can be unlocked before being
506 # automatically cancelled.
507 MaxDispatchAttempts: 5
509 # Default value for container_count_max for container requests. This is the
510 # number of times Arvados will create a new container to satisfy a container
511 # request. If a container is cancelled it will retry a new container if
512 # container_count < container_count_max on any container requests associated
513 # with the cancelled container.
516 # The maximum number of compute nodes that can be in use simultaneously
517 # If this limit is reduced, any existing nodes with slot number >= new limit
518 # will not be counted against the new limit. In other words, the new limit
519 # won't be strictly enforced until those nodes with higher slot numbers
523 # Preemptible instance support (e.g. AWS Spot Instances)
524 # When true, child containers will get created with the preemptible
525 # scheduling parameter parameter set.
526 UsePreemptibleInstances: false
528 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
529 # (experimental) cloud dispatcher for executing containers on
530 # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
531 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
532 DispatchPrivateKey: none
534 # Maximum time to wait for workers to come up before abandoning
535 # stale locks from a previous dispatch process.
538 # The crunch-run command to manage the container on a node
539 CrunchRunCommand: "crunch-run"
541 # Extra arguments to add to crunch-run invocation
542 # Example: ["--cgroup-parent-subsystem=memory"]
543 CrunchRunArgumentsList: []
545 # Extra RAM to reserve on the node, in addition to
546 # the amount specified in the container's RuntimeConstraints
547 ReserveExtraRAM: 256MiB
549 # Minimum time between two attempts to run the same container
553 # When you run the db:delete_old_container_logs task, it will find
554 # containers that have been finished for at least this many seconds,
555 # and delete their stdout, stderr, arv-mount, crunch-run, and
556 # crunchstat logs from the logs table.
559 # These two settings control how frequently log events are flushed to the
560 # database. Log lines are buffered until either crunch_log_bytes_per_event
561 # has been reached or crunch_log_seconds_between_events has elapsed since
563 LogBytesPerEvent: 4096
564 LogSecondsBetweenEvents: 1
566 # The sample period for throttling logs.
567 LogThrottlePeriod: 60s
569 # Maximum number of bytes that job can log over crunch_log_throttle_period
570 # before being silenced until the end of the period.
571 LogThrottleBytes: 65536
573 # Maximum number of lines that job can log over crunch_log_throttle_period
574 # before being silenced until the end of the period.
575 LogThrottleLines: 1024
577 # Maximum bytes that may be logged by a single job. Log bytes that are
578 # silenced by throttling are not counted against this total.
579 LimitLogBytesPerJob: 67108864
581 LogPartialLineThrottlePeriod: 5s
583 # Container logs are written to Keep and saved in a
584 # collection, which is updated periodically while the
585 # container runs. This value sets the interval between
586 # collection updates.
589 # The log collection is also updated when the specified amount of
590 # log data (given in bytes) is produced in less than one update
596 SbatchArgumentsList: []
597 SbatchEnvironmentVariables:
600 # Path to dns server configuration directory
601 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
602 # files or touch restart.txt (see below).
605 # Template file for the dns server host snippets. See
606 # unbound.template in this directory for an example. If false, do
607 # not write any config files.
608 DNSServerConfTemplate: ""
610 # String to write to {dns_server_conf_dir}/restart.txt (with a
611 # trailing newline) after updating local data. If false, do not
612 # open or write the restart.txt file.
613 DNSServerReloadCommand: ""
615 # Command to run after each DNS update. Template variables will be
616 # substituted; see the "unbound" example below. If false, do not run
618 DNSServerUpdateCommand: ""
620 ComputeNodeDomain: ""
621 ComputeNodeNameservers:
625 # Hostname to assign to a compute node when it sends a "ping" and the
626 # hostname in its Node record is nil.
627 # During bootstrapping, the "ping" script is expected to notice the
628 # hostname given in the ping response, and update its unix hostname
630 # If false, leave the hostname alone (this is appropriate if your compute
631 # nodes' hostnames are already assigned by some other mechanism).
633 # One way or another, the hostnames of your node records should agree
634 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
636 # Example for compute0000, compute0001, ....:
637 # assign_node_hostname: compute%<slot_number>04d
638 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
639 AssignNodeHostname: "compute%<slot_number>d"
642 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
644 # Note: this only enables read-only access, creating new
645 # legacy jobs and pipelines is not supported.
647 # 'auto' -- (default) enable the Jobs API only if it has been used before
648 # (i.e., there are job records in the database)
649 # 'true' -- enable the Jobs API despite lack of existing records.
650 # 'false' -- disable the Jobs API despite presence of existing records.
653 # Git repositories must be readable by api server, or you won't be
654 # able to submit crunch jobs. To pass the test suites, put a clone
655 # of the arvados tree in {git_repositories_dir}/arvados.git or
656 # {git_repositories_dir}/arvados/.git
657 GitInternalDir: /var/lib/arvados/internal.git
660 # Enable the cloud scheduler (experimental).
663 # Name/number of port where workers' SSH services listen.
666 # Interval between queue polls.
669 # Shell command to execute on each worker to determine whether
670 # the worker is booted and ready to run containers. It should
671 # exit zero if the worker is ready.
672 BootProbeCommand: "docker ps -q"
674 # Minimum interval between consecutive probes to a single
678 # Maximum probes per second, across all workers in a pool.
679 MaxProbesPerSecond: 10
681 # Time before repeating SIGTERM when killing a container.
684 # Time to give up on SIGTERM and write off the worker.
687 # Maximum create/destroy-instance operations per second (0 =
689 MaxCloudOpsPerSecond: 0
691 # Interval between cloud provider syncs/updates ("list all
695 # Time to leave an idle worker running (in case new containers
696 # appear in the queue that it can run) before shutting it
700 # Time to wait for a new worker to boot (i.e., pass
701 # BootProbeCommand) before giving up and shutting it down.
704 # Maximum time a worker can stay alive with no successful
705 # probes before being automatically shut down.
708 # Time after shutting down a worker to retry the
709 # shutdown/destroy operation.
712 # Worker VM image ID.
715 # Tags to add on all resources (VMs, NICs, disks) created by
716 # the container dispatcher. (Arvados's own tags --
717 # InstanceType, IdleBehavior, and InstanceSecret -- will also
722 # Prefix for predefined tags used by Arvados (InstanceSetID,
723 # InstanceType, InstanceSecret, IdleBehavior). With the
724 # default value "Arvados", tags are "ArvadosInstanceSetID",
725 # "ArvadosInstanceSecret", etc.
727 # This should only be changed while no cloud resources are in
728 # use and the cloud dispatcher is not running. Otherwise,
729 # VMs/resources that were added using the old tag prefix will
730 # need to be detected and cleaned up manually.
731 TagKeyPrefix: Arvados
733 # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
736 # Cloud-specific driver parameters.
743 # (ec2) Instance configuration.
749 AdminUsername: debian
751 # (azure) Credentials.
757 # (azure) Instance configuration.
758 CloudEnvironment: AzurePublicCloud
765 DeleteDanglingResourcesAfter: 20s
766 AdminUsername: arvados
770 # Use the instance type name as the key (in place of "SAMPLE" in
771 # this sample entry).
773 # Cloud provider's instance type. Defaults to the configured type name.
777 IncludedScratch: 16GB
801 LocationConstraint: false
809 StorageAccountName: aaaaa
810 StorageAccountKey: aaaaa
811 StorageBaseURL: core.windows.net
814 ListBlobsRetryDelay: 10s
815 ListBlobsMaxAttempts: 10
817 WriteRaceInterval: 15s
818 WriteRacePollTime: 1s
820 # for local directory driver
821 Root: /var/lib/arvados/keep-data
827 SendUserSetupNotificationEmail: true
829 # Bug/issue report notification to and from addresses
830 IssueReporterEmailFrom: "arvados@example.com"
831 IssueReporterEmailTo: "arvados@example.com"
832 SupportEmailAddress: "arvados@example.com"
834 # Generic issue email from
835 EmailFrom: "arvados@example.com"
844 # API endpoint host or host:port; default is {id}.arvadosapi.com
845 Host: sample.arvadosapi.com
847 # Perform a proxy request when a local client requests an
848 # object belonging to this remote.
851 # Default "https". Can be set to "http" for testing.
854 # Disable TLS verify. Can be set to true for testing.
857 # When users present tokens issued by this remote cluster, and
858 # their accounts are active on the remote cluster, activate
859 # them on this cluster too.
865 ActivationContactLink: mailto:info@arvados.org
866 ArvadosDocsite: https://doc.arvados.org
867 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
868 ShowUserAgreementInline: false
871 # Scratch directory used by the remote repository browsing
872 # feature. If it doesn't exist, it (and any missing parents) will be
873 # created using mkdir_p.
874 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
876 # Below is a sample setting of user_profile_form_fields config parameter.
877 # This configuration parameter should be set to either false (to disable) or
878 # to a map as shown below.
879 # Configure the map of input fields to be displayed in the profile page
880 # using the attribute "key" for each of the input fields.
881 # This sample shows configuration with one required and one optional form fields.
882 # For each of these input fields:
883 # You can specify "Type" as "text" or "select".
884 # List the "Options" to be displayed for each of the "select" menu.
885 # Set "Required" as "true" for any of these fields to make them required.
886 # If any of the required fields are missing in the user's profile, the user will be
887 # redirected to the profile page before they can access any Workbench features.
888 UserProfileFormFields:
891 FormFieldTitle: Best color
892 FormFieldDescription: your favorite color
901 # exampleTextValue: # key that will be set in properties
904 # FormFieldDescription: ""
907 # exampleOptionsValue:
910 # FormFieldDescription: ""
918 # Use "UserProfileFormMessage to configure the message you want
919 # to display on the profile page.
920 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
922 # Mimetypes of applications for which the view icon
923 # would be enabled in a collection's show page.
924 # It is sufficient to list only applications here.
925 # No need to list text and image types.
926 ApplicationMimetypesWithViewIcon:
944 # The maximum number of bytes to load in the log viewer
945 LogViewerMaxBytes: 1M
947 # When anonymous_user_token is configured, show public projects page
948 EnablePublicProjectsPage: true
950 # By default, disable the "Getting Started" popup which is specific to Arvados playground
951 EnableGettingStartedPopup: false
953 # Ask Arvados API server to compress its response payloads.
954 APIResponseCompression: true
956 # Timeouts for API requests.
957 APIClientConnectTimeout: 2m
958 APIClientReceiveTimeout: 5m
960 # Maximum number of historic log records of a running job to fetch
961 # and display in the Log tab, while subscribing to web sockets.
962 RunningJobLogRecordsToFetch: 2000
964 # In systems with many shared projects, loading of dashboard and topnav
965 # cab be slow due to collections indexing; use the following parameters
966 # to suppress these properties
967 ShowRecentCollectionsOnDashboard: true
968 ShowUserNotifications: true
970 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
971 # a link to the multi-site search page on a "home" Workbench site.
974 # https://workbench.qr1hi.arvadosapi.com/collections/multisite
977 # Should workbench allow management of local git repositories? Set to false if
978 # the jobs api is disabled and there are no local git repositories.
981 SiteName: Arvados Workbench
982 ProfilingEnabled: false
984 # This is related to obsolete Google OpenID 1.0 login
985 # but some workbench stuff still expects it to be set.
986 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
990 FileViewersConfigURL: ""
992 # Use experimental controller code (see https://dev.arvados.org/issues/14287)
993 EnableBetaController14287: false