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
15 # Token used internally by Arvados components to authenticate to
16 # one another. Use a string of at least 50 random alphanumerics.
19 # Token to be included in all healthcheck requests. Disabled by default.
20 # Server expects request header of the format "Authorization: Bearer xxx"
25 # Each of the service sections below specifies ListenAddress,
26 # InternalURLs, and ExternalURL.
28 # InternalURLs specify how other Arvados service processes will
29 # connect to the service. Typically these use internal hostnames
30 # and high port numbers. Example:
33 # "http://host1.internal.example:12345": {}
34 # "http://host2.internal.example:12345": {}
36 # ListenAddress specifies the address and port the service
37 # process's HTTP server should listen on. Example:
39 # ListenAddress: "0.0.0.0:12345"
41 # If ListenAddress is blank, the service will try listening on
42 # the host:port part of each InternalURLs entry until one
43 # works. This approach only works if the host names resolve (via
44 # /etc/hosts, DNS, etc) to the IP addresses of the host's
47 # ExternalURL specifies how applications/clients will connect to
48 # the service, regardless of whether they are inside or outside
49 # the cluster. Example:
51 # ExternalURL: "https://keep.zzzzz.example.com/"
53 # To avoid routing internal traffic through external networks,
54 # use split-horizon DNS for ExternalURL host names: inside the
55 # cluster's private network "host.zzzzz.example.com" resolves to
56 # the host's private IP address, while outside the cluster
57 # "host.zzzzz.example.com" resolves to the host's public IP
58 # address (or its external gateway or load balancer).
62 InternalURLs: {SAMPLE: {}}
66 InternalURLs: {SAMPLE: {}}
70 InternalURLs: {SAMPLE: {}}
74 InternalURLs: {SAMPLE: {}}
78 InternalURLs: {SAMPLE: {}}
82 InternalURLs: {SAMPLE: {}}
86 InternalURLs: {SAMPLE: {}}
89 InternalURLs: {SAMPLE: {}}
92 InternalURLs: {SAMPLE: {}}
96 InternalURLs: {SAMPLE: {}}
100 InternalURLs: {SAMPLE: {}}
101 # Base URL for Workbench inline preview. If blank, use
102 # WebDAVDownload instead, and disable inline preview.
103 # If both are empty, downloading collections from workbench
104 # will be impossible.
106 # It is important to properly configure the download service
107 # to migitate cross-site-scripting (XSS) attacks. A HTML page
108 # can be stored in collection. If an attacker causes a victim
109 # to visit that page through Workbench, it will be rendered by
110 # the browser. If all collections are served at the same
111 # domain, the browser will consider collections as coming from
112 # the same origin and having access to the same browsing data,
113 # enabling malicious Javascript on that page to access Arvados
114 # on behalf of the victim.
116 # This is mitigating by having separate domains for each
117 # collection, or limiting preview to circumstances where the
118 # collection is not accessed with the user's regular
121 # Serve preview links using uuid or pdh in subdomain
122 # (requires wildcard DNS and TLS certificate)
123 # https://*.collections.uuid_prefix.arvadosapi.com
125 # Serve preview links using uuid or pdh in main domain
126 # (requires wildcard DNS and TLS certificate)
127 # https://*--collections.uuid_prefix.arvadosapi.com
129 # Serve preview links by setting uuid or pdh in the path.
130 # This configuration only allows previews of public data or
131 # collection-sharing links, because these use the anonymous
132 # user token or the token is already embedded in the URL.
133 # Other data must be handled as downloads via WebDAVDownload:
134 # https://collections.uuid_prefix.arvadosapi.com
140 InternalURLs: {SAMPLE: {}}
141 # Base URL for download links. If blank, serve links to WebDAV
142 # with disposition=attachment query param. Unlike preview links,
143 # browsers do not render attachments, so there is no risk of XSS.
145 # If WebDAVDownload is blank, and WebDAV uses a
146 # single-origin form, then Workbench will show an error page
148 # Serve download links by setting uuid or pdh in the path:
149 # https://download.uuid_prefix.arvadosapi.com
157 # Rendezvous is normally empty/omitted. When changing the
158 # URL of a Keepstore service, Rendezvous should be set to
159 # the old URL (with trailing slash omitted) to preserve
160 # rendezvous ordering.
165 InternalURLs: {SAMPLE: {}}
169 InternalURLs: {SAMPLE: {}}
170 # ShellInABox service endpoint URL for a given VM. If empty, do not
171 # offer web shell logins.
173 # E.g., using a path-based proxy server to forward connections to shell hosts:
174 # https://webshell.uuid_prefix.arvadosapi.com
176 # E.g., using a name-based proxy server to forward connections to shell hosts:
177 # https://*.webshell.uuid_prefix.arvadosapi.com
181 InternalURLs: {SAMPLE: {}}
185 InternalURLs: {SAMPLE: {}}
189 InternalURLs: {SAMPLE: {}}
193 # max concurrent connections per arvados server daemon
196 # All parameters here are passed to the PG client library in a connection string;
197 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
205 # Limits for how long a client token created by regular users can be valid,
206 # and also is used as a default expiration policy when no expiration date is
208 # Default value zero means token expirations don't get clamped and no
209 # default expiration is set.
212 # Maximum size (in bytes) allowed for a single API request. This
213 # limit is published in the discovery document for use by clients.
214 # Note: You must separately configure the upstream web server or
215 # proxy to actually enforce the desired maximum request size on the
217 MaxRequestSize: 134217728
219 # Limit the number of bytes read from the database during an index
220 # request (by retrieving and returning fewer rows than would
221 # normally be returned in a single response).
222 # Note 1: This setting never reduces the number of returned rows to
223 # zero, no matter how big the first data row is.
224 # Note 2: Currently, this is only checked against a specific set of
225 # columns that tend to get large (collections.manifest_text,
226 # containers.mounts, workflows.definition). Other fields (e.g.,
227 # "properties" hashes) are not counted against this limit.
228 MaxIndexDatabaseRead: 134217728
230 # Maximum number of items to return when responding to a APIs that
231 # can return partial result sets using limit and offset parameters
232 # (e.g., *.index, groups.contents). If a request specifies a "limit"
233 # parameter higher than this value, this value is used instead.
234 MaxItemsPerResponse: 1000
236 # Maximum number of concurrent requests to accept in a single
237 # service process, or 0 for no limit.
238 MaxConcurrentRequests: 0
240 # Maximum number of 64MiB memory buffers per Keepstore server process, or
241 # 0 for no limit. When this limit is reached, up to
242 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
243 # buffers (like GET and PUT) will wait for buffer space to be released.
244 # Any HTTP requests beyond MaxConcurrentRequests will receive an
245 # immediate 503 response.
247 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
248 # * 1.1) fits comfortably in memory. On a host dedicated to running
249 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
250 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
251 # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
252 MaxKeepBlobBuffers: 128
254 # API methods to disable. Disabled methods are not listed in the
255 # discovery document, and respond 404 to all requests.
256 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
259 # Interval (seconds) between asynchronous permission view updates. Any
260 # permission-updating API called with the 'async' parameter schedules a an
261 # update on the permission view in the future, if not already scheduled.
262 AsyncPermissionsUpdateInterval: 20s
264 # Maximum number of concurrent outgoing requests to make while
265 # serving a single incoming multi-cluster (federated) request.
266 MaxRequestAmplification: 4
268 # Maximum wall clock time to spend handling an incoming request.
271 # Websocket will send a periodic empty event after 'SendTimeout'
272 # if there is no other activity to maintain the connection /
273 # detect dropped connections.
276 WebsocketClientEventQueue: 64
277 WebsocketServerEventQueue: 4
279 # Timeout on requests to internal Keep services.
280 KeepServiceRequestTimeout: 15s
282 # Vocabulary file path, local to the node running the controller.
283 # This JSON file should contain the description of what's allowed
284 # as object's metadata. Its format is described at:
285 # https://doc.arvados.org/admin/metadata-vocabulary.html
288 # If true, a project must have a non-empty description field in
289 # order to be frozen.
290 FreezeProjectRequiresDescription: false
292 # Project properties that must have non-empty values in order to
293 # freeze a project. Example: "property_name": {}
294 FreezeProjectRequiresProperties:
297 # If true, only an admin user can un-freeze a project. If false,
298 # any user with "manage" permission can un-freeze.
299 UnfreezeProjectRequiresAdmin: false
302 # Config parameters to automatically setup new users. If enabled,
303 # this users will be able to self-activate. Enable this if you want
304 # to run an open instance where anyone can create an account and use
305 # the system without requiring manual approval.
307 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
308 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
309 AutoSetupNewUsers: false
310 AutoSetupNewUsersWithVmUUID: ""
311 AutoSetupNewUsersWithRepository: false
312 AutoSetupUsernameBlacklist:
321 # When NewUsersAreActive is set to true, new users will be active
322 # immediately. This skips the "self-activate" step which enforces
323 # user agreements. Should only be enabled for development.
324 NewUsersAreActive: false
326 # Newly activated users (whether set up by an admin or via
327 # AutoSetupNewUsers) immediately become visible to other active
330 # On a multi-tenant cluster, where the intent is for users to be
331 # invisible to one another unless they have been added to the
332 # same group(s) via Workbench admin interface, change this to
334 ActivatedUsersAreVisibleToOthers: true
336 # The e-mail address of the user you would like to become marked as an admin
337 # user on their first login.
338 AutoAdminUserWithEmail: ""
340 # If AutoAdminFirstUser is set to true, the first user to log in when no
341 # other admin users exist will automatically become an admin user.
342 AutoAdminFirstUser: false
344 # Email address to notify whenever a user creates a profile for the
346 UserProfileNotificationAddress: ""
347 AdminNotifierEmailFrom: arvados@example.com
348 EmailSubjectPrefix: "[ARVADOS] "
349 UserNotifierEmailFrom: arvados@example.com
350 UserNotifierEmailBcc: {}
351 NewUserNotificationRecipients: {}
352 NewInactiveUserNotificationRecipients: {}
354 # Set AnonymousUserToken to enable anonymous user access. Populate this
355 # field with a random string at least 50 characters long.
356 AnonymousUserToken: ""
358 # If a new user has an alternate email address (local@domain)
359 # with the domain given here, its local part becomes the new
360 # user's default username. Otherwise, the user's primary email
362 PreferDomainForUsername: ""
365 <% if not @user.full_name.empty? -%>
366 <%= @user.full_name %>,
371 Your Arvados account has been set up. You can log in at
373 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
376 Your Arvados administrator.
378 # If RoleGroupsVisibleToAll is true, all role groups are visible
379 # to all active users.
381 # If false, users must be granted permission to role groups in
382 # order to see them. This is more appropriate for a multi-tenant
384 RoleGroupsVisibleToAll: true
387 # Time to keep audit logs, in seconds. (An audit log is a row added
388 # to the "logs" table in the PostgreSQL database each time an
389 # Arvados object is created, modified, or deleted.)
391 # Currently, websocket event notifications rely on audit logs, so
392 # this should not be set lower than 300 (5 minutes).
395 # Maximum number of log rows to delete in a single SQL transaction.
397 # If MaxDeleteBatch is 0, log entries will never be
398 # deleted by Arvados. Cleanup can be done by an external process
399 # without affecting any Arvados system processes, as long as very
400 # recent (<5 minutes old) logs are not deleted.
402 # 100000 is a reasonable batch size for most sites.
405 # Attributes to suppress in events and audit logs. Notably,
406 # specifying {"manifest_text": {}} here typically makes the database
407 # smaller and faster.
409 # Warning: Using any non-empty value here can have undesirable side
410 # effects for any client or component that relies on event logs.
411 # Use at your own risk.
412 UnloggedAttributes: {}
416 # Logging threshold: panic, fatal, error, warn, info, debug, or
420 # Logging format: json or text
423 # Maximum characters of (JSON-encoded) query parameters to include
424 # in each request log entry. When params exceed this size, they will
425 # be JSON-encoded, truncated to this size, and logged as
427 MaxRequestLogParamsSize: 2000
431 # Enable access controls for data stored in Keep. This should
432 # always be set to true on a production cluster.
435 # BlobSigningKey is a string of alphanumeric characters used to
436 # generate permission signatures for Keep locators. It must be
437 # identical to the permission key given to Keep. IMPORTANT: This
438 # is a site secret. It should be at least 50 characters.
440 # Modifying BlobSigningKey will invalidate all existing
441 # signatures, which can cause programs to fail (e.g., arv-put,
442 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
443 # when no such processes are running.
446 # Enable garbage collection of unreferenced blobs in Keep.
449 # Time to leave unreferenced blobs in "trashed" state before
450 # deleting them, or 0 to skip the "trashed" state entirely and
451 # delete unreferenced blobs.
453 # If you use any Amazon S3 buckets as storage volumes, this
454 # must be at least 24h to avoid occasional data loss.
455 BlobTrashLifetime: 336h
457 # How often to check for (and delete) trashed blocks whose
458 # BlobTrashLifetime has expired.
459 BlobTrashCheckInterval: 24h
461 # Maximum number of concurrent "trash blob" and "delete trashed
462 # blob" operations conducted by a single keepstore process. Each
463 # of these can be set to 0 to disable the respective operation.
465 # If BlobTrashLifetime is zero, "trash" and "delete trash"
466 # happen at once, so only the lower of these two values is used.
467 BlobTrashConcurrency: 4
468 BlobDeleteConcurrency: 4
470 # Maximum number of concurrent "create additional replica of
471 # existing blob" operations conducted by a single keepstore
473 BlobReplicateConcurrency: 4
475 # Default replication level for collections. This is used when a
476 # collection's replication_desired attribute is nil.
477 DefaultReplication: 2
479 # BlobSigningTTL determines the minimum lifetime of transient
480 # data, i.e., blocks that are not referenced by
481 # collections. Unreferenced blocks exist for two reasons:
483 # 1) A data block must be written to a disk/cloud backend device
484 # before a collection can be created/updated with a reference to
487 # 2) Deleting or updating a collection can remove the last
488 # remaining reference to a data block.
490 # If BlobSigningTTL is too short, long-running
491 # processes/containers will fail when they take too long (a)
492 # between writing blocks and writing collections that reference
493 # them, or (b) between reading collections and reading the
496 # If BlobSigningTTL is too long, data will still be stored long
497 # after the referring collections are deleted, and you will
498 # needlessly fill up disks or waste money on cloud storage.
500 # Modifying BlobSigningTTL invalidates existing signatures; see
501 # BlobSigningKey note above.
503 # The default is 2 weeks.
506 # When running keep-balance, this is the destination filename for
507 # the list of lost block hashes if there are any, one per line.
508 # Updated automically during each successful run.
509 BlobMissingReport: ""
511 # keep-balance operates periodically, i.e.: do a
512 # scan/balance operation, sleep, repeat.
514 # BalancePeriod determines the interval between start times of
515 # successive scan/balance operations. If a scan/balance operation
516 # takes longer than BalancePeriod, the next one will follow it
519 # If SIGUSR1 is received during an idle period between operations,
520 # the next operation will start immediately.
523 # Limits the number of collections retrieved by keep-balance per
524 # API transaction. If this is zero, page size is
525 # determined by the API server's own page size limits (see
526 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
527 BalanceCollectionBatch: 0
529 # The size of keep-balance's internal queue of
530 # collections. Higher values use more memory and improve throughput
531 # by allowing keep-balance to fetch the next page of collections
532 # while the current page is still being processed. If this is zero
533 # or omitted, pages are processed serially.
534 BalanceCollectionBuffers: 1000
536 # Maximum time for a rebalancing run. This ensures keep-balance
537 # eventually gives up and retries if, for example, a network
538 # error causes a hung connection that is never closed by the
539 # OS. It should be long enough that it doesn't interrupt a
540 # long-running balancing operation.
543 # Maximum number of replication_confirmed /
544 # storage_classes_confirmed updates to write to the database
545 # after a rebalancing run. When many updates are needed, this
546 # spreads them over a few runs rather than applying them all at
548 BalanceUpdateLimit: 100000
550 # Default lifetime for ephemeral collections: 2 weeks. This must not
551 # be less than BlobSigningTTL.
552 DefaultTrashLifetime: 336h
554 # Interval (seconds) between trash sweeps. During a trash sweep,
555 # collections are marked as trash if their trash_at time has
556 # arrived, and deleted if their delete_at time has arrived.
557 TrashSweepInterval: 60s
559 # If true, enable collection versioning.
560 # When a collection's preserve_version field is true or the current version
561 # is older than the amount of seconds defined on PreserveVersionIfIdle,
562 # a snapshot of the collection's previous state is created and linked to
563 # the current collection.
564 CollectionVersioning: true
566 # 0s = auto-create a new version on every update.
567 # -1s = never auto-create new versions.
568 # > 0s = auto-create a new version when older than the specified number of seconds.
569 PreserveVersionIfIdle: 10s
571 # If non-empty, allow project and collection names to contain
572 # the "/" character (slash/stroke/solidus), and replace "/" with
573 # the given string in the filesystem hierarchy presented by
574 # WebDAV. Example values are "%2f" and "{slash}". Names that
575 # contain the substitution string itself may result in confusing
576 # behavior, so a value like "_" is not recommended.
578 # If the default empty value is used, the server will reject
579 # requests to create or rename a collection when the new name
582 # If the value "/" is used, project and collection names
583 # containing "/" will be allowed, but they will not be
584 # accessible via WebDAV.
586 # Use of this feature is not recommended, if it can be avoided.
587 ForwardSlashNameSubstitution: ""
589 # Include "folder objects" in S3 ListObjects responses.
590 S3FolderObjects: true
592 # Managed collection properties. At creation time, if the client didn't
593 # provide the listed keys, they will be automatically populated following
594 # one of the following behaviors:
596 # * UUID of the user who owns the containing project.
597 # responsible_person_uuid: {Function: original_owner, Protected: true}
599 # * Default concrete value.
600 # foo_bar: {Value: baz, Protected: false}
602 # If Protected is true, only an admin user can modify its value.
604 SAMPLE: {Function: original_owner, Protected: true}
606 # In "trust all content" mode, Workbench will redirect download
607 # requests to WebDAV preview link, even in the cases when
608 # WebDAV would have to expose XSS vulnerabilities in order to
609 # handle the redirect (see discussion on Services.WebDAV).
611 # This setting has no effect in the recommended configuration, where the
612 # WebDAV service is configured to have a separate domain for every
613 # collection and XSS protection is provided by browsers' same-origin
616 # The default setting (false) is appropriate for a multi-user site.
617 TrustAllContent: false
619 # Cache parameters for WebDAV content serving:
621 # Time to cache manifests, permission checks, and sessions.
624 # Time to cache collection state.
627 # Block cache entries. Each block consumes up to 64 MiB RAM.
630 # Collection cache entries.
631 MaxCollectionEntries: 1000
633 # Approximate memory limit (in bytes) for collection cache.
634 MaxCollectionBytes: 100000000
636 # UUID cache entries.
639 # Persistent sessions.
642 # Selectively set permissions for regular users and admins to
643 # download or upload data files using the upload/download
644 # features for Workbench, WebDAV and S3 API support.
653 # Selectively set permissions for regular users and admins to be
654 # able to download or upload blocks using arv-put and
655 # arv-get from outside the cluster.
664 # Post upload / download events to the API server logs table, so
665 # that they can be included in the arv-user-activity report.
666 # You can disable this if you find that it is creating excess
667 # load on the API server and you don't need it.
668 WebDAVLogEvents: true
671 # One of the following mechanisms (Google, PAM, LDAP, or
672 # LoginCluster) should be enabled; see
673 # https://doc.arvados.org/install/setup-login.html
676 # Authenticate with Google.
679 # Use the Google Cloud console to enable the People API (APIs
680 # and Services > Enable APIs and services > Google People API
681 # > Enable), generate a Client ID and secret (APIs and
682 # Services > Credentials > Create credentials > OAuth client
683 # ID > Web application) and add your controller's /login URL
684 # (e.g., "https://zzzzz.example.com/login") as an authorized
689 # Allow users to log in to existing accounts using any verified
690 # email address listed by their Google account. If true, the
691 # Google People API must be enabled in order for Google login to
692 # work. If false, only the primary email address will be used.
693 AlternateEmailAddresses: true
695 # Send additional parameters with authentication requests. See
696 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
697 # for a list of supported parameters.
698 AuthenticationRequestParameters:
699 # Show the "choose which Google account" page, even if the
700 # client is currently logged in to exactly one Google
702 prompt: select_account
707 # Authenticate with an OpenID Connect provider.
710 # Issuer URL, e.g., "https://login.example.com".
712 # This must be exactly equal to the URL returned by the issuer
713 # itself in its config response ("isser" key). If the
714 # configured value is "https://example" and the provider
715 # returns "https://example:443" or "https://example/" then
716 # login will fail, even though those URLs are equivalent
720 # Your client ID and client secret (supplied by the provider).
724 # OpenID claim field containing the user's email
725 # address. Normally "email"; see
726 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
729 # OpenID claim field containing the email verification
730 # flag. Normally "email_verified". To accept every returned
731 # email address without checking a "verified" field at all,
732 # use the empty string "".
733 EmailVerifiedClaim: "email_verified"
735 # OpenID claim field containing the user's preferred
736 # username. If empty, use the mailbox part of the user's email
740 # Send additional parameters with authentication requests,
741 # like {display: page, prompt: consent}. See
742 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
743 # and refer to your provider's documentation for supported
745 AuthenticationRequestParameters:
748 # Accept an OIDC access token as an API token if the OIDC
749 # provider's UserInfo endpoint accepts it.
751 # AcceptAccessTokenScope should also be used when enabling
753 AcceptAccessToken: false
755 # Before accepting an OIDC access token as an API token, first
756 # check that it is a JWT whose "scope" value includes this
757 # value. Example: "https://zzzzz.example.com/" (your Arvados
760 # If this value is empty and AcceptAccessToken is true, all
761 # access tokens will be accepted regardless of scope,
762 # including non-JWT tokens. This is not recommended.
763 AcceptAccessTokenScope: ""
766 # Use PAM to authenticate users.
769 # PAM service name. PAM will apply the policy in the
770 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
771 # there is none, the default "other" config.
774 # Domain name (e.g., "example.com") to use to construct the
775 # user's email address if PAM authentication returns a
776 # username with no "@". If empty, use the PAM username as the
777 # user's email address, whether or not it contains "@".
779 # Note that the email address is used as the primary key for
780 # user records when logging in. Therefore, if you change
781 # PAMDefaultEmailDomain after the initial installation, you
782 # should also update existing user records to reflect the new
783 # domain. Otherwise, next time those users log in, they will
784 # be given new accounts instead of accessing their existing
786 DefaultEmailDomain: ""
789 # Use an LDAP service to authenticate users.
792 # Server URL, like "ldap://ldapserver.example.com:389" or
793 # "ldaps://ldapserver.example.com:636".
794 URL: "ldap://ldap:389"
796 # Use StartTLS upon connecting to the server.
799 # Skip TLS certificate name verification.
802 # Strip the @domain part if a user supplies an email-style
803 # username with this domain. If "*", strip any user-provided
804 # domain. If "", never strip the domain part. Example:
808 # If, after applying StripDomain, the username contains no "@"
809 # character, append this domain to form an email-style
810 # username. Example: "example.com"
813 # The LDAP attribute to filter on when looking up a username
814 # (after applying StripDomain and AppendDomain).
817 # Bind with this username (DN or UPN) and password when
818 # looking up the user record.
820 # Example user: "cn=admin,dc=example,dc=com"
822 SearchBindPassword: ""
824 # Directory base for username lookup. Example:
825 # "ou=Users,dc=example,dc=com"
828 # Additional filters to apply when looking up users' LDAP
829 # entries. This can be used to restrict access to a subset of
830 # LDAP users, or to disambiguate users from other directory
831 # entries that have the SearchAttribute present.
833 # Special characters in assertion values must be escaped (see
836 # Example: "(objectClass=person)"
839 # LDAP attribute to use as the user's email address.
841 # Important: This must not be an attribute whose value can be
842 # edited in the directory by the users themselves. Otherwise,
843 # users can take over other users' Arvados accounts trivially
844 # (email address is the primary key for Arvados accounts.)
847 # LDAP attribute to use as the preferred Arvados username. If
848 # no value is found (or this config is empty) the username
849 # originally supplied by the user will be used.
850 UsernameAttribute: uid
853 # Authenticate users listed here in the config file. This
854 # feature is intended to be used in test environments, and
855 # should not be used in production.
859 Email: alice@example.com
862 # The cluster ID to delegate the user database. When set,
863 # logins on this cluster will be redirected to the login cluster
864 # (login cluster must appear in RemoteClusters with Proxy: true)
867 # How long a cached token belonging to a remote cluster will
868 # remain valid before it needs to be revalidated.
869 RemoteTokenRefresh: 5m
871 # How long a client token created from a login flow will be valid without
872 # asking the user to re-login. Example values: 60m, 8h.
873 # Default value zero means tokens don't have expiration.
876 # If true (default) tokens issued through login are allowed to create
878 # If false, tokens issued through login are not allowed to
879 # viewing/creating other tokens. New tokens can only be created
880 # by going through login again.
881 IssueTrustedTokens: true
883 # When the token is returned to a client, the token itself may
884 # be restricted from viewing/creating other tokens based on whether
885 # the client is "trusted" or not. The local Workbench1 and
886 # Workbench2 are trusted by default, but if this is a
887 # LoginCluster, you probably want to include the other Workbench
888 # instances in the federation in this list.
891 "https://workbench.federate1.example": {}
892 "https://workbench.federate2.example": {}
895 # Path to git or gitolite-shell executable. Each authenticated
896 # request will execute this program with the single argument "http-backend"
897 GitCommand: /usr/bin/git
899 # Path to Gitolite's home directory. If a non-empty path is given,
900 # the CGI environment will be set up to support the use of
901 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
902 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
903 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
906 # Git repositories must be readable by api server, or you won't be
907 # able to submit crunch jobs. To pass the test suites, put a clone
908 # of the arvados tree in {git_repositories_dir}/arvados.git or
909 # {git_repositories_dir}/arvados/.git
910 Repositories: /var/lib/arvados/git/repositories
918 # List of supported Docker Registry image formats that compute nodes
919 # are able to use. `arv keep docker` will error out if a user tries
920 # to store an image with an unsupported format. Use an empty array
921 # to skip the compatibility check (and display a warning message to
924 # Example for sites running docker < 1.10: {"v1": {}}
925 # Example for sites running docker >= 1.10: {"v2": {}}
926 # Example for disabling check: {}
927 SupportedDockerImageFormats:
931 # Include details about job reuse decisions in the server log. This
932 # causes additional database queries to run, so it should not be
933 # enabled unless you expect to examine the resulting logs for
934 # troubleshooting purposes.
935 LogReuseDecisions: false
937 # Default value for keep_cache_ram of a container's runtime_constraints.
938 DefaultKeepCacheRAM: 268435456
940 # Number of times a container can be unlocked before being
941 # automatically cancelled.
942 MaxDispatchAttempts: 5
944 # Default value for container_count_max for container requests. This is the
945 # number of times Arvados will create a new container to satisfy a container
946 # request. If a container is cancelled it will retry a new container if
947 # container_count < container_count_max on any container requests associated
948 # with the cancelled container.
951 # The maximum number of compute nodes that can be in use simultaneously
952 # If this limit is reduced, any existing nodes with slot number >= new limit
953 # will not be counted against the new limit. In other words, the new limit
954 # won't be strictly enforced until those nodes with higher slot numbers
958 # Schedule all child containers on preemptible instances (e.g. AWS
959 # Spot Instances) even if not requested by the submitter.
961 # If false, containers are scheduled on preemptible instances
962 # only when requested by the submitter.
964 # This flag is ignored if no preemptible instance types are
965 # configured, and has no effect on top-level containers.
966 AlwaysUsePreemptibleInstances: false
968 # Automatically add a preemptible variant for every
969 # non-preemptible entry in InstanceTypes below. The maximum bid
970 # price for the preemptible variant will be the non-preemptible
971 # price multiplied by PreemptiblePriceFactor. If 0, preemptible
972 # variants are not added automatically.
974 # A price factor of 1.0 is a reasonable starting point.
975 PreemptiblePriceFactor: 0
977 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
978 # cloud dispatcher for executing containers on worker VMs.
979 # Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
980 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
981 DispatchPrivateKey: ""
983 # Maximum time to wait for workers to come up before abandoning
984 # stale locks from a previous dispatch process.
987 # The crunch-run command used to start a container on a worker node.
989 # When dispatching to cloud VMs, this is used only if
990 # DeployRunnerBinary in the CloudVMs section is set to the empty
992 CrunchRunCommand: "crunch-run"
994 # Extra arguments to add to crunch-run invocation
995 # Example: ["--cgroup-parent-subsystem=memory"]
996 CrunchRunArgumentsList: []
998 # Extra RAM to reserve on the node, in addition to
999 # the amount specified in the container's RuntimeConstraints
1000 ReserveExtraRAM: 256MiB
1002 # Minimum time between two attempts to run the same container
1005 # Container runtime: "docker" (default) or "singularity"
1006 RuntimeEngine: docker
1008 # When running a container, run a dedicated keepstore process,
1009 # using the specified number of 64 MiB memory buffers per
1010 # allocated CPU core (VCPUs in the container's runtime
1011 # constraints). The dedicated keepstore handles I/O for
1012 # collections mounted in the container, as well as saving
1015 # A zero value disables this feature.
1017 # In order for this feature to be activated, no volume may use
1018 # AccessViaHosts, and no writable volume may have Replication
1019 # lower than Collections.DefaultReplication. If these
1020 # requirements are not satisfied, the feature is disabled
1021 # automatically regardless of the value given here.
1023 # When an HPC dispatcher is in use (see SLURM and LSF sections),
1024 # this feature depends on the operator to ensure an up-to-date
1025 # cluster configuration file (/etc/arvados/config.yml) is
1026 # available on all compute nodes. If it is missing or not
1027 # readable by the crunch-run user, the feature will be disabled
1028 # automatically. To read it from a different location, add a
1029 # "-config=/path/to/config.yml" argument to
1030 # CrunchRunArgumentsList above.
1032 # When the cloud dispatcher is in use (see CloudVMs section) and
1033 # this configuration is enabled, the entire cluster
1034 # configuration file, including the system root token, is copied
1035 # to the worker node and held in memory for the duration of the
1037 LocalKeepBlobBuffersPerVCPU: 1
1039 # When running a dedicated keepstore process for a container
1040 # (see LocalKeepBlobBuffersPerVCPU), write keepstore log
1041 # messages to keepstore.txt in the container's log collection.
1043 # These log messages can reveal some volume configuration
1044 # details, error messages from the cloud storage provider, etc.,
1045 # which are not otherwise visible to users.
1048 # * "none" -- no keepstore.txt file
1049 # * "all" -- all logs, including request and response lines
1050 # * "errors" -- all logs except "response" logs with 2xx
1051 # response codes and "request" logs
1052 LocalKeepLogsToContainerLog: none
1055 # When you run the db:delete_old_container_logs task, it will find
1056 # containers that have been finished for at least this many seconds,
1057 # and delete their stdout, stderr, arv-mount, crunch-run, and
1058 # crunchstat logs from the logs table.
1061 # These two settings control how frequently log events are flushed to the
1062 # database. Log lines are buffered until either crunch_log_bytes_per_event
1063 # has been reached or crunch_log_seconds_between_events has elapsed since
1065 LogBytesPerEvent: 4096
1066 LogSecondsBetweenEvents: 5s
1068 # The sample period for throttling logs.
1069 LogThrottlePeriod: 60s
1071 # Maximum number of bytes that job can log over crunch_log_throttle_period
1072 # before being silenced until the end of the period.
1073 LogThrottleBytes: 65536
1075 # Maximum number of lines that job can log over crunch_log_throttle_period
1076 # before being silenced until the end of the period.
1077 LogThrottleLines: 1024
1079 # Maximum bytes that may be logged by a single job. Log bytes that are
1080 # silenced by throttling are not counted against this total.
1081 LimitLogBytesPerJob: 67108864
1083 LogPartialLineThrottlePeriod: 5s
1085 # Container logs are written to Keep and saved in a
1086 # collection, which is updated periodically while the
1087 # container runs. This value sets the interval between
1088 # collection updates.
1089 LogUpdatePeriod: 30m
1091 # The log collection is also updated when the specified amount of
1092 # log data (given in bytes) is produced in less than one update
1094 LogUpdateSize: 32MiB
1097 # An admin user can use "arvados-client shell" to start an
1098 # interactive shell (with any user ID) in any running
1102 # Any user can use "arvados-client shell" to start an
1103 # interactive shell (with any user ID) in any running
1104 # container that they started, provided it isn't also
1105 # associated with a different user's container request.
1107 # Interactive sessions make it easy to alter the container's
1108 # runtime environment in ways that aren't recorded or
1109 # reproducible. Consider the implications for automatic
1110 # container reuse before enabling and using this feature. In
1111 # particular, note that starting an interactive session does
1112 # not disqualify a container from being reused by a different
1113 # user/workflow in the future.
1118 SbatchArgumentsList: []
1119 SbatchEnvironmentVariables:
1122 # Path to dns server configuration directory
1123 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
1124 # files or touch restart.txt (see below).
1125 DNSServerConfDir: ""
1127 # Template file for the dns server host snippets. See
1128 # unbound.template in this directory for an example. If false, do
1129 # not write any config files.
1130 DNSServerConfTemplate: ""
1132 # String to write to {dns_server_conf_dir}/restart.txt (with a
1133 # trailing newline) after updating local data. If false, do not
1134 # open or write the restart.txt file.
1135 DNSServerReloadCommand: ""
1137 # Command to run after each DNS update. Template variables will be
1138 # substituted; see the "unbound" example below. If false, do not run
1140 DNSServerUpdateCommand: ""
1142 ComputeNodeDomain: ""
1143 ComputeNodeNameservers:
1147 # Hostname to assign to a compute node when it sends a "ping" and the
1148 # hostname in its Node record is nil.
1149 # During bootstrapping, the "ping" script is expected to notice the
1150 # hostname given in the ping response, and update its unix hostname
1152 # If false, leave the hostname alone (this is appropriate if your compute
1153 # nodes' hostnames are already assigned by some other mechanism).
1155 # One way or another, the hostnames of your node records should agree
1156 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1158 # Example for compute0000, compute0001, ....:
1159 # assign_node_hostname: compute%<slot_number>04d
1160 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1161 AssignNodeHostname: "compute%<slot_number>d"
1164 # Arguments to bsub when submitting Arvados containers as LSF jobs.
1166 # Template variables starting with % will be substituted as follows:
1169 # %C number of VCPUs
1172 # %G number of GPU devices (runtime_constraints.cuda.device_count)
1174 # Use %% to express a literal %. The %%J in the default will be changed
1175 # to %J, which is interpreted by bsub itself.
1177 # Note that the default arguments cause LSF to write two files
1178 # in /tmp on the compute node each time an Arvados container
1179 # runs. Ensure you have something in place to delete old files
1180 # from /tmp, or adjust the "-o" and "-e" arguments accordingly.
1181 BsubArgumentsList: ["-o", "/tmp/crunch-run.%%J.out", "-e", "/tmp/crunch-run.%%J.err", "-J", "%U", "-n", "%C", "-D", "%MMB", "-R", "rusage[mem=%MMB:tmp=%TMB] span[hosts=1]", "-R", "select[mem>=%MMB]", "-R", "select[tmp>=%TMB]", "-R", "select[ncpus>=%C]"]
1183 # Arguments that will be appended to the bsub command line
1184 # when submitting Arvados containers as LSF jobs with
1185 # runtime_constraints.cuda.device_count > 0
1186 BsubCUDAArguments: ["-gpu", "num=%G"]
1188 # Use sudo to switch to this user account when submitting LSF
1191 # This account must exist on the hosts where LSF jobs run
1192 # ("execution hosts"), as well as on the host where the
1193 # Arvados LSF dispatcher runs ("submission host").
1194 BsubSudoUser: "crunch"
1197 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
1199 # Note: this only enables read-only access, creating new
1200 # legacy jobs and pipelines is not supported.
1202 # 'auto' -- (default) enable the Jobs API only if it has been used before
1203 # (i.e., there are job records in the database)
1204 # 'true' -- enable the Jobs API despite lack of existing records.
1205 # 'false' -- disable the Jobs API despite presence of existing records.
1208 # Git repositories must be readable by api server, or you won't be
1209 # able to submit crunch jobs. To pass the test suites, put a clone
1210 # of the arvados tree in {git_repositories_dir}/arvados.git or
1211 # {git_repositories_dir}/arvados/.git
1212 GitInternalDir: /var/lib/arvados/internal.git
1215 # Enable the cloud scheduler.
1218 # Name/number of port where workers' SSH services listen.
1221 # Interval between queue polls.
1224 # Shell command to execute on each worker to determine whether
1225 # the worker is booted and ready to run containers. It should
1226 # exit zero if the worker is ready.
1227 BootProbeCommand: "systemctl is-system-running"
1229 # Minimum interval between consecutive probes to a single
1233 # Maximum probes per second, across all workers in a pool.
1234 MaxProbesPerSecond: 10
1236 # Time before repeating SIGTERM when killing a container.
1239 # Time to give up on a process (most likely arv-mount) that
1240 # still holds a container lockfile after its main supervisor
1241 # process has exited, and declare the instance broken.
1242 TimeoutStaleRunLock: 5s
1244 # Time to give up on SIGTERM and write off the worker.
1247 # Maximum create/destroy-instance operations per second (0 =
1249 MaxCloudOpsPerSecond: 10
1251 # Maximum concurrent instance creation operations (0 = unlimited).
1253 # MaxConcurrentInstanceCreateOps limits the number of instance creation
1254 # requests that can be in flight at any one time, whereas
1255 # MaxCloudOpsPerSecond limits the number of create/destroy operations
1256 # that can be started per second.
1258 # Because the API for instance creation on Azure is synchronous, it is
1259 # recommended to increase MaxConcurrentInstanceCreateOps when running
1260 # on Azure. When using managed images, a value of 20 would be
1261 # appropriate. When using Azure Shared Image Galeries, it could be set
1262 # higher. For more information, see
1263 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
1265 # MaxConcurrentInstanceCreateOps can be increased for other cloud
1266 # providers too, if desired.
1267 MaxConcurrentInstanceCreateOps: 1
1269 # Interval between cloud provider syncs/updates ("list all
1273 # Time to leave an idle worker running (in case new containers
1274 # appear in the queue that it can run) before shutting it
1278 # Time to wait for a new worker to boot (i.e., pass
1279 # BootProbeCommand) before giving up and shutting it down.
1282 # Maximum time a worker can stay alive with no successful
1283 # probes before being automatically shut down.
1286 # Time after shutting down a worker to retry the
1287 # shutdown/destroy operation.
1288 TimeoutShutdown: 10s
1290 # Worker VM image ID.
1291 # (aws) AMI identifier
1292 # (azure) managed disks: the name of the managed disk image
1293 # (azure) shared image gallery: the name of the image definition. Also
1294 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1295 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1296 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1299 # An executable file (located on the dispatcher host) to be
1300 # copied to cloud instances at runtime and used as the
1301 # container runner/supervisor. The default value is the
1302 # dispatcher program itself.
1304 # Use the empty string to disable this step: nothing will be
1305 # copied, and cloud instances are assumed to have a suitable
1306 # version of crunch-run installed; see CrunchRunCommand above.
1307 DeployRunnerBinary: "/proc/self/exe"
1309 # Tags to add on all resources (VMs, NICs, disks) created by
1310 # the container dispatcher. (Arvados's own tags --
1311 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1316 # Prefix for predefined tags used by Arvados (InstanceSetID,
1317 # InstanceType, InstanceSecret, IdleBehavior). With the
1318 # default value "Arvados", tags are "ArvadosInstanceSetID",
1319 # "ArvadosInstanceSecret", etc.
1321 # This should only be changed while no cloud resources are in
1322 # use and the cloud dispatcher is not running. Otherwise,
1323 # VMs/resources that were added using the old tag prefix will
1324 # need to be detected and cleaned up manually.
1325 TagKeyPrefix: Arvados
1327 # Cloud driver: "azure" (Microsoft Azure), "ec2" (Amazon AWS),
1328 # or "loopback" (run containers on dispatch host for testing
1332 # Cloud-specific driver parameters.
1335 # (ec2) Credentials. Omit or leave blank if using IAM role.
1339 # (ec2) Instance configuration.
1345 AdminUsername: debian
1346 # (ec2) name of the IAMInstanceProfile for instances started by
1347 # the cloud dispatcher. Leave blank when not needed.
1348 IAMInstanceProfile: ""
1350 # (azure) Credentials.
1356 # (azure) Instance configuration.
1357 CloudEnvironment: AzurePublicCloud
1360 # (azure) The resource group where the VM and virtual NIC will be
1364 # (azure) The resource group of the Network to use for the virtual
1365 # NIC (if different from ResourceGroup)
1366 NetworkResourceGroup: ""
1370 # (azure) managed disks: The resource group where the managed disk
1371 # image can be found (if different from ResourceGroup).
1372 ImageResourceGroup: ""
1374 # (azure) shared image gallery: the name of the gallery
1375 SharedImageGalleryName: ""
1376 # (azure) shared image gallery: the version of the image definition
1377 SharedImageGalleryImageVersion: ""
1379 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1383 # (azure) How long to wait before deleting VHD and NIC
1384 # objects that are no longer being used.
1385 DeleteDanglingResourcesAfter: 20s
1387 # Account (that already exists in the VM image) that will be
1388 # set up with an ssh authorized key to allow the compute
1389 # dispatcher to connect.
1390 AdminUsername: arvados
1394 # Use the instance type name as the key (in place of "SAMPLE" in
1395 # this sample entry).
1397 # Cloud provider's instance type. Defaults to the configured type name.
1401 IncludedScratch: 16GB
1405 # Include this section if the node type includes GPU (CUDA) support
1407 DriverVersion: "11.0"
1408 HardwareCapability: "9.0"
1413 # If you use multiple storage classes, specify them here, using
1414 # the storage class name as the key (in place of "SAMPLE" in
1415 # this sample entry).
1417 # Further info/examples:
1418 # https://doc.arvados.org/admin/storage-classes.html
1421 # Priority determines the order volumes should be searched
1422 # when reading data, in cases where a keepstore server has
1423 # access to multiple volumes with different storage classes.
1426 # Default determines which storage class(es) should be used
1427 # when a user/client writes data or saves a new collection
1428 # without specifying storage classes.
1430 # If any StorageClasses are configured, at least one of them
1431 # must have Default: true.
1436 # AccessViaHosts specifies which keepstore processes can read
1437 # and write data on the volume.
1439 # For a local filesystem, AccessViaHosts has one entry,
1440 # indicating which server the filesystem is located on.
1442 # For a network-attached backend accessible by all keepstore
1443 # servers, like a cloud storage bucket or an NFS mount,
1444 # AccessViaHosts can be empty/omitted.
1446 # Further info/examples:
1447 # https://doc.arvados.org/install/configure-fs-storage.html
1448 # https://doc.arvados.org/install/configure-s3-object-storage.html
1449 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1453 "http://host1.example:25107": {}
1457 # If you have configured storage classes (see StorageClasses
1458 # section above), add an entry here for each storage class
1459 # satisfied by this volume.
1463 # for s3 driver -- see
1464 # https://doc.arvados.org/install/configure-s3-object-storage.html
1467 SecretAccessKey: aaaaa
1471 LocationConstraint: false
1478 # Use aws-s3-go (v2) instead of goamz
1479 UseAWSS3v2Driver: false
1481 # For S3 driver, potentially unsafe tuning parameter,
1482 # intentionally excluded from main documentation.
1484 # Enable deletion (garbage collection) even when the
1485 # configured BlobTrashLifetime is zero. WARNING: eventual
1486 # consistency may result in race conditions that can cause
1487 # data loss. Do not enable this unless you understand and
1491 # for azure driver -- see
1492 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1493 StorageAccountName: aaaaa
1494 StorageAccountKey: aaaaa
1495 StorageBaseURL: core.windows.net
1496 ContainerName: aaaaa
1498 ListBlobsRetryDelay: 10s
1499 ListBlobsMaxAttempts: 10
1501 WriteRaceInterval: 15s
1502 WriteRacePollTime: 1s
1504 # for local directory driver -- see
1505 # https://doc.arvados.org/install/configure-fs-storage.html
1506 Root: /var/lib/arvados/keep-data
1508 # For local directory driver, potentially confusing tuning
1509 # parameter, intentionally excluded from main documentation.
1511 # When true, read and write operations (for whole 64MiB
1512 # blocks) on an individual volume will queued and issued
1513 # serially. When false, read and write operations will be
1514 # issued concurrently.
1516 # May possibly improve throughput if you have physical spinning disks
1517 # and experience contention when there are multiple requests
1518 # to the same volume.
1520 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1521 # should leave this alone.
1527 SendUserSetupNotificationEmail: true
1529 # Bug/issue report notification to and from addresses
1530 IssueReporterEmailFrom: "arvados@example.com"
1531 IssueReporterEmailTo: "arvados@example.com"
1532 SupportEmailAddress: "arvados@example.com"
1534 # Generic issue email from
1535 EmailFrom: "arvados@example.com"
1542 ActivateUsers: false
1544 # API endpoint host or host:port; default is {id}.arvadosapi.com
1545 Host: sample.arvadosapi.com
1547 # Perform a proxy request when a local client requests an
1548 # object belonging to this remote.
1551 # Default "https". Can be set to "http" for testing.
1554 # Disable TLS verify. Can be set to true for testing.
1557 # When users present tokens issued by this remote cluster, and
1558 # their accounts are active on the remote cluster, activate
1559 # them on this cluster too.
1560 ActivateUsers: false
1563 # Workbench1 configs
1565 ActivationContactLink: mailto:info@arvados.org
1566 ArvadosDocsite: https://doc.arvados.org
1567 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1568 ShowUserAgreementInline: false
1571 # Set this configuration to true to avoid providing an easy way for users
1572 # to share data with unauthenticated users; this may be necessary on
1573 # installations where strict data access controls are needed.
1574 DisableSharingURLsUI: false
1576 # Scratch directory used by the remote repository browsing
1577 # feature. If it doesn't exist, it (and any missing parents) will be
1578 # created using mkdir_p.
1579 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1581 # Below is a sample setting of user_profile_form_fields config parameter.
1582 # This configuration parameter should be set to either false (to disable) or
1583 # to a map as shown below.
1584 # Configure the map of input fields to be displayed in the profile page
1585 # using the attribute "key" for each of the input fields.
1586 # This sample shows configuration with one required and one optional form fields.
1587 # For each of these input fields:
1588 # You can specify "Type" as "text" or "select".
1589 # List the "Options" to be displayed for each of the "select" menu.
1590 # Set "Required" as "true" for any of these fields to make them required.
1591 # If any of the required fields are missing in the user's profile, the user will be
1592 # redirected to the profile page before they can access any Workbench features.
1593 UserProfileFormFields:
1596 FormFieldTitle: Best color
1597 FormFieldDescription: your favorite color
1606 # exampleTextValue: # key that will be set in properties
1608 # FormFieldTitle: ""
1609 # FormFieldDescription: ""
1612 # exampleOptionsValue:
1614 # FormFieldTitle: ""
1615 # FormFieldDescription: ""
1623 # Use "UserProfileFormMessage to configure the message you want
1624 # to display on the profile page.
1625 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1627 # Mimetypes of applications for which the view icon
1628 # would be enabled in a collection's show page.
1629 # It is sufficient to list only applications here.
1630 # No need to list text and image types.
1631 ApplicationMimetypesWithViewIcon:
1649 # The maximum number of bytes to load in the log viewer
1650 LogViewerMaxBytes: 1M
1652 # When anonymous_user_token is configured, show public projects page
1653 EnablePublicProjectsPage: true
1655 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1656 EnableGettingStartedPopup: false
1658 # Ask Arvados API server to compress its response payloads.
1659 APIResponseCompression: true
1661 # Timeouts for API requests.
1662 APIClientConnectTimeout: 2m
1663 APIClientReceiveTimeout: 5m
1665 # Maximum number of historic log records of a running job to fetch
1666 # and display in the Log tab, while subscribing to web sockets.
1667 RunningJobLogRecordsToFetch: 2000
1669 # In systems with many shared projects, loading of dashboard and topnav
1670 # can be slow due to collections indexing; use the following parameters
1671 # to suppress these properties
1672 ShowRecentCollectionsOnDashboard: true
1673 ShowUserNotifications: true
1675 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1676 # a link to the multi-site search page on a "home" Workbench site.
1679 # https://workbench.zzzzz.arvadosapi.com/collections/multisite
1682 # Should workbench allow management of local git repositories? Set to false if
1683 # the jobs api is disabled and there are no local git repositories.
1686 SiteName: Arvados Workbench
1687 ProfilingEnabled: false
1689 # This is related to obsolete Google OpenID 1.0 login
1690 # but some workbench stuff still expects it to be set.
1691 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1693 # Workbench2 configs
1694 FileViewersConfigURL: ""
1696 # Idle time after which the user's session will be auto closed.
1697 # This feature is disabled when set to zero.
1700 # Workbench welcome screen, this is HTML text that will be
1701 # incorporated directly onto the page.
1703 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1704 <h2>Please log in.</h2>
1706 <p>If you have never used Arvados Workbench before, logging in
1707 for the first time will automatically create a new
1710 <i>Arvados Workbench uses your information only for
1711 identification, and does not retrieve any other personal
1714 # Workbench screen displayed to inactive users. This is HTML
1715 # text that will be incorporated directly onto the page.
1717 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1718 <h3>Hi! You're logged in, but...</h3>
1719 <p>Your account is inactive.</p>
1720 <p>An administrator must activate your account before you can get
1723 # Connecting to Arvados shell VMs tends to be site-specific.
1724 # Put any special instructions here. This is HTML text that will
1725 # be incorporated directly onto the Workbench page.
1727 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1728 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1730 # Sample text if you are using a "switchyard" ssh proxy.
1731 # Replace "zzzzz" with your Cluster ID.
1733 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1736 # ServerAliveInterval 60
1737 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1740 # If you are using a switchyard ssh proxy, shell node hostnames
1741 # may require a special hostname suffix. In the sample ssh
1742 # configuration above, this would be ".zzzzz"
1743 # This is added to the hostname in the "command line" column
1744 # the Workbench "shell VMs" page.
1746 # If your shell nodes are directly accessible by users without a
1747 # proxy and have fully qualified host names, you should leave
1749 SSHHelpHostSuffix: ""
1751 # (Experimental) Restart services automatically when config file
1752 # changes are detected. Only supported by `arvados-server boot` in
1754 AutoReloadConfig: false