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
243 # If true, a project must have a non-empty description field in
244 # order to be frozen.
245 FreezeProjectRequiresDescription: false
247 # Project properties that must have non-empty values in order to
248 # freeze a project. Example: {"property_name": true}
249 FreezeProjectRequiresProperties: {}
251 # If true, only an admin user can un-freeze a project. If false,
252 # any user with "manage" permission can un-freeze.
253 UnfreezeProjectRequiresAdmin: false
256 # Config parameters to automatically setup new users. If enabled,
257 # this users will be able to self-activate. Enable this if you want
258 # to run an open instance where anyone can create an account and use
259 # the system without requiring manual approval.
261 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
262 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
263 AutoSetupNewUsers: false
264 AutoSetupNewUsersWithVmUUID: ""
265 AutoSetupNewUsersWithRepository: false
266 AutoSetupUsernameBlacklist:
275 # When NewUsersAreActive is set to true, new users will be active
276 # immediately. This skips the "self-activate" step which enforces
277 # user agreements. Should only be enabled for development.
278 NewUsersAreActive: false
280 # Newly activated users (whether set up by an admin or via
281 # AutoSetupNewUsers) immediately become visible to other active
284 # On a multi-tenant cluster, where the intent is for users to be
285 # invisible to one another unless they have been added to the
286 # same group(s) via Workbench admin interface, change this to
288 ActivatedUsersAreVisibleToOthers: true
290 # The e-mail address of the user you would like to become marked as an admin
291 # user on their first login.
292 AutoAdminUserWithEmail: ""
294 # If AutoAdminFirstUser is set to true, the first user to log in when no
295 # other admin users exist will automatically become an admin user.
296 AutoAdminFirstUser: false
298 # Email address to notify whenever a user creates a profile for the
300 UserProfileNotificationAddress: ""
301 AdminNotifierEmailFrom: arvados@example.com
302 EmailSubjectPrefix: "[ARVADOS] "
303 UserNotifierEmailFrom: arvados@example.com
304 UserNotifierEmailBcc: {}
305 NewUserNotificationRecipients: {}
306 NewInactiveUserNotificationRecipients: {}
308 # Set AnonymousUserToken to enable anonymous user access. Populate this
309 # field with a random string at least 50 characters long.
310 AnonymousUserToken: ""
312 # If a new user has an alternate email address (local@domain)
313 # with the domain given here, its local part becomes the new
314 # user's default username. Otherwise, the user's primary email
316 PreferDomainForUsername: ""
319 <% if not @user.full_name.empty? -%>
320 <%= @user.full_name %>,
325 Your Arvados account has been set up. You can log in at
327 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
330 Your Arvados administrator.
332 # If RoleGroupsVisibleToAll is true, all role groups are visible
333 # to all active users.
335 # If false, users must be granted permission to role groups in
336 # order to see them. This is more appropriate for a multi-tenant
338 RoleGroupsVisibleToAll: true
341 # Time to keep audit logs, in seconds. (An audit log is a row added
342 # to the "logs" table in the PostgreSQL database each time an
343 # Arvados object is created, modified, or deleted.)
345 # Currently, websocket event notifications rely on audit logs, so
346 # this should not be set lower than 300 (5 minutes).
349 # Maximum number of log rows to delete in a single SQL transaction.
351 # If MaxDeleteBatch is 0, log entries will never be
352 # deleted by Arvados. Cleanup can be done by an external process
353 # without affecting any Arvados system processes, as long as very
354 # recent (<5 minutes old) logs are not deleted.
356 # 100000 is a reasonable batch size for most sites.
359 # Attributes to suppress in events and audit logs. Notably,
360 # specifying {"manifest_text": {}} here typically makes the database
361 # smaller and faster.
363 # Warning: Using any non-empty value here can have undesirable side
364 # effects for any client or component that relies on event logs.
365 # Use at your own risk.
366 UnloggedAttributes: {}
370 # Logging threshold: panic, fatal, error, warn, info, debug, or
374 # Logging format: json or text
377 # Maximum characters of (JSON-encoded) query parameters to include
378 # in each request log entry. When params exceed this size, they will
379 # be JSON-encoded, truncated to this size, and logged as
381 MaxRequestLogParamsSize: 2000
385 # Enable access controls for data stored in Keep. This should
386 # always be set to true on a production cluster.
389 # BlobSigningKey is a string of alphanumeric characters used to
390 # generate permission signatures for Keep locators. It must be
391 # identical to the permission key given to Keep. IMPORTANT: This
392 # is a site secret. It should be at least 50 characters.
394 # Modifying BlobSigningKey will invalidate all existing
395 # signatures, which can cause programs to fail (e.g., arv-put,
396 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
397 # when no such processes are running.
400 # Enable garbage collection of unreferenced blobs in Keep.
403 # Time to leave unreferenced blobs in "trashed" state before
404 # deleting them, or 0 to skip the "trashed" state entirely and
405 # delete unreferenced blobs.
407 # If you use any Amazon S3 buckets as storage volumes, this
408 # must be at least 24h to avoid occasional data loss.
409 BlobTrashLifetime: 336h
411 # How often to check for (and delete) trashed blocks whose
412 # BlobTrashLifetime has expired.
413 BlobTrashCheckInterval: 24h
415 # Maximum number of concurrent "trash blob" and "delete trashed
416 # blob" operations conducted by a single keepstore process. Each
417 # of these can be set to 0 to disable the respective operation.
419 # If BlobTrashLifetime is zero, "trash" and "delete trash"
420 # happen at once, so only the lower of these two values is used.
421 BlobTrashConcurrency: 4
422 BlobDeleteConcurrency: 4
424 # Maximum number of concurrent "create additional replica of
425 # existing blob" operations conducted by a single keepstore
427 BlobReplicateConcurrency: 4
429 # Default replication level for collections. This is used when a
430 # collection's replication_desired attribute is nil.
431 DefaultReplication: 2
433 # BlobSigningTTL determines the minimum lifetime of transient
434 # data, i.e., blocks that are not referenced by
435 # collections. Unreferenced blocks exist for two reasons:
437 # 1) A data block must be written to a disk/cloud backend device
438 # before a collection can be created/updated with a reference to
441 # 2) Deleting or updating a collection can remove the last
442 # remaining reference to a data block.
444 # If BlobSigningTTL is too short, long-running
445 # processes/containers will fail when they take too long (a)
446 # between writing blocks and writing collections that reference
447 # them, or (b) between reading collections and reading the
450 # If BlobSigningTTL is too long, data will still be stored long
451 # after the referring collections are deleted, and you will
452 # needlessly fill up disks or waste money on cloud storage.
454 # Modifying BlobSigningTTL invalidates existing signatures; see
455 # BlobSigningKey note above.
457 # The default is 2 weeks.
460 # When running keep-balance, this is the destination filename for
461 # the list of lost block hashes if there are any, one per line.
462 # Updated automically during each successful run.
463 BlobMissingReport: ""
465 # keep-balance operates periodically, i.e.: do a
466 # scan/balance operation, sleep, repeat.
468 # BalancePeriod determines the interval between start times of
469 # successive scan/balance operations. If a scan/balance operation
470 # takes longer than BalancePeriod, the next one will follow it
473 # If SIGUSR1 is received during an idle period between operations,
474 # the next operation will start immediately.
477 # Limits the number of collections retrieved by keep-balance per
478 # API transaction. If this is zero, page size is
479 # determined by the API server's own page size limits (see
480 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
481 BalanceCollectionBatch: 0
483 # The size of keep-balance's internal queue of
484 # collections. Higher values use more memory and improve throughput
485 # by allowing keep-balance to fetch the next page of collections
486 # while the current page is still being processed. If this is zero
487 # or omitted, pages are processed serially.
488 BalanceCollectionBuffers: 1000
490 # Maximum time for a rebalancing run. This ensures keep-balance
491 # eventually gives up and retries if, for example, a network
492 # error causes a hung connection that is never closed by the
493 # OS. It should be long enough that it doesn't interrupt a
494 # long-running balancing operation.
497 # Maximum number of replication_confirmed /
498 # storage_classes_confirmed updates to write to the database
499 # after a rebalancing run. When many updates are needed, this
500 # spreads them over a few runs rather than applying them all at
502 BalanceUpdateLimit: 100000
504 # Default lifetime for ephemeral collections: 2 weeks. This must not
505 # be less than BlobSigningTTL.
506 DefaultTrashLifetime: 336h
508 # Interval (seconds) between trash sweeps. During a trash sweep,
509 # collections are marked as trash if their trash_at time has
510 # arrived, and deleted if their delete_at time has arrived.
511 TrashSweepInterval: 60s
513 # If true, enable collection versioning.
514 # When a collection's preserve_version field is true or the current version
515 # is older than the amount of seconds defined on PreserveVersionIfIdle,
516 # a snapshot of the collection's previous state is created and linked to
517 # the current collection.
518 CollectionVersioning: true
520 # 0s = auto-create a new version on every update.
521 # -1s = never auto-create new versions.
522 # > 0s = auto-create a new version when older than the specified number of seconds.
523 PreserveVersionIfIdle: 10s
525 # If non-empty, allow project and collection names to contain
526 # the "/" character (slash/stroke/solidus), and replace "/" with
527 # the given string in the filesystem hierarchy presented by
528 # WebDAV. Example values are "%2f" and "{slash}". Names that
529 # contain the substitution string itself may result in confusing
530 # behavior, so a value like "_" is not recommended.
532 # If the default empty value is used, the server will reject
533 # requests to create or rename a collection when the new name
536 # If the value "/" is used, project and collection names
537 # containing "/" will be allowed, but they will not be
538 # accessible via WebDAV.
540 # Use of this feature is not recommended, if it can be avoided.
541 ForwardSlashNameSubstitution: ""
543 # Include "folder objects" in S3 ListObjects responses.
544 S3FolderObjects: true
546 # Managed collection properties. At creation time, if the client didn't
547 # provide the listed keys, they will be automatically populated following
548 # one of the following behaviors:
550 # * UUID of the user who owns the containing project.
551 # responsible_person_uuid: {Function: original_owner, Protected: true}
553 # * Default concrete value.
554 # foo_bar: {Value: baz, Protected: false}
556 # If Protected is true, only an admin user can modify its value.
558 SAMPLE: {Function: original_owner, Protected: true}
560 # In "trust all content" mode, Workbench will redirect download
561 # requests to WebDAV preview link, even in the cases when
562 # WebDAV would have to expose XSS vulnerabilities in order to
563 # handle the redirect (see discussion on Services.WebDAV).
565 # This setting has no effect in the recommended configuration, where the
566 # WebDAV service is configured to have a separate domain for every
567 # collection and XSS protection is provided by browsers' same-origin
570 # The default setting (false) is appropriate for a multi-user site.
571 TrustAllContent: false
573 # Cache parameters for WebDAV content serving:
575 # Time to cache manifests, permission checks, and sessions.
578 # Time to cache collection state.
581 # Block cache entries. Each block consumes up to 64 MiB RAM.
584 # Collection cache entries.
585 MaxCollectionEntries: 1000
587 # Approximate memory limit (in bytes) for collection cache.
588 MaxCollectionBytes: 100000000
590 # UUID cache entries.
593 # Persistent sessions.
596 # Selectively set permissions for regular users and admins to
597 # download or upload data files using the upload/download
598 # features for Workbench, WebDAV and S3 API support.
607 # Selectively set permissions for regular users and admins to be
608 # able to download or upload blocks using arv-put and
609 # arv-get from outside the cluster.
618 # Post upload / download events to the API server logs table, so
619 # that they can be included in the arv-user-activity report.
620 # You can disable this if you find that it is creating excess
621 # load on the API server and you don't need it.
622 WebDAVLogEvents: true
625 # One of the following mechanisms (Google, PAM, LDAP, or
626 # LoginCluster) should be enabled; see
627 # https://doc.arvados.org/install/setup-login.html
630 # Authenticate with Google.
633 # Use the Google Cloud console to enable the People API (APIs
634 # and Services > Enable APIs and services > Google People API
635 # > Enable), generate a Client ID and secret (APIs and
636 # Services > Credentials > Create credentials > OAuth client
637 # ID > Web application) and add your controller's /login URL
638 # (e.g., "https://zzzzz.example.com/login") as an authorized
643 # Allow users to log in to existing accounts using any verified
644 # email address listed by their Google account. If true, the
645 # Google People API must be enabled in order for Google login to
646 # work. If false, only the primary email address will be used.
647 AlternateEmailAddresses: true
649 # Send additional parameters with authentication requests. See
650 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
651 # for a list of supported parameters.
652 AuthenticationRequestParameters:
653 # Show the "choose which Google account" page, even if the
654 # client is currently logged in to exactly one Google
656 prompt: select_account
661 # Authenticate with an OpenID Connect provider.
664 # Issuer URL, e.g., "https://login.example.com".
666 # This must be exactly equal to the URL returned by the issuer
667 # itself in its config response ("isser" key). If the
668 # configured value is "https://example" and the provider
669 # returns "https://example:443" or "https://example/" then
670 # login will fail, even though those URLs are equivalent
674 # Your client ID and client secret (supplied by the provider).
678 # OpenID claim field containing the user's email
679 # address. Normally "email"; see
680 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
683 # OpenID claim field containing the email verification
684 # flag. Normally "email_verified". To accept every returned
685 # email address without checking a "verified" field at all,
686 # use the empty string "".
687 EmailVerifiedClaim: "email_verified"
689 # OpenID claim field containing the user's preferred
690 # username. If empty, use the mailbox part of the user's email
694 # Send additional parameters with authentication requests,
695 # like {display: page, prompt: consent}. See
696 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
697 # and refer to your provider's documentation for supported
699 AuthenticationRequestParameters:
702 # Accept an OIDC access token as an API token if the OIDC
703 # provider's UserInfo endpoint accepts it.
705 # AcceptAccessTokenScope should also be used when enabling
707 AcceptAccessToken: false
709 # Before accepting an OIDC access token as an API token, first
710 # check that it is a JWT whose "scope" value includes this
711 # value. Example: "https://zzzzz.example.com/" (your Arvados
714 # If this value is empty and AcceptAccessToken is true, all
715 # access tokens will be accepted regardless of scope,
716 # including non-JWT tokens. This is not recommended.
717 AcceptAccessTokenScope: ""
720 # Use PAM to authenticate users.
723 # PAM service name. PAM will apply the policy in the
724 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
725 # there is none, the default "other" config.
728 # Domain name (e.g., "example.com") to use to construct the
729 # user's email address if PAM authentication returns a
730 # username with no "@". If empty, use the PAM username as the
731 # user's email address, whether or not it contains "@".
733 # Note that the email address is used as the primary key for
734 # user records when logging in. Therefore, if you change
735 # PAMDefaultEmailDomain after the initial installation, you
736 # should also update existing user records to reflect the new
737 # domain. Otherwise, next time those users log in, they will
738 # be given new accounts instead of accessing their existing
740 DefaultEmailDomain: ""
743 # Use an LDAP service to authenticate users.
746 # Server URL, like "ldap://ldapserver.example.com:389" or
747 # "ldaps://ldapserver.example.com:636".
748 URL: "ldap://ldap:389"
750 # Use StartTLS upon connecting to the server.
753 # Skip TLS certificate name verification.
756 # Strip the @domain part if a user supplies an email-style
757 # username with this domain. If "*", strip any user-provided
758 # domain. If "", never strip the domain part. Example:
762 # If, after applying StripDomain, the username contains no "@"
763 # character, append this domain to form an email-style
764 # username. Example: "example.com"
767 # The LDAP attribute to filter on when looking up a username
768 # (after applying StripDomain and AppendDomain).
771 # Bind with this username (DN or UPN) and password when
772 # looking up the user record.
774 # Example user: "cn=admin,dc=example,dc=com"
776 SearchBindPassword: ""
778 # Directory base for username lookup. Example:
779 # "ou=Users,dc=example,dc=com"
782 # Additional filters to apply when looking up users' LDAP
783 # entries. This can be used to restrict access to a subset of
784 # LDAP users, or to disambiguate users from other directory
785 # entries that have the SearchAttribute present.
787 # Special characters in assertion values must be escaped (see
790 # Example: "(objectClass=person)"
793 # LDAP attribute to use as the user's email address.
795 # Important: This must not be an attribute whose value can be
796 # edited in the directory by the users themselves. Otherwise,
797 # users can take over other users' Arvados accounts trivially
798 # (email address is the primary key for Arvados accounts.)
801 # LDAP attribute to use as the preferred Arvados username. If
802 # no value is found (or this config is empty) the username
803 # originally supplied by the user will be used.
804 UsernameAttribute: uid
807 # Authenticate users listed here in the config file. This
808 # feature is intended to be used in test environments, and
809 # should not be used in production.
813 Email: alice@example.com
816 # The cluster ID to delegate the user database. When set,
817 # logins on this cluster will be redirected to the login cluster
818 # (login cluster must appear in RemoteClusters with Proxy: true)
821 # How long a cached token belonging to a remote cluster will
822 # remain valid before it needs to be revalidated.
823 RemoteTokenRefresh: 5m
825 # How long a client token created from a login flow will be valid without
826 # asking the user to re-login. Example values: 60m, 8h.
827 # Default value zero means tokens don't have expiration.
830 # If true (default) tokens issued through login are allowed to create
832 # If false, tokens issued through login are not allowed to
833 # viewing/creating other tokens. New tokens can only be created
834 # by going through login again.
835 IssueTrustedTokens: true
837 # When the token is returned to a client, the token itself may
838 # be restricted from viewing/creating other tokens based on whether
839 # the client is "trusted" or not. The local Workbench1 and
840 # Workbench2 are trusted by default, but if this is a
841 # LoginCluster, you probably want to include the other Workbench
842 # instances in the federation in this list.
845 "https://workbench.federate1.example": {}
846 "https://workbench.federate2.example": {}
849 # Path to git or gitolite-shell executable. Each authenticated
850 # request will execute this program with the single argument "http-backend"
851 GitCommand: /usr/bin/git
853 # Path to Gitolite's home directory. If a non-empty path is given,
854 # the CGI environment will be set up to support the use of
855 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
856 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
857 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
860 # Git repositories must be readable by api server, or you won't be
861 # able to submit crunch jobs. To pass the test suites, put a clone
862 # of the arvados tree in {git_repositories_dir}/arvados.git or
863 # {git_repositories_dir}/arvados/.git
864 Repositories: /var/lib/arvados/git/repositories
872 # List of supported Docker Registry image formats that compute nodes
873 # are able to use. `arv keep docker` will error out if a user tries
874 # to store an image with an unsupported format. Use an empty array
875 # to skip the compatibility check (and display a warning message to
878 # Example for sites running docker < 1.10: {"v1": {}}
879 # Example for sites running docker >= 1.10: {"v2": {}}
880 # Example for disabling check: {}
881 SupportedDockerImageFormats:
885 # Include details about job reuse decisions in the server log. This
886 # causes additional database queries to run, so it should not be
887 # enabled unless you expect to examine the resulting logs for
888 # troubleshooting purposes.
889 LogReuseDecisions: false
891 # Default value for keep_cache_ram of a container's runtime_constraints.
892 DefaultKeepCacheRAM: 268435456
894 # Number of times a container can be unlocked before being
895 # automatically cancelled.
896 MaxDispatchAttempts: 5
898 # Default value for container_count_max for container requests. This is the
899 # number of times Arvados will create a new container to satisfy a container
900 # request. If a container is cancelled it will retry a new container if
901 # container_count < container_count_max on any container requests associated
902 # with the cancelled container.
905 # The maximum number of compute nodes that can be in use simultaneously
906 # If this limit is reduced, any existing nodes with slot number >= new limit
907 # will not be counted against the new limit. In other words, the new limit
908 # won't be strictly enforced until those nodes with higher slot numbers
912 # Schedule all child containers on preemptible instances (e.g. AWS
913 # Spot Instances) even if not requested by the submitter.
915 # If false, containers are scheduled on preemptible instances
916 # only when requested by the submitter.
918 # This flag is ignored if no preemptible instance types are
919 # configured, and has no effect on top-level containers.
920 AlwaysUsePreemptibleInstances: false
922 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
923 # cloud dispatcher for executing containers on worker VMs.
924 # Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
925 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
926 DispatchPrivateKey: ""
928 # Maximum time to wait for workers to come up before abandoning
929 # stale locks from a previous dispatch process.
932 # The crunch-run command used to start a container on a worker node.
934 # When dispatching to cloud VMs, this is used only if
935 # DeployRunnerBinary in the CloudVMs section is set to the empty
937 CrunchRunCommand: "crunch-run"
939 # Extra arguments to add to crunch-run invocation
940 # Example: ["--cgroup-parent-subsystem=memory"]
941 CrunchRunArgumentsList: []
943 # Extra RAM to reserve on the node, in addition to
944 # the amount specified in the container's RuntimeConstraints
945 ReserveExtraRAM: 256MiB
947 # Minimum time between two attempts to run the same container
950 # Container runtime: "docker" (default) or "singularity"
951 RuntimeEngine: docker
953 # When running a container, run a dedicated keepstore process,
954 # using the specified number of 64 MiB memory buffers per
955 # allocated CPU core (VCPUs in the container's runtime
956 # constraints). The dedicated keepstore handles I/O for
957 # collections mounted in the container, as well as saving
960 # A zero value disables this feature.
962 # In order for this feature to be activated, no volume may use
963 # AccessViaHosts, and each volume must have Replication higher
964 # than Collections.DefaultReplication. If these requirements are
965 # not satisfied, the feature is disabled automatically
966 # regardless of the value given here.
968 # Note that when this configuration is enabled, the entire
969 # cluster configuration file, including the system root token,
970 # is copied to the worker node and held in memory for the
971 # duration of the container.
972 LocalKeepBlobBuffersPerVCPU: 1
974 # When running a dedicated keepstore process for a container
975 # (see LocalKeepBlobBuffersPerVCPU), write keepstore log
976 # messages to keepstore.txt in the container's log collection.
978 # These log messages can reveal some volume configuration
979 # details, error messages from the cloud storage provider, etc.,
980 # which are not otherwise visible to users.
983 # * "none" -- no keepstore.txt file
984 # * "all" -- all logs, including request and response lines
985 # * "errors" -- all logs except "response" logs with 2xx
986 # response codes and "request" logs
987 LocalKeepLogsToContainerLog: none
990 # When you run the db:delete_old_container_logs task, it will find
991 # containers that have been finished for at least this many seconds,
992 # and delete their stdout, stderr, arv-mount, crunch-run, and
993 # crunchstat logs from the logs table.
996 # These two settings control how frequently log events are flushed to the
997 # database. Log lines are buffered until either crunch_log_bytes_per_event
998 # has been reached or crunch_log_seconds_between_events has elapsed since
1000 LogBytesPerEvent: 4096
1001 LogSecondsBetweenEvents: 5s
1003 # The sample period for throttling logs.
1004 LogThrottlePeriod: 60s
1006 # Maximum number of bytes that job can log over crunch_log_throttle_period
1007 # before being silenced until the end of the period.
1008 LogThrottleBytes: 65536
1010 # Maximum number of lines that job can log over crunch_log_throttle_period
1011 # before being silenced until the end of the period.
1012 LogThrottleLines: 1024
1014 # Maximum bytes that may be logged by a single job. Log bytes that are
1015 # silenced by throttling are not counted against this total.
1016 LimitLogBytesPerJob: 67108864
1018 LogPartialLineThrottlePeriod: 5s
1020 # Container logs are written to Keep and saved in a
1021 # collection, which is updated periodically while the
1022 # container runs. This value sets the interval between
1023 # collection updates.
1024 LogUpdatePeriod: 30m
1026 # The log collection is also updated when the specified amount of
1027 # log data (given in bytes) is produced in less than one update
1029 LogUpdateSize: 32MiB
1032 # An admin user can use "arvados-client shell" to start an
1033 # interactive shell (with any user ID) in any running
1037 # Any user can use "arvados-client shell" to start an
1038 # interactive shell (with any user ID) in any running
1039 # container that they started, provided it isn't also
1040 # associated with a different user's container request.
1042 # Interactive sessions make it easy to alter the container's
1043 # runtime environment in ways that aren't recorded or
1044 # reproducible. Consider the implications for automatic
1045 # container reuse before enabling and using this feature. In
1046 # particular, note that starting an interactive session does
1047 # not disqualify a container from being reused by a different
1048 # user/workflow in the future.
1053 SbatchArgumentsList: []
1054 SbatchEnvironmentVariables:
1057 # Path to dns server configuration directory
1058 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
1059 # files or touch restart.txt (see below).
1060 DNSServerConfDir: ""
1062 # Template file for the dns server host snippets. See
1063 # unbound.template in this directory for an example. If false, do
1064 # not write any config files.
1065 DNSServerConfTemplate: ""
1067 # String to write to {dns_server_conf_dir}/restart.txt (with a
1068 # trailing newline) after updating local data. If false, do not
1069 # open or write the restart.txt file.
1070 DNSServerReloadCommand: ""
1072 # Command to run after each DNS update. Template variables will be
1073 # substituted; see the "unbound" example below. If false, do not run
1075 DNSServerUpdateCommand: ""
1077 ComputeNodeDomain: ""
1078 ComputeNodeNameservers:
1082 # Hostname to assign to a compute node when it sends a "ping" and the
1083 # hostname in its Node record is nil.
1084 # During bootstrapping, the "ping" script is expected to notice the
1085 # hostname given in the ping response, and update its unix hostname
1087 # If false, leave the hostname alone (this is appropriate if your compute
1088 # nodes' hostnames are already assigned by some other mechanism).
1090 # One way or another, the hostnames of your node records should agree
1091 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1093 # Example for compute0000, compute0001, ....:
1094 # assign_node_hostname: compute%<slot_number>04d
1095 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1096 AssignNodeHostname: "compute%<slot_number>d"
1099 # Arguments to bsub when submitting Arvados containers as LSF jobs.
1101 # Template variables starting with % will be substituted as follows:
1104 # %C number of VCPUs
1107 # %G number of GPU devices (runtime_constraints.cuda.device_count)
1109 # Use %% to express a literal %. The %%J in the default will be changed
1110 # to %J, which is interpreted by bsub itself.
1112 # Note that the default arguments cause LSF to write two files
1113 # in /tmp on the compute node each time an Arvados container
1114 # runs. Ensure you have something in place to delete old files
1115 # from /tmp, or adjust the "-o" and "-e" arguments accordingly.
1116 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]"]
1118 # Arguments that will be appended to the bsub command line
1119 # when submitting Arvados containers as LSF jobs with
1120 # runtime_constraints.cuda.device_count > 0
1121 BsubCUDAArguments: ["-gpu", "num=%G"]
1123 # Use sudo to switch to this user account when submitting LSF
1126 # This account must exist on the hosts where LSF jobs run
1127 # ("execution hosts"), as well as on the host where the
1128 # Arvados LSF dispatcher runs ("submission host").
1129 BsubSudoUser: "crunch"
1132 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
1134 # Note: this only enables read-only access, creating new
1135 # legacy jobs and pipelines is not supported.
1137 # 'auto' -- (default) enable the Jobs API only if it has been used before
1138 # (i.e., there are job records in the database)
1139 # 'true' -- enable the Jobs API despite lack of existing records.
1140 # 'false' -- disable the Jobs API despite presence of existing records.
1143 # Git repositories must be readable by api server, or you won't be
1144 # able to submit crunch jobs. To pass the test suites, put a clone
1145 # of the arvados tree in {git_repositories_dir}/arvados.git or
1146 # {git_repositories_dir}/arvados/.git
1147 GitInternalDir: /var/lib/arvados/internal.git
1150 # Enable the cloud scheduler.
1153 # Name/number of port where workers' SSH services listen.
1156 # Interval between queue polls.
1159 # Shell command to execute on each worker to determine whether
1160 # the worker is booted and ready to run containers. It should
1161 # exit zero if the worker is ready.
1162 BootProbeCommand: "systemctl is-system-running"
1164 # Minimum interval between consecutive probes to a single
1168 # Maximum probes per second, across all workers in a pool.
1169 MaxProbesPerSecond: 10
1171 # Time before repeating SIGTERM when killing a container.
1174 # Time to give up on a process (most likely arv-mount) that
1175 # still holds a container lockfile after its main supervisor
1176 # process has exited, and declare the instance broken.
1177 TimeoutStaleRunLock: 5s
1179 # Time to give up on SIGTERM and write off the worker.
1182 # Maximum create/destroy-instance operations per second (0 =
1184 MaxCloudOpsPerSecond: 10
1186 # Maximum concurrent instance creation operations (0 = unlimited).
1188 # MaxConcurrentInstanceCreateOps limits the number of instance creation
1189 # requests that can be in flight at any one time, whereas
1190 # MaxCloudOpsPerSecond limits the number of create/destroy operations
1191 # that can be started per second.
1193 # Because the API for instance creation on Azure is synchronous, it is
1194 # recommended to increase MaxConcurrentInstanceCreateOps when running
1195 # on Azure. When using managed images, a value of 20 would be
1196 # appropriate. When using Azure Shared Image Galeries, it could be set
1197 # higher. For more information, see
1198 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
1200 # MaxConcurrentInstanceCreateOps can be increased for other cloud
1201 # providers too, if desired.
1202 MaxConcurrentInstanceCreateOps: 1
1204 # Interval between cloud provider syncs/updates ("list all
1208 # Time to leave an idle worker running (in case new containers
1209 # appear in the queue that it can run) before shutting it
1213 # Time to wait for a new worker to boot (i.e., pass
1214 # BootProbeCommand) before giving up and shutting it down.
1217 # Maximum time a worker can stay alive with no successful
1218 # probes before being automatically shut down.
1221 # Time after shutting down a worker to retry the
1222 # shutdown/destroy operation.
1223 TimeoutShutdown: 10s
1225 # Worker VM image ID.
1226 # (aws) AMI identifier
1227 # (azure) managed disks: the name of the managed disk image
1228 # (azure) shared image gallery: the name of the image definition. Also
1229 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1230 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1231 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1234 # An executable file (located on the dispatcher host) to be
1235 # copied to cloud instances at runtime and used as the
1236 # container runner/supervisor. The default value is the
1237 # dispatcher program itself.
1239 # Use the empty string to disable this step: nothing will be
1240 # copied, and cloud instances are assumed to have a suitable
1241 # version of crunch-run installed; see CrunchRunCommand above.
1242 DeployRunnerBinary: "/proc/self/exe"
1244 # Tags to add on all resources (VMs, NICs, disks) created by
1245 # the container dispatcher. (Arvados's own tags --
1246 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1251 # Prefix for predefined tags used by Arvados (InstanceSetID,
1252 # InstanceType, InstanceSecret, IdleBehavior). With the
1253 # default value "Arvados", tags are "ArvadosInstanceSetID",
1254 # "ArvadosInstanceSecret", etc.
1256 # This should only be changed while no cloud resources are in
1257 # use and the cloud dispatcher is not running. Otherwise,
1258 # VMs/resources that were added using the old tag prefix will
1259 # need to be detected and cleaned up manually.
1260 TagKeyPrefix: Arvados
1262 # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1265 # Cloud-specific driver parameters.
1268 # (ec2) Credentials. Omit or leave blank if using IAM role.
1272 # (ec2) Instance configuration.
1278 AdminUsername: debian
1279 # (ec2) name of the IAMInstanceProfile for instances started by
1280 # the cloud dispatcher. Leave blank when not needed.
1281 IAMInstanceProfile: ""
1283 # (azure) Credentials.
1289 # (azure) Instance configuration.
1290 CloudEnvironment: AzurePublicCloud
1293 # (azure) The resource group where the VM and virtual NIC will be
1297 # (azure) The resource group of the Network to use for the virtual
1298 # NIC (if different from ResourceGroup)
1299 NetworkResourceGroup: ""
1303 # (azure) managed disks: The resource group where the managed disk
1304 # image can be found (if different from ResourceGroup).
1305 ImageResourceGroup: ""
1307 # (azure) shared image gallery: the name of the gallery
1308 SharedImageGalleryName: ""
1309 # (azure) shared image gallery: the version of the image definition
1310 SharedImageGalleryImageVersion: ""
1312 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1316 # (azure) How long to wait before deleting VHD and NIC
1317 # objects that are no longer being used.
1318 DeleteDanglingResourcesAfter: 20s
1320 # Account (that already exists in the VM image) that will be
1321 # set up with an ssh authorized key to allow the compute
1322 # dispatcher to connect.
1323 AdminUsername: arvados
1327 # Use the instance type name as the key (in place of "SAMPLE" in
1328 # this sample entry).
1330 # Cloud provider's instance type. Defaults to the configured type name.
1334 IncludedScratch: 16GB
1338 # Include this section if the node type includes GPU (CUDA) support
1340 DriverVersion: "11.0"
1341 HardwareCapability: "9.0"
1346 # If you use multiple storage classes, specify them here, using
1347 # the storage class name as the key (in place of "SAMPLE" in
1348 # this sample entry).
1350 # Further info/examples:
1351 # https://doc.arvados.org/admin/storage-classes.html
1354 # Priority determines the order volumes should be searched
1355 # when reading data, in cases where a keepstore server has
1356 # access to multiple volumes with different storage classes.
1359 # Default determines which storage class(es) should be used
1360 # when a user/client writes data or saves a new collection
1361 # without specifying storage classes.
1363 # If any StorageClasses are configured, at least one of them
1364 # must have Default: true.
1369 # AccessViaHosts specifies which keepstore processes can read
1370 # and write data on the volume.
1372 # For a local filesystem, AccessViaHosts has one entry,
1373 # indicating which server the filesystem is located on.
1375 # For a network-attached backend accessible by all keepstore
1376 # servers, like a cloud storage bucket or an NFS mount,
1377 # AccessViaHosts can be empty/omitted.
1379 # Further info/examples:
1380 # https://doc.arvados.org/install/configure-fs-storage.html
1381 # https://doc.arvados.org/install/configure-s3-object-storage.html
1382 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1386 "http://host1.example:25107": {}
1390 # If you have configured storage classes (see StorageClasses
1391 # section above), add an entry here for each storage class
1392 # satisfied by this volume.
1396 # for s3 driver -- see
1397 # https://doc.arvados.org/install/configure-s3-object-storage.html
1400 SecretAccessKey: aaaaa
1404 LocationConstraint: false
1411 # Use aws-s3-go (v2) instead of goamz
1412 UseAWSS3v2Driver: false
1414 # For S3 driver, potentially unsafe tuning parameter,
1415 # intentionally excluded from main documentation.
1417 # Enable deletion (garbage collection) even when the
1418 # configured BlobTrashLifetime is zero. WARNING: eventual
1419 # consistency may result in race conditions that can cause
1420 # data loss. Do not enable this unless you understand and
1424 # for azure driver -- see
1425 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1426 StorageAccountName: aaaaa
1427 StorageAccountKey: aaaaa
1428 StorageBaseURL: core.windows.net
1429 ContainerName: aaaaa
1431 ListBlobsRetryDelay: 10s
1432 ListBlobsMaxAttempts: 10
1434 WriteRaceInterval: 15s
1435 WriteRacePollTime: 1s
1437 # for local directory driver -- see
1438 # https://doc.arvados.org/install/configure-fs-storage.html
1439 Root: /var/lib/arvados/keep-data
1441 # For local directory driver, potentially confusing tuning
1442 # parameter, intentionally excluded from main documentation.
1444 # When true, read and write operations (for whole 64MiB
1445 # blocks) on an individual volume will queued and issued
1446 # serially. When false, read and write operations will be
1447 # issued concurrently.
1449 # May possibly improve throughput if you have physical spinning disks
1450 # and experience contention when there are multiple requests
1451 # to the same volume.
1453 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1454 # should leave this alone.
1460 SendUserSetupNotificationEmail: true
1462 # Bug/issue report notification to and from addresses
1463 IssueReporterEmailFrom: "arvados@example.com"
1464 IssueReporterEmailTo: "arvados@example.com"
1465 SupportEmailAddress: "arvados@example.com"
1467 # Generic issue email from
1468 EmailFrom: "arvados@example.com"
1475 ActivateUsers: false
1477 # API endpoint host or host:port; default is {id}.arvadosapi.com
1478 Host: sample.arvadosapi.com
1480 # Perform a proxy request when a local client requests an
1481 # object belonging to this remote.
1484 # Default "https". Can be set to "http" for testing.
1487 # Disable TLS verify. Can be set to true for testing.
1490 # When users present tokens issued by this remote cluster, and
1491 # their accounts are active on the remote cluster, activate
1492 # them on this cluster too.
1493 ActivateUsers: false
1496 # Workbench1 configs
1498 ActivationContactLink: mailto:info@arvados.org
1499 ArvadosDocsite: https://doc.arvados.org
1500 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1501 ShowUserAgreementInline: false
1504 # Scratch directory used by the remote repository browsing
1505 # feature. If it doesn't exist, it (and any missing parents) will be
1506 # created using mkdir_p.
1507 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1509 # Below is a sample setting of user_profile_form_fields config parameter.
1510 # This configuration parameter should be set to either false (to disable) or
1511 # to a map as shown below.
1512 # Configure the map of input fields to be displayed in the profile page
1513 # using the attribute "key" for each of the input fields.
1514 # This sample shows configuration with one required and one optional form fields.
1515 # For each of these input fields:
1516 # You can specify "Type" as "text" or "select".
1517 # List the "Options" to be displayed for each of the "select" menu.
1518 # Set "Required" as "true" for any of these fields to make them required.
1519 # If any of the required fields are missing in the user's profile, the user will be
1520 # redirected to the profile page before they can access any Workbench features.
1521 UserProfileFormFields:
1524 FormFieldTitle: Best color
1525 FormFieldDescription: your favorite color
1534 # exampleTextValue: # key that will be set in properties
1536 # FormFieldTitle: ""
1537 # FormFieldDescription: ""
1540 # exampleOptionsValue:
1542 # FormFieldTitle: ""
1543 # FormFieldDescription: ""
1551 # Use "UserProfileFormMessage to configure the message you want
1552 # to display on the profile page.
1553 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1555 # Mimetypes of applications for which the view icon
1556 # would be enabled in a collection's show page.
1557 # It is sufficient to list only applications here.
1558 # No need to list text and image types.
1559 ApplicationMimetypesWithViewIcon:
1577 # The maximum number of bytes to load in the log viewer
1578 LogViewerMaxBytes: 1M
1580 # When anonymous_user_token is configured, show public projects page
1581 EnablePublicProjectsPage: true
1583 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1584 EnableGettingStartedPopup: false
1586 # Ask Arvados API server to compress its response payloads.
1587 APIResponseCompression: true
1589 # Timeouts for API requests.
1590 APIClientConnectTimeout: 2m
1591 APIClientReceiveTimeout: 5m
1593 # Maximum number of historic log records of a running job to fetch
1594 # and display in the Log tab, while subscribing to web sockets.
1595 RunningJobLogRecordsToFetch: 2000
1597 # In systems with many shared projects, loading of dashboard and topnav
1598 # can be slow due to collections indexing; use the following parameters
1599 # to suppress these properties
1600 ShowRecentCollectionsOnDashboard: true
1601 ShowUserNotifications: true
1603 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1604 # a link to the multi-site search page on a "home" Workbench site.
1607 # https://workbench.zzzzz.arvadosapi.com/collections/multisite
1610 # Should workbench allow management of local git repositories? Set to false if
1611 # the jobs api is disabled and there are no local git repositories.
1614 SiteName: Arvados Workbench
1615 ProfilingEnabled: false
1617 # This is related to obsolete Google OpenID 1.0 login
1618 # but some workbench stuff still expects it to be set.
1619 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1621 # Workbench2 configs
1622 FileViewersConfigURL: ""
1624 # Idle time after which the user's session will be auto closed.
1625 # This feature is disabled when set to zero.
1628 # Workbench welcome screen, this is HTML text that will be
1629 # incorporated directly onto the page.
1631 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1632 <h2>Please log in.</h2>
1634 <p>If you have never used Arvados Workbench before, logging in
1635 for the first time will automatically create a new
1638 <i>Arvados Workbench uses your information only for
1639 identification, and does not retrieve any other personal
1642 # Workbench screen displayed to inactive users. This is HTML
1643 # text that will be incorporated directly onto the page.
1645 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1646 <h3>Hi! You're logged in, but...</h3>
1647 <p>Your account is inactive.</p>
1648 <p>An administrator must activate your account before you can get
1651 # Connecting to Arvados shell VMs tends to be site-specific.
1652 # Put any special instructions here. This is HTML text that will
1653 # be incorporated directly onto the Workbench page.
1655 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1656 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1658 # Sample text if you are using a "switchyard" ssh proxy.
1659 # Replace "zzzzz" with your Cluster ID.
1661 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1664 # ServerAliveInterval 60
1665 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1668 # If you are using a switchyard ssh proxy, shell node hostnames
1669 # may require a special hostname suffix. In the sample ssh
1670 # configuration above, this would be ".zzzzz"
1671 # This is added to the hostname in the "command line" column
1672 # the Workbench "shell VMs" page.
1674 # If your shell nodes are directly accessible by users without a
1675 # proxy and have fully qualified host names, you should leave
1677 SSHHelpHostSuffix: ""
1679 # (Experimental) Restart services automatically when config file
1680 # changes are detected. Only supported by `arvados-server boot` in
1682 AutoReloadConfig: false