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 # In each of the service sections below, the keys under
26 # InternalURLs are the endpoints where the service should be
27 # listening, and reachable from other hosts in the
31 # "http://host1.example:12345": {}
32 # "http://host2.example:12345": {}
35 InternalURLs: {SAMPLE: {}}
38 InternalURLs: {SAMPLE: {}}
41 InternalURLs: {SAMPLE: {}}
44 InternalURLs: {SAMPLE: {}}
47 InternalURLs: {SAMPLE: {}}
50 InternalURLs: {SAMPLE: {}}
53 InternalURLs: {SAMPLE: {}}
56 InternalURLs: {SAMPLE: {}}
59 InternalURLs: {SAMPLE: {}}
62 InternalURLs: {SAMPLE: {}}
63 # Base URL for Workbench inline preview. If blank, use
64 # WebDAVDownload instead, and disable inline preview.
65 # If both are empty, downloading collections from workbench
68 # It is important to properly configure the download service
69 # to migitate cross-site-scripting (XSS) attacks. A HTML page
70 # can be stored in collection. If an attacker causes a victim
71 # to visit that page through Workbench, it will be rendered by
72 # the browser. If all collections are served at the same
73 # domain, the browser will consider collections as coming from
74 # the same origin and having access to the same browsing data,
75 # enabling malicious Javascript on that page to access Arvados
76 # on behalf of the victim.
78 # This is mitigating by having separate domains for each
79 # collection, or limiting preview to circumstances where the
80 # collection is not accessed with the user's regular
83 # Serve preview links using uuid or pdh in subdomain
84 # (requires wildcard DNS and TLS certificate)
85 # https://*.collections.uuid_prefix.arvadosapi.com
87 # Serve preview links using uuid or pdh in main domain
88 # (requires wildcard DNS and TLS certificate)
89 # https://*--collections.uuid_prefix.arvadosapi.com
91 # Serve preview links by setting uuid or pdh in the path.
92 # This configuration only allows previews of public data or
93 # collection-sharing links, because these use the anonymous
94 # user token or the token is already embedded in the URL.
95 # Other data must be handled as downloads via WebDAVDownload:
96 # https://collections.uuid_prefix.arvadosapi.com
101 InternalURLs: {SAMPLE: {}}
102 # Base URL for download links. If blank, serve links to WebDAV
103 # with disposition=attachment query param. Unlike preview links,
104 # browsers do not render attachments, so there is no risk of XSS.
106 # If WebDAVDownload is blank, and WebDAV uses a
107 # single-origin form, then Workbench will show an error page
109 # Serve download links by setting uuid or pdh in the path:
110 # https://download.uuid_prefix.arvadosapi.com
117 # Rendezvous is normally empty/omitted. When changing the
118 # URL of a Keepstore service, Rendezvous should be set to
119 # the old URL (with trailing slash omitted) to preserve
120 # rendezvous ordering.
124 InternalURLs: {SAMPLE: {}}
127 InternalURLs: {SAMPLE: {}}
128 # ShellInABox service endpoint URL for a given VM. If empty, do not
129 # offer web shell logins.
131 # E.g., using a path-based proxy server to forward connections to shell hosts:
132 # https://webshell.uuid_prefix.arvadosapi.com
134 # E.g., using a name-based proxy server to forward connections to shell hosts:
135 # https://*.webshell.uuid_prefix.arvadosapi.com
138 InternalURLs: {SAMPLE: {}}
141 InternalURLs: {SAMPLE: {}}
144 InternalURLs: {SAMPLE: {}}
148 # max concurrent connections per arvados server daemon
151 # All parameters here are passed to the PG client library in a connection string;
152 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
160 # Limits for how long a client token created by regular users can be valid,
161 # and also is used as a default expiration policy when no expiration date is
163 # Default value zero means token expirations don't get clamped and no
164 # default expiration is set.
167 # Maximum size (in bytes) allowed for a single API request. This
168 # limit is published in the discovery document for use by clients.
169 # Note: You must separately configure the upstream web server or
170 # proxy to actually enforce the desired maximum request size on the
172 MaxRequestSize: 134217728
174 # Limit the number of bytes read from the database during an index
175 # request (by retrieving and returning fewer rows than would
176 # normally be returned in a single response).
177 # Note 1: This setting never reduces the number of returned rows to
178 # zero, no matter how big the first data row is.
179 # Note 2: Currently, this is only checked against a specific set of
180 # columns that tend to get large (collections.manifest_text,
181 # containers.mounts, workflows.definition). Other fields (e.g.,
182 # "properties" hashes) are not counted against this limit.
183 MaxIndexDatabaseRead: 134217728
185 # Maximum number of items to return when responding to a APIs that
186 # can return partial result sets using limit and offset parameters
187 # (e.g., *.index, groups.contents). If a request specifies a "limit"
188 # parameter higher than this value, this value is used instead.
189 MaxItemsPerResponse: 1000
191 # Maximum number of concurrent requests to accept in a single
192 # service process, or 0 for no limit.
193 MaxConcurrentRequests: 0
195 # Maximum number of 64MiB memory buffers per Keepstore server process, or
196 # 0 for no limit. When this limit is reached, up to
197 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
198 # buffers (like GET and PUT) will wait for buffer space to be released.
199 # Any HTTP requests beyond MaxConcurrentRequests will receive an
200 # immediate 503 response.
202 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
203 # * 1.1) fits comfortably in memory. On a host dedicated to running
204 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
205 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
206 # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
207 MaxKeepBlobBuffers: 128
209 # API methods to disable. Disabled methods are not listed in the
210 # discovery document, and respond 404 to all requests.
211 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
214 # Interval (seconds) between asynchronous permission view updates. Any
215 # permission-updating API called with the 'async' parameter schedules a an
216 # update on the permission view in the future, if not already scheduled.
217 AsyncPermissionsUpdateInterval: 20s
219 # Maximum number of concurrent outgoing requests to make while
220 # serving a single incoming multi-cluster (federated) request.
221 MaxRequestAmplification: 4
223 # Maximum wall clock time to spend handling an incoming request.
226 # Websocket will send a periodic empty event after 'SendTimeout'
227 # if there is no other activity to maintain the connection /
228 # detect dropped connections.
231 WebsocketClientEventQueue: 64
232 WebsocketServerEventQueue: 4
234 # Timeout on requests to internal Keep services.
235 KeepServiceRequestTimeout: 15s
237 # Vocabulary file path, local to the node running the controller.
238 # This JSON file should contain the description of what's allowed
239 # as object's metadata. Its format is described at:
240 # https://doc.arvados.org/admin/metadata-vocabulary.html
244 # Config parameters to automatically setup new users. If enabled,
245 # this users will be able to self-activate. Enable this if you want
246 # to run an open instance where anyone can create an account and use
247 # the system without requiring manual approval.
249 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
250 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
251 AutoSetupNewUsers: false
252 AutoSetupNewUsersWithVmUUID: ""
253 AutoSetupNewUsersWithRepository: false
254 AutoSetupUsernameBlacklist:
263 # When NewUsersAreActive is set to true, new users will be active
264 # immediately. This skips the "self-activate" step which enforces
265 # user agreements. Should only be enabled for development.
266 NewUsersAreActive: false
268 # Newly activated users (whether set up by an admin or via
269 # AutoSetupNewUsers) immediately become visible to other active
272 # On a multi-tenant cluster, where the intent is for users to be
273 # invisible to one another unless they have been added to the
274 # same group(s) via Workbench admin interface, change this to
276 ActivatedUsersAreVisibleToOthers: true
278 # The e-mail address of the user you would like to become marked as an admin
279 # user on their first login.
280 AutoAdminUserWithEmail: ""
282 # If AutoAdminFirstUser is set to true, the first user to log in when no
283 # other admin users exist will automatically become an admin user.
284 AutoAdminFirstUser: false
286 # Email address to notify whenever a user creates a profile for the
288 UserProfileNotificationAddress: ""
289 AdminNotifierEmailFrom: arvados@example.com
290 EmailSubjectPrefix: "[ARVADOS] "
291 UserNotifierEmailFrom: arvados@example.com
292 UserNotifierEmailBcc: {}
293 NewUserNotificationRecipients: {}
294 NewInactiveUserNotificationRecipients: {}
296 # Set AnonymousUserToken to enable anonymous user access. Populate this
297 # field with a random string at least 50 characters long.
298 AnonymousUserToken: ""
300 # If a new user has an alternate email address (local@domain)
301 # with the domain given here, its local part becomes the new
302 # user's default username. Otherwise, the user's primary email
304 PreferDomainForUsername: ""
307 <% if not @user.full_name.empty? -%>
308 <%= @user.full_name %>,
313 Your Arvados account has been set up. You can log in at
315 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
318 Your Arvados administrator.
320 # If RoleGroupsVisibleToAll is true, all role groups are visible
321 # to all active users.
323 # If false, users must be granted permission to role groups in
324 # order to see them. This is more appropriate for a multi-tenant
326 RoleGroupsVisibleToAll: true
329 # Time to keep audit logs, in seconds. (An audit log is a row added
330 # to the "logs" table in the PostgreSQL database each time an
331 # Arvados object is created, modified, or deleted.)
333 # Currently, websocket event notifications rely on audit logs, so
334 # this should not be set lower than 300 (5 minutes).
337 # Maximum number of log rows to delete in a single SQL transaction.
339 # If MaxDeleteBatch is 0, log entries will never be
340 # deleted by Arvados. Cleanup can be done by an external process
341 # without affecting any Arvados system processes, as long as very
342 # recent (<5 minutes old) logs are not deleted.
344 # 100000 is a reasonable batch size for most sites.
347 # Attributes to suppress in events and audit logs. Notably,
348 # specifying {"manifest_text": {}} here typically makes the database
349 # smaller and faster.
351 # Warning: Using any non-empty value here can have undesirable side
352 # effects for any client or component that relies on event logs.
353 # Use at your own risk.
354 UnloggedAttributes: {}
358 # Logging threshold: panic, fatal, error, warn, info, debug, or
362 # Logging format: json or text
365 # Maximum characters of (JSON-encoded) query parameters to include
366 # in each request log entry. When params exceed this size, they will
367 # be JSON-encoded, truncated to this size, and logged as
369 MaxRequestLogParamsSize: 2000
373 # Enable access controls for data stored in Keep. This should
374 # always be set to true on a production cluster.
377 # BlobSigningKey is a string of alphanumeric characters used to
378 # generate permission signatures for Keep locators. It must be
379 # identical to the permission key given to Keep. IMPORTANT: This
380 # is a site secret. It should be at least 50 characters.
382 # Modifying BlobSigningKey will invalidate all existing
383 # signatures, which can cause programs to fail (e.g., arv-put,
384 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
385 # when no such processes are running.
388 # Enable garbage collection of unreferenced blobs in Keep.
391 # Time to leave unreferenced blobs in "trashed" state before
392 # deleting them, or 0 to skip the "trashed" state entirely and
393 # delete unreferenced blobs.
395 # If you use any Amazon S3 buckets as storage volumes, this
396 # must be at least 24h to avoid occasional data loss.
397 BlobTrashLifetime: 336h
399 # How often to check for (and delete) trashed blocks whose
400 # BlobTrashLifetime has expired.
401 BlobTrashCheckInterval: 24h
403 # Maximum number of concurrent "trash blob" and "delete trashed
404 # blob" operations conducted by a single keepstore process. Each
405 # of these can be set to 0 to disable the respective operation.
407 # If BlobTrashLifetime is zero, "trash" and "delete trash"
408 # happen at once, so only the lower of these two values is used.
409 BlobTrashConcurrency: 4
410 BlobDeleteConcurrency: 4
412 # Maximum number of concurrent "create additional replica of
413 # existing blob" operations conducted by a single keepstore
415 BlobReplicateConcurrency: 4
417 # Default replication level for collections. This is used when a
418 # collection's replication_desired attribute is nil.
419 DefaultReplication: 2
421 # BlobSigningTTL determines the minimum lifetime of transient
422 # data, i.e., blocks that are not referenced by
423 # collections. Unreferenced blocks exist for two reasons:
425 # 1) A data block must be written to a disk/cloud backend device
426 # before a collection can be created/updated with a reference to
429 # 2) Deleting or updating a collection can remove the last
430 # remaining reference to a data block.
432 # If BlobSigningTTL is too short, long-running
433 # processes/containers will fail when they take too long (a)
434 # between writing blocks and writing collections that reference
435 # them, or (b) between reading collections and reading the
438 # If BlobSigningTTL is too long, data will still be stored long
439 # after the referring collections are deleted, and you will
440 # needlessly fill up disks or waste money on cloud storage.
442 # Modifying BlobSigningTTL invalidates existing signatures; see
443 # BlobSigningKey note above.
445 # The default is 2 weeks.
448 # When running keep-balance, this is the destination filename for
449 # the list of lost block hashes if there are any, one per line.
450 # Updated automically during each successful run.
451 BlobMissingReport: ""
453 # keep-balance operates periodically, i.e.: do a
454 # scan/balance operation, sleep, repeat.
456 # BalancePeriod determines the interval between start times of
457 # successive scan/balance operations. If a scan/balance operation
458 # takes longer than BalancePeriod, the next one will follow it
461 # If SIGUSR1 is received during an idle period between operations,
462 # the next operation will start immediately.
465 # Limits the number of collections retrieved by keep-balance per
466 # API transaction. If this is zero, page size is
467 # determined by the API server's own page size limits (see
468 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
469 BalanceCollectionBatch: 0
471 # The size of keep-balance's internal queue of
472 # collections. Higher values use more memory and improve throughput
473 # by allowing keep-balance to fetch the next page of collections
474 # while the current page is still being processed. If this is zero
475 # or omitted, pages are processed serially.
476 BalanceCollectionBuffers: 1000
478 # Maximum time for a rebalancing run. This ensures keep-balance
479 # eventually gives up and retries if, for example, a network
480 # error causes a hung connection that is never closed by the
481 # OS. It should be long enough that it doesn't interrupt a
482 # long-running balancing operation.
485 # Maximum number of replication_confirmed /
486 # storage_classes_confirmed updates to write to the database
487 # after a rebalancing run. When many updates are needed, this
488 # spreads them over a few runs rather than applying them all at
490 BalanceUpdateLimit: 100000
492 # Default lifetime for ephemeral collections: 2 weeks. This must not
493 # be less than BlobSigningTTL.
494 DefaultTrashLifetime: 336h
496 # Interval (seconds) between trash sweeps. During a trash sweep,
497 # collections are marked as trash if their trash_at time has
498 # arrived, and deleted if their delete_at time has arrived.
499 TrashSweepInterval: 60s
501 # If true, enable collection versioning.
502 # When a collection's preserve_version field is true or the current version
503 # is older than the amount of seconds defined on PreserveVersionIfIdle,
504 # a snapshot of the collection's previous state is created and linked to
505 # the current collection.
506 CollectionVersioning: true
508 # 0s = auto-create a new version on every update.
509 # -1s = never auto-create new versions.
510 # > 0s = auto-create a new version when older than the specified number of seconds.
511 PreserveVersionIfIdle: 10s
513 # If non-empty, allow project and collection names to contain
514 # the "/" character (slash/stroke/solidus), and replace "/" with
515 # the given string in the filesystem hierarchy presented by
516 # WebDAV. Example values are "%2f" and "{slash}". Names that
517 # contain the substitution string itself may result in confusing
518 # behavior, so a value like "_" is not recommended.
520 # If the default empty value is used, the server will reject
521 # requests to create or rename a collection when the new name
524 # If the value "/" is used, project and collection names
525 # containing "/" will be allowed, but they will not be
526 # accessible via WebDAV.
528 # Use of this feature is not recommended, if it can be avoided.
529 ForwardSlashNameSubstitution: ""
531 # Include "folder objects" in S3 ListObjects responses.
532 S3FolderObjects: true
534 # Managed collection properties. At creation time, if the client didn't
535 # provide the listed keys, they will be automatically populated following
536 # one of the following behaviors:
538 # * UUID of the user who owns the containing project.
539 # responsible_person_uuid: {Function: original_owner, Protected: true}
541 # * Default concrete value.
542 # foo_bar: {Value: baz, Protected: false}
544 # If Protected is true, only an admin user can modify its value.
546 SAMPLE: {Function: original_owner, Protected: true}
548 # In "trust all content" mode, Workbench will redirect download
549 # requests to WebDAV preview link, even in the cases when
550 # WebDAV would have to expose XSS vulnerabilities in order to
551 # handle the redirect (see discussion on Services.WebDAV).
553 # This setting has no effect in the recommended configuration, where the
554 # WebDAV service is configured to have a separate domain for every
555 # collection and XSS protection is provided by browsers' same-origin
558 # The default setting (false) is appropriate for a multi-user site.
559 TrustAllContent: false
561 # Cache parameters for WebDAV content serving:
563 # Time to cache manifests, permission checks, and sessions.
566 # Time to cache collection state.
569 # Block cache entries. Each block consumes up to 64 MiB RAM.
572 # Collection cache entries.
573 MaxCollectionEntries: 1000
575 # Approximate memory limit (in bytes) for collection cache.
576 MaxCollectionBytes: 100000000
578 # UUID cache entries.
581 # Persistent sessions.
584 # Selectively set permissions for regular users and admins to
585 # download or upload data files using the upload/download
586 # features for Workbench, WebDAV and S3 API support.
595 # Selectively set permissions for regular users and admins to be
596 # able to download or upload blocks using arv-put and
597 # arv-get from outside the cluster.
606 # Post upload / download events to the API server logs table, so
607 # that they can be included in the arv-user-activity report.
608 # You can disable this if you find that it is creating excess
609 # load on the API server and you don't need it.
610 WebDAVLogEvents: true
613 # One of the following mechanisms (Google, PAM, LDAP, or
614 # LoginCluster) should be enabled; see
615 # https://doc.arvados.org/install/setup-login.html
618 # Authenticate with Google.
621 # Use the Google Cloud console to enable the People API (APIs
622 # and Services > Enable APIs and services > Google People API
623 # > Enable), generate a Client ID and secret (APIs and
624 # Services > Credentials > Create credentials > OAuth client
625 # ID > Web application) and add your controller's /login URL
626 # (e.g., "https://zzzzz.example.com/login") as an authorized
631 # Allow users to log in to existing accounts using any verified
632 # email address listed by their Google account. If true, the
633 # Google People API must be enabled in order for Google login to
634 # work. If false, only the primary email address will be used.
635 AlternateEmailAddresses: true
637 # Send additional parameters with authentication requests. See
638 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
639 # for a list of supported parameters.
640 AuthenticationRequestParameters:
641 # Show the "choose which Google account" page, even if the
642 # client is currently logged in to exactly one Google
644 prompt: select_account
649 # Authenticate with an OpenID Connect provider.
652 # Issuer URL, e.g., "https://login.example.com".
654 # This must be exactly equal to the URL returned by the issuer
655 # itself in its config response ("isser" key). If the
656 # configured value is "https://example" and the provider
657 # returns "https://example:443" or "https://example/" then
658 # login will fail, even though those URLs are equivalent
662 # Your client ID and client secret (supplied by the provider).
666 # OpenID claim field containing the user's email
667 # address. Normally "email"; see
668 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
671 # OpenID claim field containing the email verification
672 # flag. Normally "email_verified". To accept every returned
673 # email address without checking a "verified" field at all,
674 # use the empty string "".
675 EmailVerifiedClaim: "email_verified"
677 # OpenID claim field containing the user's preferred
678 # username. If empty, use the mailbox part of the user's email
682 # Send additional parameters with authentication requests,
683 # like {display: page, prompt: consent}. See
684 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
685 # and refer to your provider's documentation for supported
687 AuthenticationRequestParameters:
690 # Accept an OIDC access token as an API token if the OIDC
691 # provider's UserInfo endpoint accepts it.
693 # AcceptAccessTokenScope should also be used when enabling
695 AcceptAccessToken: false
697 # Before accepting an OIDC access token as an API token, first
698 # check that it is a JWT whose "scope" value includes this
699 # value. Example: "https://zzzzz.example.com/" (your Arvados
702 # If this value is empty and AcceptAccessToken is true, all
703 # access tokens will be accepted regardless of scope,
704 # including non-JWT tokens. This is not recommended.
705 AcceptAccessTokenScope: ""
708 # Use PAM to authenticate users.
711 # PAM service name. PAM will apply the policy in the
712 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
713 # there is none, the default "other" config.
716 # Domain name (e.g., "example.com") to use to construct the
717 # user's email address if PAM authentication returns a
718 # username with no "@". If empty, use the PAM username as the
719 # user's email address, whether or not it contains "@".
721 # Note that the email address is used as the primary key for
722 # user records when logging in. Therefore, if you change
723 # PAMDefaultEmailDomain after the initial installation, you
724 # should also update existing user records to reflect the new
725 # domain. Otherwise, next time those users log in, they will
726 # be given new accounts instead of accessing their existing
728 DefaultEmailDomain: ""
731 # Use an LDAP service to authenticate users.
734 # Server URL, like "ldap://ldapserver.example.com:389" or
735 # "ldaps://ldapserver.example.com:636".
736 URL: "ldap://ldap:389"
738 # Use StartTLS upon connecting to the server.
741 # Skip TLS certificate name verification.
744 # Strip the @domain part if a user supplies an email-style
745 # username with this domain. If "*", strip any user-provided
746 # domain. If "", never strip the domain part. Example:
750 # If, after applying StripDomain, the username contains no "@"
751 # character, append this domain to form an email-style
752 # username. Example: "example.com"
755 # The LDAP attribute to filter on when looking up a username
756 # (after applying StripDomain and AppendDomain).
759 # Bind with this username (DN or UPN) and password when
760 # looking up the user record.
762 # Example user: "cn=admin,dc=example,dc=com"
764 SearchBindPassword: ""
766 # Directory base for username lookup. Example:
767 # "ou=Users,dc=example,dc=com"
770 # Additional filters to apply when looking up users' LDAP
771 # entries. This can be used to restrict access to a subset of
772 # LDAP users, or to disambiguate users from other directory
773 # entries that have the SearchAttribute present.
775 # Special characters in assertion values must be escaped (see
778 # Example: "(objectClass=person)"
781 # LDAP attribute to use as the user's email address.
783 # Important: This must not be an attribute whose value can be
784 # edited in the directory by the users themselves. Otherwise,
785 # users can take over other users' Arvados accounts trivially
786 # (email address is the primary key for Arvados accounts.)
789 # LDAP attribute to use as the preferred Arvados username. If
790 # no value is found (or this config is empty) the username
791 # originally supplied by the user will be used.
792 UsernameAttribute: uid
795 # Authenticate users listed here in the config file. This
796 # feature is intended to be used in test environments, and
797 # should not be used in production.
801 Email: alice@example.com
804 # The cluster ID to delegate the user database. When set,
805 # logins on this cluster will be redirected to the login cluster
806 # (login cluster must appear in RemoteClusters with Proxy: true)
809 # How long a cached token belonging to a remote cluster will
810 # remain valid before it needs to be revalidated.
811 RemoteTokenRefresh: 5m
813 # How long a client token created from a login flow will be valid without
814 # asking the user to re-login. Example values: 60m, 8h.
815 # Default value zero means tokens don't have expiration.
818 # If true (default) tokens issued through login are allowed to create
820 # If false, tokens issued through login are not allowed to
821 # viewing/creating other tokens. New tokens can only be created
822 # by going through login again.
823 IssueTrustedTokens: true
825 # When the token is returned to a client, the token itself may
826 # be restricted from viewing/creating other tokens based on whether
827 # the client is "trusted" or not. The local Workbench1 and
828 # Workbench2 are trusted by default, but if this is a
829 # LoginCluster, you probably want to include the other Workbench
830 # instances in the federation in this list.
833 "https://workbench.federate1.example": {}
834 "https://workbench.federate2.example": {}
837 # Path to git or gitolite-shell executable. Each authenticated
838 # request will execute this program with the single argument "http-backend"
839 GitCommand: /usr/bin/git
841 # Path to Gitolite's home directory. If a non-empty path is given,
842 # the CGI environment will be set up to support the use of
843 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
844 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
845 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
848 # Git repositories must be readable by api server, or you won't be
849 # able to submit crunch jobs. To pass the test suites, put a clone
850 # of the arvados tree in {git_repositories_dir}/arvados.git or
851 # {git_repositories_dir}/arvados/.git
852 Repositories: /var/lib/arvados/git/repositories
860 # List of supported Docker Registry image formats that compute nodes
861 # are able to use. `arv keep docker` will error out if a user tries
862 # to store an image with an unsupported format. Use an empty array
863 # to skip the compatibility check (and display a warning message to
866 # Example for sites running docker < 1.10: {"v1": {}}
867 # Example for sites running docker >= 1.10: {"v2": {}}
868 # Example for disabling check: {}
869 SupportedDockerImageFormats:
873 # Include details about job reuse decisions in the server log. This
874 # causes additional database queries to run, so it should not be
875 # enabled unless you expect to examine the resulting logs for
876 # troubleshooting purposes.
877 LogReuseDecisions: false
879 # Default value for keep_cache_ram of a container's runtime_constraints.
880 DefaultKeepCacheRAM: 268435456
882 # Number of times a container can be unlocked before being
883 # automatically cancelled.
884 MaxDispatchAttempts: 5
886 # Default value for container_count_max for container requests. This is the
887 # number of times Arvados will create a new container to satisfy a container
888 # request. If a container is cancelled it will retry a new container if
889 # container_count < container_count_max on any container requests associated
890 # with the cancelled container.
893 # The maximum number of compute nodes that can be in use simultaneously
894 # If this limit is reduced, any existing nodes with slot number >= new limit
895 # will not be counted against the new limit. In other words, the new limit
896 # won't be strictly enforced until those nodes with higher slot numbers
900 # Schedule all child containers on preemptible instances (e.g. AWS
901 # Spot Instances) even if not requested by the submitter.
903 # If false, containers are scheduled on preemptible instances
904 # only when requested by the submitter.
906 # Note that arvados-cwl-runner does not currently offer a
907 # feature to request preemptible instances, so this value
908 # effectively acts as a cluster-wide decision about whether to
909 # use preemptible instances.
911 # This flag is ignored if no preemptible instance types are
912 # configured, and has no effect on top-level containers.
913 AlwaysUsePreemptibleInstances: true
915 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
916 # cloud dispatcher for executing containers on worker VMs.
917 # Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
918 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
919 DispatchPrivateKey: ""
921 # Maximum time to wait for workers to come up before abandoning
922 # stale locks from a previous dispatch process.
925 # The crunch-run command used to start a container on a worker node.
927 # When dispatching to cloud VMs, this is used only if
928 # DeployRunnerBinary in the CloudVMs section is set to the empty
930 CrunchRunCommand: "crunch-run"
932 # Extra arguments to add to crunch-run invocation
933 # Example: ["--cgroup-parent-subsystem=memory"]
934 CrunchRunArgumentsList: []
936 # Extra RAM to reserve on the node, in addition to
937 # the amount specified in the container's RuntimeConstraints
938 ReserveExtraRAM: 256MiB
940 # Minimum time between two attempts to run the same container
943 # Container runtime: "docker" (default) or "singularity"
944 RuntimeEngine: docker
946 # When running a container, run a dedicated keepstore process,
947 # using the specified number of 64 MiB memory buffers per
948 # allocated CPU core (VCPUs in the container's runtime
949 # constraints). The dedicated keepstore handles I/O for
950 # collections mounted in the container, as well as saving
953 # A zero value disables this feature.
955 # In order for this feature to be activated, no volume may use
956 # AccessViaHosts, and each volume must have Replication higher
957 # than Collections.DefaultReplication. If these requirements are
958 # not satisfied, the feature is disabled automatically
959 # regardless of the value given here.
961 # Note that when this configuration is enabled, the entire
962 # cluster configuration file, including the system root token,
963 # is copied to the worker node and held in memory for the
964 # duration of the container.
965 LocalKeepBlobBuffersPerVCPU: 1
967 # When running a dedicated keepstore process for a container
968 # (see LocalKeepBlobBuffersPerVCPU), write keepstore log
969 # messages to keepstore.txt in the container's log collection.
971 # These log messages can reveal some volume configuration
972 # details, error messages from the cloud storage provider, etc.,
973 # which are not otherwise visible to users.
976 # * "none" -- no keepstore.txt file
977 # * "all" -- all logs, including request and response lines
978 # * "errors" -- all logs except "response" logs with 2xx
979 # response codes and "request" logs
980 LocalKeepLogsToContainerLog: none
983 # When you run the db:delete_old_container_logs task, it will find
984 # containers that have been finished for at least this many seconds,
985 # and delete their stdout, stderr, arv-mount, crunch-run, and
986 # crunchstat logs from the logs table.
989 # These two settings control how frequently log events are flushed to the
990 # database. Log lines are buffered until either crunch_log_bytes_per_event
991 # has been reached or crunch_log_seconds_between_events has elapsed since
993 LogBytesPerEvent: 4096
994 LogSecondsBetweenEvents: 5s
996 # The sample period for throttling logs.
997 LogThrottlePeriod: 60s
999 # Maximum number of bytes that job can log over crunch_log_throttle_period
1000 # before being silenced until the end of the period.
1001 LogThrottleBytes: 65536
1003 # Maximum number of lines that job can log over crunch_log_throttle_period
1004 # before being silenced until the end of the period.
1005 LogThrottleLines: 1024
1007 # Maximum bytes that may be logged by a single job. Log bytes that are
1008 # silenced by throttling are not counted against this total.
1009 LimitLogBytesPerJob: 67108864
1011 LogPartialLineThrottlePeriod: 5s
1013 # Container logs are written to Keep and saved in a
1014 # collection, which is updated periodically while the
1015 # container runs. This value sets the interval between
1016 # collection updates.
1017 LogUpdatePeriod: 30m
1019 # The log collection is also updated when the specified amount of
1020 # log data (given in bytes) is produced in less than one update
1022 LogUpdateSize: 32MiB
1025 # An admin user can use "arvados-client shell" to start an
1026 # interactive shell (with any user ID) in any running
1030 # Any user can use "arvados-client shell" to start an
1031 # interactive shell (with any user ID) in any running
1032 # container that they started, provided it isn't also
1033 # associated with a different user's container request.
1035 # Interactive sessions make it easy to alter the container's
1036 # runtime environment in ways that aren't recorded or
1037 # reproducible. Consider the implications for automatic
1038 # container reuse before enabling and using this feature. In
1039 # particular, note that starting an interactive session does
1040 # not disqualify a container from being reused by a different
1041 # user/workflow in the future.
1046 SbatchArgumentsList: []
1047 SbatchEnvironmentVariables:
1050 # Path to dns server configuration directory
1051 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
1052 # files or touch restart.txt (see below).
1053 DNSServerConfDir: ""
1055 # Template file for the dns server host snippets. See
1056 # unbound.template in this directory for an example. If false, do
1057 # not write any config files.
1058 DNSServerConfTemplate: ""
1060 # String to write to {dns_server_conf_dir}/restart.txt (with a
1061 # trailing newline) after updating local data. If false, do not
1062 # open or write the restart.txt file.
1063 DNSServerReloadCommand: ""
1065 # Command to run after each DNS update. Template variables will be
1066 # substituted; see the "unbound" example below. If false, do not run
1068 DNSServerUpdateCommand: ""
1070 ComputeNodeDomain: ""
1071 ComputeNodeNameservers:
1075 # Hostname to assign to a compute node when it sends a "ping" and the
1076 # hostname in its Node record is nil.
1077 # During bootstrapping, the "ping" script is expected to notice the
1078 # hostname given in the ping response, and update its unix hostname
1080 # If false, leave the hostname alone (this is appropriate if your compute
1081 # nodes' hostnames are already assigned by some other mechanism).
1083 # One way or another, the hostnames of your node records should agree
1084 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1086 # Example for compute0000, compute0001, ....:
1087 # assign_node_hostname: compute%<slot_number>04d
1088 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1089 AssignNodeHostname: "compute%<slot_number>d"
1092 # Arguments to bsub when submitting Arvados containers as LSF jobs.
1094 # Template variables starting with % will be substituted as follows:
1097 # %C number of VCPUs
1100 # %G number of GPU devices (runtime_constraints.cuda.device_count)
1102 # Use %% to express a literal %. The %%J in the default will be changed
1103 # to %J, which is interpreted by bsub itself.
1105 # Note that the default arguments cause LSF to write two files
1106 # in /tmp on the compute node each time an Arvados container
1107 # runs. Ensure you have something in place to delete old files
1108 # from /tmp, or adjust the "-o" and "-e" arguments accordingly.
1109 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]"]
1111 # Arguments that will be appended to the bsub command line
1112 # when submitting Arvados containers as LSF jobs with
1113 # runtime_constraints.cuda.device_count > 0
1114 BsubCUDAArguments: ["-gpu", "num=%G"]
1116 # Use sudo to switch to this user account when submitting LSF
1119 # This account must exist on the hosts where LSF jobs run
1120 # ("execution hosts"), as well as on the host where the
1121 # Arvados LSF dispatcher runs ("submission host").
1122 BsubSudoUser: "crunch"
1125 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
1127 # Note: this only enables read-only access, creating new
1128 # legacy jobs and pipelines is not supported.
1130 # 'auto' -- (default) enable the Jobs API only if it has been used before
1131 # (i.e., there are job records in the database)
1132 # 'true' -- enable the Jobs API despite lack of existing records.
1133 # 'false' -- disable the Jobs API despite presence of existing records.
1136 # Git repositories must be readable by api server, or you won't be
1137 # able to submit crunch jobs. To pass the test suites, put a clone
1138 # of the arvados tree in {git_repositories_dir}/arvados.git or
1139 # {git_repositories_dir}/arvados/.git
1140 GitInternalDir: /var/lib/arvados/internal.git
1143 # Enable the cloud scheduler.
1146 # Name/number of port where workers' SSH services listen.
1149 # Interval between queue polls.
1152 # Shell command to execute on each worker to determine whether
1153 # the worker is booted and ready to run containers. It should
1154 # exit zero if the worker is ready.
1155 BootProbeCommand: "systemctl is-system-running"
1157 # Minimum interval between consecutive probes to a single
1161 # Maximum probes per second, across all workers in a pool.
1162 MaxProbesPerSecond: 10
1164 # Time before repeating SIGTERM when killing a container.
1167 # Time to give up on a process (most likely arv-mount) that
1168 # still holds a container lockfile after its main supervisor
1169 # process has exited, and declare the instance broken.
1170 TimeoutStaleRunLock: 5s
1172 # Time to give up on SIGTERM and write off the worker.
1175 # Maximum create/destroy-instance operations per second (0 =
1177 MaxCloudOpsPerSecond: 10
1179 # Maximum concurrent instance creation operations (0 = unlimited).
1181 # MaxConcurrentInstanceCreateOps limits the number of instance creation
1182 # requests that can be in flight at any one time, whereas
1183 # MaxCloudOpsPerSecond limits the number of create/destroy operations
1184 # that can be started per second.
1186 # Because the API for instance creation on Azure is synchronous, it is
1187 # recommended to increase MaxConcurrentInstanceCreateOps when running
1188 # on Azure. When using managed images, a value of 20 would be
1189 # appropriate. When using Azure Shared Image Galeries, it could be set
1190 # higher. For more information, see
1191 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
1193 # MaxConcurrentInstanceCreateOps can be increased for other cloud
1194 # providers too, if desired.
1195 MaxConcurrentInstanceCreateOps: 1
1197 # Interval between cloud provider syncs/updates ("list all
1201 # Time to leave an idle worker running (in case new containers
1202 # appear in the queue that it can run) before shutting it
1206 # Time to wait for a new worker to boot (i.e., pass
1207 # BootProbeCommand) before giving up and shutting it down.
1210 # Maximum time a worker can stay alive with no successful
1211 # probes before being automatically shut down.
1214 # Time after shutting down a worker to retry the
1215 # shutdown/destroy operation.
1216 TimeoutShutdown: 10s
1218 # Worker VM image ID.
1219 # (aws) AMI identifier
1220 # (azure) managed disks: the name of the managed disk image
1221 # (azure) shared image gallery: the name of the image definition. Also
1222 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1223 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1224 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1227 # An executable file (located on the dispatcher host) to be
1228 # copied to cloud instances at runtime and used as the
1229 # container runner/supervisor. The default value is the
1230 # dispatcher program itself.
1232 # Use the empty string to disable this step: nothing will be
1233 # copied, and cloud instances are assumed to have a suitable
1234 # version of crunch-run installed; see CrunchRunCommand above.
1235 DeployRunnerBinary: "/proc/self/exe"
1237 # Tags to add on all resources (VMs, NICs, disks) created by
1238 # the container dispatcher. (Arvados's own tags --
1239 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1244 # Prefix for predefined tags used by Arvados (InstanceSetID,
1245 # InstanceType, InstanceSecret, IdleBehavior). With the
1246 # default value "Arvados", tags are "ArvadosInstanceSetID",
1247 # "ArvadosInstanceSecret", etc.
1249 # This should only be changed while no cloud resources are in
1250 # use and the cloud dispatcher is not running. Otherwise,
1251 # VMs/resources that were added using the old tag prefix will
1252 # need to be detected and cleaned up manually.
1253 TagKeyPrefix: Arvados
1255 # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1258 # Cloud-specific driver parameters.
1261 # (ec2) Credentials. Omit or leave blank if using IAM role.
1265 # (ec2) Instance configuration.
1271 AdminUsername: debian
1272 IamInstanceProfile: ""
1274 # (azure) Credentials.
1280 # (azure) Instance configuration.
1281 CloudEnvironment: AzurePublicCloud
1284 # (azure) The resource group where the VM and virtual NIC will be
1288 # (azure) The resource group of the Network to use for the virtual
1289 # NIC (if different from ResourceGroup)
1290 NetworkResourceGroup: ""
1294 # (azure) managed disks: The resource group where the managed disk
1295 # image can be found (if different from ResourceGroup).
1296 ImageResourceGroup: ""
1298 # (azure) shared image gallery: the name of the gallery
1299 SharedImageGalleryName: ""
1300 # (azure) shared image gallery: the version of the image definition
1301 SharedImageGalleryImageVersion: ""
1303 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1307 # (azure) How long to wait before deleting VHD and NIC
1308 # objects that are no longer being used.
1309 DeleteDanglingResourcesAfter: 20s
1311 # Account (that already exists in the VM image) that will be
1312 # set up with an ssh authorized key to allow the compute
1313 # dispatcher to connect.
1314 AdminUsername: arvados
1318 # Use the instance type name as the key (in place of "SAMPLE" in
1319 # this sample entry).
1321 # Cloud provider's instance type. Defaults to the configured type name.
1325 IncludedScratch: 16GB
1329 # Include this section if the node type includes GPU (CUDA) support
1331 DriverVersion: "11.0"
1332 HardwareCapability: "9.0"
1337 # If you use multiple storage classes, specify them here, using
1338 # the storage class name as the key (in place of "SAMPLE" in
1339 # this sample entry).
1341 # Further info/examples:
1342 # https://doc.arvados.org/admin/storage-classes.html
1345 # Priority determines the order volumes should be searched
1346 # when reading data, in cases where a keepstore server has
1347 # access to multiple volumes with different storage classes.
1350 # Default determines which storage class(es) should be used
1351 # when a user/client writes data or saves a new collection
1352 # without specifying storage classes.
1354 # If any StorageClasses are configured, at least one of them
1355 # must have Default: true.
1360 # AccessViaHosts specifies which keepstore processes can read
1361 # and write data on the volume.
1363 # For a local filesystem, AccessViaHosts has one entry,
1364 # indicating which server the filesystem is located on.
1366 # For a network-attached backend accessible by all keepstore
1367 # servers, like a cloud storage bucket or an NFS mount,
1368 # AccessViaHosts can be empty/omitted.
1370 # Further info/examples:
1371 # https://doc.arvados.org/install/configure-fs-storage.html
1372 # https://doc.arvados.org/install/configure-s3-object-storage.html
1373 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1377 "http://host1.example:25107": {}
1381 # If you have configured storage classes (see StorageClasses
1382 # section above), add an entry here for each storage class
1383 # satisfied by this volume.
1387 # for s3 driver -- see
1388 # https://doc.arvados.org/install/configure-s3-object-storage.html
1391 SecretAccessKey: aaaaa
1395 LocationConstraint: false
1402 # Use aws-s3-go (v2) instead of goamz
1403 UseAWSS3v2Driver: false
1405 # For S3 driver, potentially unsafe tuning parameter,
1406 # intentionally excluded from main documentation.
1408 # Enable deletion (garbage collection) even when the
1409 # configured BlobTrashLifetime is zero. WARNING: eventual
1410 # consistency may result in race conditions that can cause
1411 # data loss. Do not enable this unless you understand and
1415 # for azure driver -- see
1416 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1417 StorageAccountName: aaaaa
1418 StorageAccountKey: aaaaa
1419 StorageBaseURL: core.windows.net
1420 ContainerName: aaaaa
1422 ListBlobsRetryDelay: 10s
1423 ListBlobsMaxAttempts: 10
1425 WriteRaceInterval: 15s
1426 WriteRacePollTime: 1s
1428 # for local directory driver -- see
1429 # https://doc.arvados.org/install/configure-fs-storage.html
1430 Root: /var/lib/arvados/keep-data
1432 # For local directory driver, potentially confusing tuning
1433 # parameter, intentionally excluded from main documentation.
1435 # When true, read and write operations (for whole 64MiB
1436 # blocks) on an individual volume will queued and issued
1437 # serially. When false, read and write operations will be
1438 # issued concurrently.
1440 # May possibly improve throughput if you have physical spinning disks
1441 # and experience contention when there are multiple requests
1442 # to the same volume.
1444 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1445 # should leave this alone.
1451 SendUserSetupNotificationEmail: true
1453 # Bug/issue report notification to and from addresses
1454 IssueReporterEmailFrom: "arvados@example.com"
1455 IssueReporterEmailTo: "arvados@example.com"
1456 SupportEmailAddress: "arvados@example.com"
1458 # Generic issue email from
1459 EmailFrom: "arvados@example.com"
1466 ActivateUsers: false
1468 # API endpoint host or host:port; default is {id}.arvadosapi.com
1469 Host: sample.arvadosapi.com
1471 # Perform a proxy request when a local client requests an
1472 # object belonging to this remote.
1475 # Default "https". Can be set to "http" for testing.
1478 # Disable TLS verify. Can be set to true for testing.
1481 # When users present tokens issued by this remote cluster, and
1482 # their accounts are active on the remote cluster, activate
1483 # them on this cluster too.
1484 ActivateUsers: false
1487 # Workbench1 configs
1489 ActivationContactLink: mailto:info@arvados.org
1490 ArvadosDocsite: https://doc.arvados.org
1491 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1492 ShowUserAgreementInline: false
1495 # Scratch directory used by the remote repository browsing
1496 # feature. If it doesn't exist, it (and any missing parents) will be
1497 # created using mkdir_p.
1498 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1500 # Below is a sample setting of user_profile_form_fields config parameter.
1501 # This configuration parameter should be set to either false (to disable) or
1502 # to a map as shown below.
1503 # Configure the map of input fields to be displayed in the profile page
1504 # using the attribute "key" for each of the input fields.
1505 # This sample shows configuration with one required and one optional form fields.
1506 # For each of these input fields:
1507 # You can specify "Type" as "text" or "select".
1508 # List the "Options" to be displayed for each of the "select" menu.
1509 # Set "Required" as "true" for any of these fields to make them required.
1510 # If any of the required fields are missing in the user's profile, the user will be
1511 # redirected to the profile page before they can access any Workbench features.
1512 UserProfileFormFields:
1515 FormFieldTitle: Best color
1516 FormFieldDescription: your favorite color
1525 # exampleTextValue: # key that will be set in properties
1527 # FormFieldTitle: ""
1528 # FormFieldDescription: ""
1531 # exampleOptionsValue:
1533 # FormFieldTitle: ""
1534 # FormFieldDescription: ""
1542 # Use "UserProfileFormMessage to configure the message you want
1543 # to display on the profile page.
1544 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1546 # Mimetypes of applications for which the view icon
1547 # would be enabled in a collection's show page.
1548 # It is sufficient to list only applications here.
1549 # No need to list text and image types.
1550 ApplicationMimetypesWithViewIcon:
1568 # The maximum number of bytes to load in the log viewer
1569 LogViewerMaxBytes: 1M
1571 # When anonymous_user_token is configured, show public projects page
1572 EnablePublicProjectsPage: true
1574 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1575 EnableGettingStartedPopup: false
1577 # Ask Arvados API server to compress its response payloads.
1578 APIResponseCompression: true
1580 # Timeouts for API requests.
1581 APIClientConnectTimeout: 2m
1582 APIClientReceiveTimeout: 5m
1584 # Maximum number of historic log records of a running job to fetch
1585 # and display in the Log tab, while subscribing to web sockets.
1586 RunningJobLogRecordsToFetch: 2000
1588 # In systems with many shared projects, loading of dashboard and topnav
1589 # can be slow due to collections indexing; use the following parameters
1590 # to suppress these properties
1591 ShowRecentCollectionsOnDashboard: true
1592 ShowUserNotifications: true
1594 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1595 # a link to the multi-site search page on a "home" Workbench site.
1598 # https://workbench.zzzzz.arvadosapi.com/collections/multisite
1601 # Should workbench allow management of local git repositories? Set to false if
1602 # the jobs api is disabled and there are no local git repositories.
1605 SiteName: Arvados Workbench
1606 ProfilingEnabled: false
1608 # This is related to obsolete Google OpenID 1.0 login
1609 # but some workbench stuff still expects it to be set.
1610 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1612 # Workbench2 configs
1613 FileViewersConfigURL: ""
1615 # Idle time after which the user's session will be auto closed.
1616 # This feature is disabled when set to zero.
1619 # Workbench welcome screen, this is HTML text that will be
1620 # incorporated directly onto the page.
1622 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1623 <h2>Please log in.</h2>
1625 <p>If you have never used Arvados Workbench before, logging in
1626 for the first time will automatically create a new
1629 <i>Arvados Workbench uses your information only for
1630 identification, and does not retrieve any other personal
1633 # Workbench screen displayed to inactive users. This is HTML
1634 # text that will be incorporated directly onto the page.
1636 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1637 <h3>Hi! You're logged in, but...</h3>
1638 <p>Your account is inactive.</p>
1639 <p>An administrator must activate your account before you can get
1642 # Connecting to Arvados shell VMs tends to be site-specific.
1643 # Put any special instructions here. This is HTML text that will
1644 # be incorporated directly onto the Workbench page.
1646 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1647 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1649 # Sample text if you are using a "switchyard" ssh proxy.
1650 # Replace "zzzzz" with your Cluster ID.
1652 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1655 # ServerAliveInterval 60
1656 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1659 # If you are using a switchyard ssh proxy, shell node hostnames
1660 # may require a special hostname suffix. In the sample ssh
1661 # configuration above, this would be ".zzzzz"
1662 # This is added to the hostname in the "command line" column
1663 # the Workbench "shell VMs" page.
1665 # If your shell nodes are directly accessible by users without a
1666 # proxy and have fully qualified host names, you should leave
1668 SSHHelpHostSuffix: ""
1670 # (Experimental) Restart services automatically when config file
1671 # changes are detected. Only supported by `arvados-server boot` in
1673 AutoReloadConfig: false