1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
7 var DefaultYAML = []byte(`# Copyright (C) The Arvados Authors. All rights reserved.
9 # SPDX-License-Identifier: AGPL-3.0
11 # Do not use this file for site configuration. Create
12 # /etc/arvados/config.yml instead.
14 # The order of precedence (highest to lowest):
15 # 1. Legacy component-specific config files (deprecated)
16 # 2. /etc/arvados/config.yml
17 # 3. config.default.yml
21 # Token used internally by Arvados components to authenticate to
22 # one another. Use a string of at least 50 random alphanumerics.
25 # Token to be included in all healthcheck requests. Disabled by default.
26 # Server expects request header of the format "Authorization: Bearer xxx"
31 # In each of the service sections below, the keys under
32 # InternalURLs are the endpoints where the service should be
33 # listening, and reachable from other hosts in the
37 # "http://host1.example:12345": {}
38 # "http://host2.example:12345": {}
41 InternalURLs: {SAMPLE: {}}
44 InternalURLs: {SAMPLE: {}}
47 InternalURLs: {SAMPLE: {}}
50 InternalURLs: {SAMPLE: {}}
53 InternalURLs: {SAMPLE: {}}
56 InternalURLs: {SAMPLE: {}}
59 InternalURLs: {SAMPLE: {}}
62 InternalURLs: {SAMPLE: {}}
65 InternalURLs: {SAMPLE: {}}
68 InternalURLs: {SAMPLE: {}}
69 # Base URL for Workbench inline preview. If blank, use
70 # WebDAVDownload instead, and disable inline preview.
71 # If both are empty, downloading collections from workbench
74 # It is important to properly configure the download service
75 # to migitate cross-site-scripting (XSS) attacks. A HTML page
76 # can be stored in collection. If an attacker causes a victim
77 # to visit that page through Workbench, it will be rendered by
78 # the browser. If all collections are served at the same
79 # domain, the browser will consider collections as coming from
80 # the same origin and having access to the same browsing data,
81 # enabling malicious Javascript on that page to access Arvados
82 # on behalf of the victim.
84 # This is mitigating by having separate domains for each
85 # collection, or limiting preview to circumstances where the
86 # collection is not accessed with the user's regular
89 # Serve preview links using uuid or pdh in subdomain
90 # (requires wildcard DNS and TLS certificate)
91 # https://*.collections.uuid_prefix.arvadosapi.com
93 # Serve preview links using uuid or pdh in main domain
94 # (requires wildcard DNS and TLS certificate)
95 # https://*--collections.uuid_prefix.arvadosapi.com
97 # Serve preview links by setting uuid or pdh in the path.
98 # This configuration only allows previews of public data or
99 # collection-sharing links, because these use the anonymous
100 # user token or the token is already embedded in the URL.
101 # Other data must be handled as downloads via WebDAVDownload:
102 # https://collections.uuid_prefix.arvadosapi.com
107 InternalURLs: {SAMPLE: {}}
108 # Base URL for download links. If blank, serve links to WebDAV
109 # with disposition=attachment query param. Unlike preview links,
110 # browsers do not render attachments, so there is no risk of XSS.
112 # If WebDAVDownload is blank, and WebDAV uses a
113 # single-origin form, then Workbench will show an error page
115 # Serve download links by setting uuid or pdh in the path:
116 # https://download.uuid_prefix.arvadosapi.com
123 # Rendezvous is normally empty/omitted. When changing the
124 # URL of a Keepstore service, Rendezvous should be set to
125 # the old URL (with trailing slash omitted) to preserve
126 # rendezvous ordering.
130 InternalURLs: {SAMPLE: {}}
133 InternalURLs: {SAMPLE: {}}
134 # ShellInABox service endpoint URL for a given VM. If empty, do not
135 # offer web shell logins.
137 # E.g., using a path-based proxy server to forward connections to shell hosts:
138 # https://webshell.uuid_prefix.arvadosapi.com
140 # E.g., using a name-based proxy server to forward connections to shell hosts:
141 # https://*.webshell.uuid_prefix.arvadosapi.com
144 InternalURLs: {SAMPLE: {}}
147 InternalURLs: {SAMPLE: {}}
150 InternalURLs: {SAMPLE: {}}
154 # max concurrent connections per arvados server daemon
157 # All parameters here are passed to the PG client library in a connection string;
158 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
166 # Limits for how long a client token created by regular users can be valid,
167 # and also is used as a default expiration policy when no expiration date is
169 # Default value zero means token expirations don't get clamped and no
170 # default expiration is set.
173 # Maximum size (in bytes) allowed for a single API request. This
174 # limit is published in the discovery document for use by clients.
175 # Note: You must separately configure the upstream web server or
176 # proxy to actually enforce the desired maximum request size on the
178 MaxRequestSize: 134217728
180 # Limit the number of bytes read from the database during an index
181 # request (by retrieving and returning fewer rows than would
182 # normally be returned in a single response).
183 # Note 1: This setting never reduces the number of returned rows to
184 # zero, no matter how big the first data row is.
185 # Note 2: Currently, this is only checked against a specific set of
186 # columns that tend to get large (collections.manifest_text,
187 # containers.mounts, workflows.definition). Other fields (e.g.,
188 # "properties" hashes) are not counted against this limit.
189 MaxIndexDatabaseRead: 134217728
191 # Maximum number of items to return when responding to a APIs that
192 # can return partial result sets using limit and offset parameters
193 # (e.g., *.index, groups.contents). If a request specifies a "limit"
194 # parameter higher than this value, this value is used instead.
195 MaxItemsPerResponse: 1000
197 # Maximum number of concurrent requests to accept in a single
198 # service process, or 0 for no limit.
199 MaxConcurrentRequests: 0
201 # Maximum number of 64MiB memory buffers per Keepstore server process, or
202 # 0 for no limit. When this limit is reached, up to
203 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
204 # buffers (like GET and PUT) will wait for buffer space to be released.
205 # Any HTTP requests beyond MaxConcurrentRequests will receive an
206 # immediate 503 response.
208 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
209 # * 1.1) fits comfortably in memory. On a host dedicated to running
210 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
211 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
212 # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
213 MaxKeepBlobBuffers: 128
215 # API methods to disable. Disabled methods are not listed in the
216 # discovery document, and respond 404 to all requests.
217 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
220 # Interval (seconds) between asynchronous permission view updates. Any
221 # permission-updating API called with the 'async' parameter schedules a an
222 # update on the permission view in the future, if not already scheduled.
223 AsyncPermissionsUpdateInterval: 20s
225 # Maximum number of concurrent outgoing requests to make while
226 # serving a single incoming multi-cluster (federated) request.
227 MaxRequestAmplification: 4
229 # Maximum wall clock time to spend handling an incoming request.
232 # Websocket will send a periodic empty event after 'SendTimeout'
233 # if there is no other activity to maintain the connection /
234 # detect dropped connections.
237 WebsocketClientEventQueue: 64
238 WebsocketServerEventQueue: 4
240 # Timeout on requests to internal Keep services.
241 KeepServiceRequestTimeout: 15s
243 # Vocabulary file path, local to the node running the controller.
244 # This JSON file should contain the description of what's allowed
245 # as object's metadata. Its format is described at:
246 # https://doc.arvados.org/admin/metadata-vocabulary.html
250 # Config parameters to automatically setup new users. If enabled,
251 # this users will be able to self-activate. Enable this if you want
252 # to run an open instance where anyone can create an account and use
253 # the system without requiring manual approval.
255 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
256 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
257 AutoSetupNewUsers: false
258 AutoSetupNewUsersWithVmUUID: ""
259 AutoSetupNewUsersWithRepository: false
260 AutoSetupUsernameBlacklist:
269 # When NewUsersAreActive is set to true, new users will be active
270 # immediately. This skips the "self-activate" step which enforces
271 # user agreements. Should only be enabled for development.
272 NewUsersAreActive: false
274 # Newly activated users (whether set up by an admin or via
275 # AutoSetupNewUsers) immediately become visible to other active
278 # On a multi-tenant cluster, where the intent is for users to be
279 # invisible to one another unless they have been added to the
280 # same group(s) via Workbench admin interface, change this to
282 ActivatedUsersAreVisibleToOthers: true
284 # The e-mail address of the user you would like to become marked as an admin
285 # user on their first login.
286 AutoAdminUserWithEmail: ""
288 # If AutoAdminFirstUser is set to true, the first user to log in when no
289 # other admin users exist will automatically become an admin user.
290 AutoAdminFirstUser: false
292 # Email address to notify whenever a user creates a profile for the
294 UserProfileNotificationAddress: ""
295 AdminNotifierEmailFrom: arvados@example.com
296 EmailSubjectPrefix: "[ARVADOS] "
297 UserNotifierEmailFrom: arvados@example.com
298 UserNotifierEmailBcc: {}
299 NewUserNotificationRecipients: {}
300 NewInactiveUserNotificationRecipients: {}
302 # Set AnonymousUserToken to enable anonymous user access. Populate this
303 # field with a long random string. Then run "bundle exec
304 # ./script/get_anonymous_user_token.rb" in the directory where your API
305 # server is running to record the token in the database.
306 AnonymousUserToken: ""
308 # If a new user has an alternate email address (local@domain)
309 # with the domain given here, its local part becomes the new
310 # user's default username. Otherwise, the user's primary email
312 PreferDomainForUsername: ""
315 <% if not @user.full_name.empty? -%>
316 <%= @user.full_name %>,
321 Your Arvados account has been set up. You can log in at
323 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
326 Your Arvados administrator.
328 # If RoleGroupsVisibleToAll is true, all role groups are visible
329 # to all active users.
331 # If false, users must be granted permission to role groups in
332 # order to see them. This is more appropriate for a multi-tenant
334 RoleGroupsVisibleToAll: true
337 # Time to keep audit logs, in seconds. (An audit log is a row added
338 # to the "logs" table in the PostgreSQL database each time an
339 # Arvados object is created, modified, or deleted.)
341 # Currently, websocket event notifications rely on audit logs, so
342 # this should not be set lower than 300 (5 minutes).
345 # Maximum number of log rows to delete in a single SQL transaction.
347 # If MaxDeleteBatch is 0, log entries will never be
348 # deleted by Arvados. Cleanup can be done by an external process
349 # without affecting any Arvados system processes, as long as very
350 # recent (<5 minutes old) logs are not deleted.
352 # 100000 is a reasonable batch size for most sites.
355 # Attributes to suppress in events and audit logs. Notably,
356 # specifying {"manifest_text": {}} here typically makes the database
357 # smaller and faster.
359 # Warning: Using any non-empty value here can have undesirable side
360 # effects for any client or component that relies on event logs.
361 # Use at your own risk.
362 UnloggedAttributes: {}
366 # Logging threshold: panic, fatal, error, warn, info, debug, or
370 # Logging format: json or text
373 # Maximum characters of (JSON-encoded) query parameters to include
374 # in each request log entry. When params exceed this size, they will
375 # be JSON-encoded, truncated to this size, and logged as
377 MaxRequestLogParamsSize: 2000
381 # Enable access controls for data stored in Keep. This should
382 # always be set to true on a production cluster.
385 # BlobSigningKey is a string of alphanumeric characters used to
386 # generate permission signatures for Keep locators. It must be
387 # identical to the permission key given to Keep. IMPORTANT: This
388 # is a site secret. It should be at least 50 characters.
390 # Modifying BlobSigningKey will invalidate all existing
391 # signatures, which can cause programs to fail (e.g., arv-put,
392 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
393 # when no such processes are running.
396 # Enable garbage collection of unreferenced blobs in Keep.
399 # Time to leave unreferenced blobs in "trashed" state before
400 # deleting them, or 0 to skip the "trashed" state entirely and
401 # delete unreferenced blobs.
403 # If you use any Amazon S3 buckets as storage volumes, this
404 # must be at least 24h to avoid occasional data loss.
405 BlobTrashLifetime: 336h
407 # How often to check for (and delete) trashed blocks whose
408 # BlobTrashLifetime has expired.
409 BlobTrashCheckInterval: 24h
411 # Maximum number of concurrent "trash blob" and "delete trashed
412 # blob" operations conducted by a single keepstore process. Each
413 # of these can be set to 0 to disable the respective operation.
415 # If BlobTrashLifetime is zero, "trash" and "delete trash"
416 # happen at once, so only the lower of these two values is used.
417 BlobTrashConcurrency: 4
418 BlobDeleteConcurrency: 4
420 # Maximum number of concurrent "create additional replica of
421 # existing blob" operations conducted by a single keepstore
423 BlobReplicateConcurrency: 4
425 # Default replication level for collections. This is used when a
426 # collection's replication_desired attribute is nil.
427 DefaultReplication: 2
429 # BlobSigningTTL determines the minimum lifetime of transient
430 # data, i.e., blocks that are not referenced by
431 # collections. Unreferenced blocks exist for two reasons:
433 # 1) A data block must be written to a disk/cloud backend device
434 # before a collection can be created/updated with a reference to
437 # 2) Deleting or updating a collection can remove the last
438 # remaining reference to a data block.
440 # If BlobSigningTTL is too short, long-running
441 # processes/containers will fail when they take too long (a)
442 # between writing blocks and writing collections that reference
443 # them, or (b) between reading collections and reading the
446 # If BlobSigningTTL is too long, data will still be stored long
447 # after the referring collections are deleted, and you will
448 # needlessly fill up disks or waste money on cloud storage.
450 # Modifying BlobSigningTTL invalidates existing signatures; see
451 # BlobSigningKey note above.
453 # The default is 2 weeks.
456 # When running keep-balance, this is the destination filename for
457 # the list of lost block hashes if there are any, one per line.
458 # Updated automically during each successful run.
459 BlobMissingReport: ""
461 # keep-balance operates periodically, i.e.: do a
462 # scan/balance operation, sleep, repeat.
464 # BalancePeriod determines the interval between start times of
465 # successive scan/balance operations. If a scan/balance operation
466 # takes longer than BalancePeriod, the next one will follow it
469 # If SIGUSR1 is received during an idle period between operations,
470 # the next operation will start immediately.
473 # Limits the number of collections retrieved by keep-balance per
474 # API transaction. If this is zero, page size is
475 # determined by the API server's own page size limits (see
476 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
477 BalanceCollectionBatch: 0
479 # The size of keep-balance's internal queue of
480 # collections. Higher values use more memory and improve throughput
481 # by allowing keep-balance to fetch the next page of collections
482 # while the current page is still being processed. If this is zero
483 # or omitted, pages are processed serially.
484 BalanceCollectionBuffers: 1000
486 # Maximum time for a rebalancing run. This ensures keep-balance
487 # eventually gives up and retries if, for example, a network
488 # error causes a hung connection that is never closed by the
489 # OS. It should be long enough that it doesn't interrupt a
490 # long-running balancing operation.
493 # Maximum number of replication_confirmed /
494 # storage_classes_confirmed updates to write to the database
495 # after a rebalancing run. When many updates are needed, this
496 # spreads them over a few runs rather than applying them all at
498 BalanceUpdateLimit: 100000
500 # Default lifetime for ephemeral collections: 2 weeks. This must not
501 # be less than BlobSigningTTL.
502 DefaultTrashLifetime: 336h
504 # Interval (seconds) between trash sweeps. During a trash sweep,
505 # collections are marked as trash if their trash_at time has
506 # arrived, and deleted if their delete_at time has arrived.
507 TrashSweepInterval: 60s
509 # If true, enable collection versioning.
510 # When a collection's preserve_version field is true or the current version
511 # is older than the amount of seconds defined on PreserveVersionIfIdle,
512 # a snapshot of the collection's previous state is created and linked to
513 # the current collection.
514 CollectionVersioning: true
516 # 0s = auto-create a new version on every update.
517 # -1s = never auto-create new versions.
518 # > 0s = auto-create a new version when older than the specified number of seconds.
519 PreserveVersionIfIdle: 10s
521 # If non-empty, allow project and collection names to contain
522 # the "/" character (slash/stroke/solidus), and replace "/" with
523 # the given string in the filesystem hierarchy presented by
524 # WebDAV. Example values are "%2f" and "{slash}". Names that
525 # contain the substitution string itself may result in confusing
526 # behavior, so a value like "_" is not recommended.
528 # If the default empty value is used, the server will reject
529 # requests to create or rename a collection when the new name
532 # If the value "/" is used, project and collection names
533 # containing "/" will be allowed, but they will not be
534 # accessible via WebDAV.
536 # Use of this feature is not recommended, if it can be avoided.
537 ForwardSlashNameSubstitution: ""
539 # Include "folder objects" in S3 ListObjects responses.
540 S3FolderObjects: true
542 # Managed collection properties. At creation time, if the client didn't
543 # provide the listed keys, they will be automatically populated following
544 # one of the following behaviors:
546 # * UUID of the user who owns the containing project.
547 # responsible_person_uuid: {Function: original_owner, Protected: true}
549 # * Default concrete value.
550 # foo_bar: {Value: baz, Protected: false}
552 # If Protected is true, only an admin user can modify its value.
554 SAMPLE: {Function: original_owner, Protected: true}
556 # In "trust all content" mode, Workbench will redirect download
557 # requests to WebDAV preview link, even in the cases when
558 # WebDAV would have to expose XSS vulnerabilities in order to
559 # handle the redirect (see discussion on Services.WebDAV).
561 # This setting has no effect in the recommended configuration, where the
562 # WebDAV service is configured to have a separate domain for every
563 # collection and XSS protection is provided by browsers' same-origin
566 # The default setting (false) is appropriate for a multi-user site.
567 TrustAllContent: false
569 # Cache parameters for WebDAV content serving:
571 # Time to cache manifests, permission checks, and sessions.
574 # Time to cache collection state.
577 # Block cache entries. Each block consumes up to 64 MiB RAM.
580 # Collection cache entries.
581 MaxCollectionEntries: 1000
583 # Approximate memory limit (in bytes) for collection cache.
584 MaxCollectionBytes: 100000000
586 # UUID cache entries.
589 # Persistent sessions.
592 # Selectively set permissions for regular users and admins to
593 # download or upload data files using the upload/download
594 # features for Workbench, WebDAV and S3 API support.
603 # Selectively set permissions for regular users and admins to be
604 # able to download or upload blocks using arv-put and
605 # arv-get from outside the cluster.
614 # Post upload / download events to the API server logs table, so
615 # that they can be included in the arv-user-activity report.
616 # You can disable this if you find that it is creating excess
617 # load on the API server and you don't need it.
618 WebDAVLogEvents: true
621 # One of the following mechanisms (Google, PAM, LDAP, or
622 # LoginCluster) should be enabled; see
623 # https://doc.arvados.org/install/setup-login.html
626 # Authenticate with Google.
629 # Use the Google Cloud console to enable the People API (APIs
630 # and Services > Enable APIs and services > Google People API
631 # > Enable), generate a Client ID and secret (APIs and
632 # Services > Credentials > Create credentials > OAuth client
633 # ID > Web application) and add your controller's /login URL
634 # (e.g., "https://zzzzz.example.com/login") as an authorized
639 # Allow users to log in to existing accounts using any verified
640 # email address listed by their Google account. If true, the
641 # Google People API must be enabled in order for Google login to
642 # work. If false, only the primary email address will be used.
643 AlternateEmailAddresses: true
645 # Send additional parameters with authentication requests. See
646 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
647 # for a list of supported parameters.
648 AuthenticationRequestParameters:
649 # Show the "choose which Google account" page, even if the
650 # client is currently logged in to exactly one Google
652 prompt: select_account
657 # Authenticate with an OpenID Connect provider.
660 # Issuer URL, e.g., "https://login.example.com".
662 # This must be exactly equal to the URL returned by the issuer
663 # itself in its config response ("isser" key). If the
664 # configured value is "https://example" and the provider
665 # returns "https://example:443" or "https://example/" then
666 # login will fail, even though those URLs are equivalent
670 # Your client ID and client secret (supplied by the provider).
674 # OpenID claim field containing the user's email
675 # address. Normally "email"; see
676 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
679 # OpenID claim field containing the email verification
680 # flag. Normally "email_verified". To accept every returned
681 # email address without checking a "verified" field at all,
682 # use the empty string "".
683 EmailVerifiedClaim: "email_verified"
685 # OpenID claim field containing the user's preferred
686 # username. If empty, use the mailbox part of the user's email
690 # Send additional parameters with authentication requests,
691 # like {display: page, prompt: consent}. See
692 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
693 # and refer to your provider's documentation for supported
695 AuthenticationRequestParameters:
698 # Accept an OIDC access token as an API token if the OIDC
699 # provider's UserInfo endpoint accepts it.
701 # AcceptAccessTokenScope should also be used when enabling
703 AcceptAccessToken: false
705 # Before accepting an OIDC access token as an API token, first
706 # check that it is a JWT whose "scope" value includes this
707 # value. Example: "https://zzzzz.example.com/" (your Arvados
710 # If this value is empty and AcceptAccessToken is true, all
711 # access tokens will be accepted regardless of scope,
712 # including non-JWT tokens. This is not recommended.
713 AcceptAccessTokenScope: ""
716 # Use PAM to authenticate users.
719 # PAM service name. PAM will apply the policy in the
720 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
721 # there is none, the default "other" config.
724 # Domain name (e.g., "example.com") to use to construct the
725 # user's email address if PAM authentication returns a
726 # username with no "@". If empty, use the PAM username as the
727 # user's email address, whether or not it contains "@".
729 # Note that the email address is used as the primary key for
730 # user records when logging in. Therefore, if you change
731 # PAMDefaultEmailDomain after the initial installation, you
732 # should also update existing user records to reflect the new
733 # domain. Otherwise, next time those users log in, they will
734 # be given new accounts instead of accessing their existing
736 DefaultEmailDomain: ""
739 # Use an LDAP service to authenticate users.
742 # Server URL, like "ldap://ldapserver.example.com:389" or
743 # "ldaps://ldapserver.example.com:636".
744 URL: "ldap://ldap:389"
746 # Use StartTLS upon connecting to the server.
749 # Skip TLS certificate name verification.
752 # Strip the @domain part if a user supplies an email-style
753 # username with this domain. If "*", strip any user-provided
754 # domain. If "", never strip the domain part. Example:
758 # If, after applying StripDomain, the username contains no "@"
759 # character, append this domain to form an email-style
760 # username. Example: "example.com"
763 # The LDAP attribute to filter on when looking up a username
764 # (after applying StripDomain and AppendDomain).
767 # Bind with this username (DN or UPN) and password when
768 # looking up the user record.
770 # Example user: "cn=admin,dc=example,dc=com"
772 SearchBindPassword: ""
774 # Directory base for username lookup. Example:
775 # "ou=Users,dc=example,dc=com"
778 # Additional filters to apply when looking up users' LDAP
779 # entries. This can be used to restrict access to a subset of
780 # LDAP users, or to disambiguate users from other directory
781 # entries that have the SearchAttribute present.
783 # Special characters in assertion values must be escaped (see
786 # Example: "(objectClass=person)"
789 # LDAP attribute to use as the user's email address.
791 # Important: This must not be an attribute whose value can be
792 # edited in the directory by the users themselves. Otherwise,
793 # users can take over other users' Arvados accounts trivially
794 # (email address is the primary key for Arvados accounts.)
797 # LDAP attribute to use as the preferred Arvados username. If
798 # no value is found (or this config is empty) the username
799 # originally supplied by the user will be used.
800 UsernameAttribute: uid
803 # Authenticate users listed here in the config file. This
804 # feature is intended to be used in test environments, and
805 # should not be used in production.
809 Email: alice@example.com
812 # The cluster ID to delegate the user database. When set,
813 # logins on this cluster will be redirected to the login cluster
814 # (login cluster must appear in RemoteClusters with Proxy: true)
817 # How long a cached token belonging to a remote cluster will
818 # remain valid before it needs to be revalidated.
819 RemoteTokenRefresh: 5m
821 # How long a client token created from a login flow will be valid without
822 # asking the user to re-login. Example values: 60m, 8h.
823 # Default value zero means tokens don't have expiration.
826 # If true (default) tokens issued through login are allowed to create
828 # If false, tokens issued through login are not allowed to
829 # viewing/creating other tokens. New tokens can only be created
830 # by going through login again.
831 IssueTrustedTokens: true
833 # When the token is returned to a client, the token itself may
834 # be restricted from viewing/creating other tokens based on whether
835 # the client is "trusted" or not. The local Workbench1 and
836 # Workbench2 are trusted by default, but if this is a
837 # LoginCluster, you probably want to include the other Workbench
838 # instances in the federation in this list.
841 "https://workbench.federate1.example": {}
842 "https://workbench.federate2.example": {}
845 # Path to git or gitolite-shell executable. Each authenticated
846 # request will execute this program with the single argument "http-backend"
847 GitCommand: /usr/bin/git
849 # Path to Gitolite's home directory. If a non-empty path is given,
850 # the CGI environment will be set up to support the use of
851 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
852 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
853 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
856 # Git repositories must be readable by api server, or you won't be
857 # able to submit crunch jobs. To pass the test suites, put a clone
858 # of the arvados tree in {git_repositories_dir}/arvados.git or
859 # {git_repositories_dir}/arvados/.git
860 Repositories: /var/lib/arvados/git/repositories
868 # List of supported Docker Registry image formats that compute nodes
869 # are able to use. ` + "`" + `arv keep docker` + "`" + ` will error out if a user tries
870 # to store an image with an unsupported format. Use an empty array
871 # to skip the compatibility check (and display a warning message to
874 # Example for sites running docker < 1.10: {"v1": {}}
875 # Example for sites running docker >= 1.10: {"v2": {}}
876 # Example for disabling check: {}
877 SupportedDockerImageFormats:
881 # Include details about job reuse decisions in the server log. This
882 # causes additional database queries to run, so it should not be
883 # enabled unless you expect to examine the resulting logs for
884 # troubleshooting purposes.
885 LogReuseDecisions: false
887 # Default value for keep_cache_ram of a container's runtime_constraints.
888 DefaultKeepCacheRAM: 268435456
890 # Number of times a container can be unlocked before being
891 # automatically cancelled.
892 MaxDispatchAttempts: 5
894 # Default value for container_count_max for container requests. This is the
895 # number of times Arvados will create a new container to satisfy a container
896 # request. If a container is cancelled it will retry a new container if
897 # container_count < container_count_max on any container requests associated
898 # with the cancelled container.
901 # The maximum number of compute nodes that can be in use simultaneously
902 # If this limit is reduced, any existing nodes with slot number >= new limit
903 # will not be counted against the new limit. In other words, the new limit
904 # won't be strictly enforced until those nodes with higher slot numbers
908 # Schedule all child containers on preemptible instances (e.g. AWS
909 # Spot Instances) even if not requested by the submitter.
911 # If false, containers are scheduled on preemptible instances
912 # only when requested by the submitter.
914 # Note that arvados-cwl-runner does not currently offer a
915 # feature to request preemptible instances, so this value
916 # effectively acts as a cluster-wide decision about whether to
917 # use preemptible instances.
919 # This flag is ignored if no preemptible instance types are
920 # configured, and has no effect on top-level containers.
921 AlwaysUsePreemptibleInstances: true
923 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
924 # cloud dispatcher for executing containers on worker VMs.
925 # Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
926 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
927 DispatchPrivateKey: ""
929 # Maximum time to wait for workers to come up before abandoning
930 # stale locks from a previous dispatch process.
933 # The crunch-run command used to start a container on a worker node.
935 # When dispatching to cloud VMs, this is used only if
936 # DeployRunnerBinary in the CloudVMs section is set to the empty
938 CrunchRunCommand: "crunch-run"
940 # Extra arguments to add to crunch-run invocation
941 # Example: ["--cgroup-parent-subsystem=memory"]
942 CrunchRunArgumentsList: []
944 # Extra RAM to reserve on the node, in addition to
945 # the amount specified in the container's RuntimeConstraints
946 ReserveExtraRAM: 256MiB
948 # Minimum time between two attempts to run the same container
951 # Container runtime: "docker" (default) or "singularity"
952 RuntimeEngine: docker
954 # When running a container, run a dedicated keepstore process,
955 # using the specified number of 64 MiB memory buffers per
956 # allocated CPU core (VCPUs in the container's runtime
957 # constraints). The dedicated keepstore handles I/O for
958 # collections mounted in the container, as well as saving
961 # A zero value disables this feature.
963 # In order for this feature to be activated, no volume may use
964 # AccessViaHosts, and each volume must have Replication higher
965 # than Collections.DefaultReplication. If these requirements are
966 # not satisfied, the feature is disabled automatically
967 # regardless of the value given here.
969 # Note that when this configuration is enabled, the entire
970 # cluster configuration file, including the system root token,
971 # is copied to the worker node and held in memory for the
972 # duration of the container.
973 LocalKeepBlobBuffersPerVCPU: 1
975 # When running a dedicated keepstore process for a container
976 # (see LocalKeepBlobBuffersPerVCPU), write keepstore log
977 # messages to keepstore.txt in the container's log collection.
979 # These log messages can reveal some volume configuration
980 # details, error messages from the cloud storage provider, etc.,
981 # which are not otherwise visible to users.
984 # * "none" -- no keepstore.txt file
985 # * "all" -- all logs, including request and response lines
986 # * "errors" -- all logs except "response" logs with 2xx
987 # response codes and "request" logs
988 LocalKeepLogsToContainerLog: none
991 # When you run the db:delete_old_container_logs task, it will find
992 # containers that have been finished for at least this many seconds,
993 # and delete their stdout, stderr, arv-mount, crunch-run, and
994 # crunchstat logs from the logs table.
997 # These two settings control how frequently log events are flushed to the
998 # database. Log lines are buffered until either crunch_log_bytes_per_event
999 # has been reached or crunch_log_seconds_between_events has elapsed since
1001 LogBytesPerEvent: 4096
1002 LogSecondsBetweenEvents: 5s
1004 # The sample period for throttling logs.
1005 LogThrottlePeriod: 60s
1007 # Maximum number of bytes that job can log over crunch_log_throttle_period
1008 # before being silenced until the end of the period.
1009 LogThrottleBytes: 65536
1011 # Maximum number of lines that job can log over crunch_log_throttle_period
1012 # before being silenced until the end of the period.
1013 LogThrottleLines: 1024
1015 # Maximum bytes that may be logged by a single job. Log bytes that are
1016 # silenced by throttling are not counted against this total.
1017 LimitLogBytesPerJob: 67108864
1019 LogPartialLineThrottlePeriod: 5s
1021 # Container logs are written to Keep and saved in a
1022 # collection, which is updated periodically while the
1023 # container runs. This value sets the interval between
1024 # collection updates.
1025 LogUpdatePeriod: 30m
1027 # The log collection is also updated when the specified amount of
1028 # log data (given in bytes) is produced in less than one update
1030 LogUpdateSize: 32MiB
1033 # An admin user can use "arvados-client shell" to start an
1034 # interactive shell (with any user ID) in any running
1038 # Any user can use "arvados-client shell" to start an
1039 # interactive shell (with any user ID) in any running
1040 # container that they started, provided it isn't also
1041 # associated with a different user's container request.
1043 # Interactive sessions make it easy to alter the container's
1044 # runtime environment in ways that aren't recorded or
1045 # reproducible. Consider the implications for automatic
1046 # container reuse before enabling and using this feature. In
1047 # particular, note that starting an interactive session does
1048 # not disqualify a container from being reused by a different
1049 # user/workflow in the future.
1054 SbatchArgumentsList: []
1055 SbatchEnvironmentVariables:
1058 # Path to dns server configuration directory
1059 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
1060 # files or touch restart.txt (see below).
1061 DNSServerConfDir: ""
1063 # Template file for the dns server host snippets. See
1064 # unbound.template in this directory for an example. If false, do
1065 # not write any config files.
1066 DNSServerConfTemplate: ""
1068 # String to write to {dns_server_conf_dir}/restart.txt (with a
1069 # trailing newline) after updating local data. If false, do not
1070 # open or write the restart.txt file.
1071 DNSServerReloadCommand: ""
1073 # Command to run after each DNS update. Template variables will be
1074 # substituted; see the "unbound" example below. If false, do not run
1076 DNSServerUpdateCommand: ""
1078 ComputeNodeDomain: ""
1079 ComputeNodeNameservers:
1083 # Hostname to assign to a compute node when it sends a "ping" and the
1084 # hostname in its Node record is nil.
1085 # During bootstrapping, the "ping" script is expected to notice the
1086 # hostname given in the ping response, and update its unix hostname
1088 # If false, leave the hostname alone (this is appropriate if your compute
1089 # nodes' hostnames are already assigned by some other mechanism).
1091 # One way or another, the hostnames of your node records should agree
1092 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1094 # Example for compute0000, compute0001, ....:
1095 # assign_node_hostname: compute%<slot_number>04d
1096 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1097 AssignNodeHostname: "compute%<slot_number>d"
1100 # Arguments to bsub when submitting Arvados containers as LSF jobs.
1102 # Template variables starting with % will be substituted as follows:
1105 # %C number of VCPUs
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 # Use sudo to switch to this user account when submitting LSF
1121 # This account must exist on the hosts where LSF jobs run
1122 # ("execution hosts"), as well as on the host where the
1123 # Arvados LSF dispatcher runs ("submission host").
1124 BsubSudoUser: "crunch"
1127 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
1129 # Note: this only enables read-only access, creating new
1130 # legacy jobs and pipelines is not supported.
1132 # 'auto' -- (default) enable the Jobs API only if it has been used before
1133 # (i.e., there are job records in the database)
1134 # 'true' -- enable the Jobs API despite lack of existing records.
1135 # 'false' -- disable the Jobs API despite presence of existing records.
1138 # Git repositories must be readable by api server, or you won't be
1139 # able to submit crunch jobs. To pass the test suites, put a clone
1140 # of the arvados tree in {git_repositories_dir}/arvados.git or
1141 # {git_repositories_dir}/arvados/.git
1142 GitInternalDir: /var/lib/arvados/internal.git
1145 # Enable the cloud scheduler.
1148 # Name/number of port where workers' SSH services listen.
1151 # Interval between queue polls.
1154 # Shell command to execute on each worker to determine whether
1155 # the worker is booted and ready to run containers. It should
1156 # exit zero if the worker is ready.
1157 BootProbeCommand: "systemctl is-system-running"
1159 # Minimum interval between consecutive probes to a single
1163 # Maximum probes per second, across all workers in a pool.
1164 MaxProbesPerSecond: 10
1166 # Time before repeating SIGTERM when killing a container.
1169 # Time to give up on a process (most likely arv-mount) that
1170 # still holds a container lockfile after its main supervisor
1171 # process has exited, and declare the instance broken.
1172 TimeoutStaleRunLock: 5s
1174 # Time to give up on SIGTERM and write off the worker.
1177 # Maximum create/destroy-instance operations per second (0 =
1179 MaxCloudOpsPerSecond: 10
1181 # Maximum concurrent instance creation operations (0 = unlimited).
1183 # MaxConcurrentInstanceCreateOps limits the number of instance creation
1184 # requests that can be in flight at any one time, whereas
1185 # MaxCloudOpsPerSecond limits the number of create/destroy operations
1186 # that can be started per second.
1188 # Because the API for instance creation on Azure is synchronous, it is
1189 # recommended to increase MaxConcurrentInstanceCreateOps when running
1190 # on Azure. When using managed images, a value of 20 would be
1191 # appropriate. When using Azure Shared Image Galeries, it could be set
1192 # higher. For more information, see
1193 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
1195 # MaxConcurrentInstanceCreateOps can be increased for other cloud
1196 # providers too, if desired.
1197 MaxConcurrentInstanceCreateOps: 1
1199 # Interval between cloud provider syncs/updates ("list all
1203 # Time to leave an idle worker running (in case new containers
1204 # appear in the queue that it can run) before shutting it
1208 # Time to wait for a new worker to boot (i.e., pass
1209 # BootProbeCommand) before giving up and shutting it down.
1212 # Maximum time a worker can stay alive with no successful
1213 # probes before being automatically shut down.
1216 # Time after shutting down a worker to retry the
1217 # shutdown/destroy operation.
1218 TimeoutShutdown: 10s
1220 # Worker VM image ID.
1221 # (aws) AMI identifier
1222 # (azure) managed disks: the name of the managed disk image
1223 # (azure) shared image gallery: the name of the image definition. Also
1224 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1225 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1226 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1229 # An executable file (located on the dispatcher host) to be
1230 # copied to cloud instances at runtime and used as the
1231 # container runner/supervisor. The default value is the
1232 # dispatcher program itself.
1234 # Use the empty string to disable this step: nothing will be
1235 # copied, and cloud instances are assumed to have a suitable
1236 # version of crunch-run installed; see CrunchRunCommand above.
1237 DeployRunnerBinary: "/proc/self/exe"
1239 # Tags to add on all resources (VMs, NICs, disks) created by
1240 # the container dispatcher. (Arvados's own tags --
1241 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1246 # Prefix for predefined tags used by Arvados (InstanceSetID,
1247 # InstanceType, InstanceSecret, IdleBehavior). With the
1248 # default value "Arvados", tags are "ArvadosInstanceSetID",
1249 # "ArvadosInstanceSecret", etc.
1251 # This should only be changed while no cloud resources are in
1252 # use and the cloud dispatcher is not running. Otherwise,
1253 # VMs/resources that were added using the old tag prefix will
1254 # need to be detected and cleaned up manually.
1255 TagKeyPrefix: Arvados
1257 # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1260 # Cloud-specific driver parameters.
1263 # (ec2) Credentials. Omit or leave blank if using IAM role.
1267 # (ec2) Instance configuration.
1273 AdminUsername: debian
1275 # (azure) Credentials.
1281 # (azure) Instance configuration.
1282 CloudEnvironment: AzurePublicCloud
1285 # (azure) The resource group where the VM and virtual NIC will be
1289 # (azure) The resource group of the Network to use for the virtual
1290 # NIC (if different from ResourceGroup)
1291 NetworkResourceGroup: ""
1295 # (azure) managed disks: The resource group where the managed disk
1296 # image can be found (if different from ResourceGroup).
1297 ImageResourceGroup: ""
1299 # (azure) shared image gallery: the name of the gallery
1300 SharedImageGalleryName: ""
1301 # (azure) shared image gallery: the version of the image definition
1302 SharedImageGalleryImageVersion: ""
1304 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1308 # (azure) How long to wait before deleting VHD and NIC
1309 # objects that are no longer being used.
1310 DeleteDanglingResourcesAfter: 20s
1312 # Account (that already exists in the VM image) that will be
1313 # set up with an ssh authorized key to allow the compute
1314 # dispatcher to connect.
1315 AdminUsername: arvados
1319 # Use the instance type name as the key (in place of "SAMPLE" in
1320 # this sample entry).
1322 # Cloud provider's instance type. Defaults to the configured type name.
1326 IncludedScratch: 16GB
1333 # If you use multiple storage classes, specify them here, using
1334 # the storage class name as the key (in place of "SAMPLE" in
1335 # this sample entry).
1337 # Further info/examples:
1338 # https://doc.arvados.org/admin/storage-classes.html
1341 # Priority determines the order volumes should be searched
1342 # when reading data, in cases where a keepstore server has
1343 # access to multiple volumes with different storage classes.
1346 # Default determines which storage class(es) should be used
1347 # when a user/client writes data or saves a new collection
1348 # without specifying storage classes.
1350 # If any StorageClasses are configured, at least one of them
1351 # must have Default: true.
1356 # AccessViaHosts specifies which keepstore processes can read
1357 # and write data on the volume.
1359 # For a local filesystem, AccessViaHosts has one entry,
1360 # indicating which server the filesystem is located on.
1362 # For a network-attached backend accessible by all keepstore
1363 # servers, like a cloud storage bucket or an NFS mount,
1364 # AccessViaHosts can be empty/omitted.
1366 # Further info/examples:
1367 # https://doc.arvados.org/install/configure-fs-storage.html
1368 # https://doc.arvados.org/install/configure-s3-object-storage.html
1369 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1373 "http://host1.example:25107": {}
1377 # If you have configured storage classes (see StorageClasses
1378 # section above), add an entry here for each storage class
1379 # satisfied by this volume.
1383 # for s3 driver -- see
1384 # https://doc.arvados.org/install/configure-s3-object-storage.html
1387 SecretAccessKey: aaaaa
1391 LocationConstraint: false
1398 # Use aws-s3-go (v2) instead of goamz
1399 UseAWSS3v2Driver: false
1401 # For S3 driver, potentially unsafe tuning parameter,
1402 # intentionally excluded from main documentation.
1404 # Enable deletion (garbage collection) even when the
1405 # configured BlobTrashLifetime is zero. WARNING: eventual
1406 # consistency may result in race conditions that can cause
1407 # data loss. Do not enable this unless you understand and
1411 # for azure driver -- see
1412 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1413 StorageAccountName: aaaaa
1414 StorageAccountKey: aaaaa
1415 StorageBaseURL: core.windows.net
1416 ContainerName: aaaaa
1418 ListBlobsRetryDelay: 10s
1419 ListBlobsMaxAttempts: 10
1421 WriteRaceInterval: 15s
1422 WriteRacePollTime: 1s
1424 # for local directory driver -- see
1425 # https://doc.arvados.org/install/configure-fs-storage.html
1426 Root: /var/lib/arvados/keep-data
1428 # For local directory driver, potentially confusing tuning
1429 # parameter, intentionally excluded from main documentation.
1431 # When true, read and write operations (for whole 64MiB
1432 # blocks) on an individual volume will queued and issued
1433 # serially. When false, read and write operations will be
1434 # issued concurrently.
1436 # May possibly improve throughput if you have physical spinning disks
1437 # and experience contention when there are multiple requests
1438 # to the same volume.
1440 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1441 # should leave this alone.
1447 SendUserSetupNotificationEmail: true
1449 # Bug/issue report notification to and from addresses
1450 IssueReporterEmailFrom: "arvados@example.com"
1451 IssueReporterEmailTo: "arvados@example.com"
1452 SupportEmailAddress: "arvados@example.com"
1454 # Generic issue email from
1455 EmailFrom: "arvados@example.com"
1462 ActivateUsers: false
1464 # API endpoint host or host:port; default is {id}.arvadosapi.com
1465 Host: sample.arvadosapi.com
1467 # Perform a proxy request when a local client requests an
1468 # object belonging to this remote.
1471 # Default "https". Can be set to "http" for testing.
1474 # Disable TLS verify. Can be set to true for testing.
1477 # When users present tokens issued by this remote cluster, and
1478 # their accounts are active on the remote cluster, activate
1479 # them on this cluster too.
1480 ActivateUsers: false
1483 # Workbench1 configs
1485 ActivationContactLink: mailto:info@arvados.org
1486 ArvadosDocsite: https://doc.arvados.org
1487 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1488 ShowUserAgreementInline: false
1491 # Scratch directory used by the remote repository browsing
1492 # feature. If it doesn't exist, it (and any missing parents) will be
1493 # created using mkdir_p.
1494 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1496 # Below is a sample setting of user_profile_form_fields config parameter.
1497 # This configuration parameter should be set to either false (to disable) or
1498 # to a map as shown below.
1499 # Configure the map of input fields to be displayed in the profile page
1500 # using the attribute "key" for each of the input fields.
1501 # This sample shows configuration with one required and one optional form fields.
1502 # For each of these input fields:
1503 # You can specify "Type" as "text" or "select".
1504 # List the "Options" to be displayed for each of the "select" menu.
1505 # Set "Required" as "true" for any of these fields to make them required.
1506 # If any of the required fields are missing in the user's profile, the user will be
1507 # redirected to the profile page before they can access any Workbench features.
1508 UserProfileFormFields:
1511 FormFieldTitle: Best color
1512 FormFieldDescription: your favorite color
1521 # exampleTextValue: # key that will be set in properties
1523 # FormFieldTitle: ""
1524 # FormFieldDescription: ""
1527 # exampleOptionsValue:
1529 # FormFieldTitle: ""
1530 # FormFieldDescription: ""
1538 # Use "UserProfileFormMessage to configure the message you want
1539 # to display on the profile page.
1540 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1542 # Mimetypes of applications for which the view icon
1543 # would be enabled in a collection's show page.
1544 # It is sufficient to list only applications here.
1545 # No need to list text and image types.
1546 ApplicationMimetypesWithViewIcon:
1564 # The maximum number of bytes to load in the log viewer
1565 LogViewerMaxBytes: 1M
1567 # When anonymous_user_token is configured, show public projects page
1568 EnablePublicProjectsPage: true
1570 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1571 EnableGettingStartedPopup: false
1573 # Ask Arvados API server to compress its response payloads.
1574 APIResponseCompression: true
1576 # Timeouts for API requests.
1577 APIClientConnectTimeout: 2m
1578 APIClientReceiveTimeout: 5m
1580 # Maximum number of historic log records of a running job to fetch
1581 # and display in the Log tab, while subscribing to web sockets.
1582 RunningJobLogRecordsToFetch: 2000
1584 # In systems with many shared projects, loading of dashboard and topnav
1585 # can be slow due to collections indexing; use the following parameters
1586 # to suppress these properties
1587 ShowRecentCollectionsOnDashboard: true
1588 ShowUserNotifications: true
1590 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1591 # a link to the multi-site search page on a "home" Workbench site.
1594 # https://workbench.zzzzz.arvadosapi.com/collections/multisite
1597 # Should workbench allow management of local git repositories? Set to false if
1598 # the jobs api is disabled and there are no local git repositories.
1601 SiteName: Arvados Workbench
1602 ProfilingEnabled: false
1604 # This is related to obsolete Google OpenID 1.0 login
1605 # but some workbench stuff still expects it to be set.
1606 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1608 # Workbench2 configs
1609 FileViewersConfigURL: ""
1611 # Idle time after which the user's session will be auto closed.
1612 # This feature is disabled when set to zero.
1615 # Workbench welcome screen, this is HTML text that will be
1616 # incorporated directly onto the page.
1618 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1619 <h2>Please log in.</h2>
1621 <p>If you have never used Arvados Workbench before, logging in
1622 for the first time will automatically create a new
1625 <i>Arvados Workbench uses your information only for
1626 identification, and does not retrieve any other personal
1629 # Workbench screen displayed to inactive users. This is HTML
1630 # text that will be incorporated directly onto the page.
1632 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1633 <h3>Hi! You're logged in, but...</h3>
1634 <p>Your account is inactive.</p>
1635 <p>An administrator must activate your account before you can get
1638 # Connecting to Arvados shell VMs tends to be site-specific.
1639 # Put any special instructions here. This is HTML text that will
1640 # be incorporated directly onto the Workbench page.
1642 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1643 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1645 # Sample text if you are using a "switchyard" ssh proxy.
1646 # Replace "zzzzz" with your Cluster ID.
1648 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1651 # ServerAliveInterval 60
1652 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1655 # If you are using a switchyard ssh proxy, shell node hostnames
1656 # may require a special hostname suffix. In the sample ssh
1657 # configuration above, this would be ".zzzzz"
1658 # This is added to the hostname in the "command line" column
1659 # the Workbench "shell VMs" page.
1661 # If your shell nodes are directly accessible by users without a
1662 # proxy and have fully qualified host names, you should leave
1664 SSHHelpHostSuffix: ""
1666 # (Experimental) Restart services automatically when config file
1667 # changes are detected. Only supported by ` + "`" + `arvados-server boot` + "`" + ` in
1669 AutoReloadConfig: false