1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
5 # Do not use this file for site configuration. Create
6 # /etc/arvados/config.yml instead.
8 # The order of precedence (highest to lowest):
9 # 1. Legacy component-specific config files (deprecated)
10 # 2. /etc/arvados/config.yml
11 # 3. config.default.yml
15 # Token used internally by Arvados components to authenticate to
16 # one another. Use a string of at least 50 random alphanumerics.
19 # Token to be included in all healthcheck requests. Disabled by default.
20 # Server expects request header of the format "Authorization: Bearer xxx"
25 # Each of the service sections below specifies InternalURLs
26 # (each with optional ListenURL) and ExternalURL.
28 # InternalURLs specify how other Arvados service processes will
29 # connect to the service. Typically these use internal hostnames
30 # and high port numbers. Example:
33 # "http://host1.internal.example:12345": {}
34 # "http://host2.internal.example:12345": {}
36 # ListenURL specifies the address and port the service process's
37 # HTTP server should listen on, if different from the
38 # InternalURL itself. Example, using an intermediate TLS proxy:
41 # "https://host1.internal.example":
42 # ListenURL: "http://10.0.0.7:12345"
44 # When there are multiple InternalURLs configured, the service
45 # process will try listening on each InternalURLs (using
46 # ListenURL if provided) until one works. If you use a ListenURL
47 # like "0.0.0.0" which can be bound on any machine, use an
48 # environment variable
49 # ARVADOS_SERVICE_INTERNAL_URL=http://host1.internal.example to
50 # control which entry to use.
52 # ExternalURL specifies how applications/clients will connect to
53 # the service, regardless of whether they are inside or outside
54 # the cluster. Example:
56 # ExternalURL: "https://keep.zzzzz.example.com/"
58 # To avoid routing internal traffic through external networks,
59 # use split-horizon DNS for ExternalURL host names: inside the
60 # cluster's private network "host.zzzzz.example.com" resolves to
61 # the host's private IP address, while outside the cluster
62 # "host.zzzzz.example.com" resolves to the host's public IP
63 # address (or its external gateway or load balancer).
66 InternalURLs: {SAMPLE: {ListenURL: ""}}
69 InternalURLs: {SAMPLE: {ListenURL: ""}}
72 InternalURLs: {SAMPLE: {ListenURL: ""}}
75 InternalURLs: {SAMPLE: {ListenURL: ""}}
78 InternalURLs: {SAMPLE: {ListenURL: ""}}
81 InternalURLs: {SAMPLE: {ListenURL: ""}}
84 InternalURLs: {SAMPLE: {ListenURL: ""}}
87 InternalURLs: {SAMPLE: {ListenURL: ""}}
90 InternalURLs: {SAMPLE: {ListenURL: ""}}
93 InternalURLs: {SAMPLE: {ListenURL: ""}}
96 InternalURLs: {SAMPLE: {ListenURL: ""}}
97 # Base URL for Workbench inline preview. If blank, use
98 # WebDAVDownload instead, and disable inline preview.
99 # If both are empty, downloading collections from workbench
100 # will be impossible.
102 # It is important to properly configure the download service
103 # to migitate cross-site-scripting (XSS) attacks. A HTML page
104 # can be stored in collection. If an attacker causes a victim
105 # to visit that page through Workbench, it will be rendered by
106 # the browser. If all collections are served at the same
107 # domain, the browser will consider collections as coming from
108 # the same origin and having access to the same browsing data,
109 # enabling malicious Javascript on that page to access Arvados
110 # on behalf of the victim.
112 # This is mitigating by having separate domains for each
113 # collection, or limiting preview to circumstances where the
114 # collection is not accessed with the user's regular
117 # Serve preview links using uuid or pdh in subdomain
118 # (requires wildcard DNS and TLS certificate)
119 # https://*.collections.uuid_prefix.arvadosapi.com
121 # Serve preview links using uuid or pdh in main domain
122 # (requires wildcard DNS and TLS certificate)
123 # https://*--collections.uuid_prefix.arvadosapi.com
125 # Serve preview links by setting uuid or pdh in the path.
126 # This configuration only allows previews of public data or
127 # collection-sharing links, because these use the anonymous
128 # user token or the token is already embedded in the URL.
129 # Other data must be handled as downloads via WebDAVDownload:
130 # https://collections.uuid_prefix.arvadosapi.com
135 InternalURLs: {SAMPLE: {ListenURL: ""}}
136 # Base URL for download links. If blank, serve links to WebDAV
137 # with disposition=attachment query param. Unlike preview links,
138 # browsers do not render attachments, so there is no risk of XSS.
140 # If WebDAVDownload is blank, and WebDAV uses a
141 # single-origin form, then Workbench will show an error page
143 # Serve download links by setting uuid or pdh in the path:
144 # https://download.uuid_prefix.arvadosapi.com
152 # Rendezvous is normally empty/omitted. When changing the
153 # URL of a Keepstore service, Rendezvous should be set to
154 # the old URL (with trailing slash omitted) to preserve
155 # rendezvous ordering.
159 InternalURLs: {SAMPLE: {ListenURL: ""}}
162 InternalURLs: {SAMPLE: {ListenURL: ""}}
163 # ShellInABox service endpoint URL for a given VM. If empty, do not
164 # offer web shell logins.
166 # E.g., using a path-based proxy server to forward connections to shell hosts:
167 # https://webshell.uuid_prefix.arvadosapi.com
169 # E.g., using a name-based proxy server to forward connections to shell hosts:
170 # https://*.webshell.uuid_prefix.arvadosapi.com
173 InternalURLs: {SAMPLE: {ListenURL: ""}}
176 InternalURLs: {SAMPLE: {ListenURL: ""}}
179 InternalURLs: {SAMPLE: {ListenURL: ""}}
183 # max concurrent connections per arvados server daemon
186 # All parameters here are passed to the PG client library in a connection string;
187 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
195 # Limits for how long a client token created by regular users can be valid,
196 # and also is used as a default expiration policy when no expiration date is
198 # Default value zero means token expirations don't get clamped and no
199 # default expiration is set.
202 # Maximum size (in bytes) allowed for a single API request. This
203 # limit is published in the discovery document for use by clients.
204 # Note: You must separately configure the upstream web server or
205 # proxy to actually enforce the desired maximum request size on the
207 MaxRequestSize: 134217728
209 # Limit the number of bytes read from the database during an index
210 # request (by retrieving and returning fewer rows than would
211 # normally be returned in a single response).
212 # Note 1: This setting never reduces the number of returned rows to
213 # zero, no matter how big the first data row is.
214 # Note 2: Currently, this is only checked against a specific set of
215 # columns that tend to get large (collections.manifest_text,
216 # containers.mounts, workflows.definition). Other fields (e.g.,
217 # "properties" hashes) are not counted against this limit.
218 MaxIndexDatabaseRead: 134217728
220 # Maximum number of items to return when responding to a APIs that
221 # can return partial result sets using limit and offset parameters
222 # (e.g., *.index, groups.contents). If a request specifies a "limit"
223 # parameter higher than this value, this value is used instead.
224 MaxItemsPerResponse: 1000
226 # Maximum number of concurrent requests to accept in a single
227 # service process, or 0 for no limit.
228 MaxConcurrentRequests: 0
230 # Maximum number of 64MiB memory buffers per Keepstore server process, or
231 # 0 for no limit. When this limit is reached, up to
232 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
233 # buffers (like GET and PUT) will wait for buffer space to be released.
234 # Any HTTP requests beyond MaxConcurrentRequests will receive an
235 # immediate 503 response.
237 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
238 # * 1.1) fits comfortably in memory. On a host dedicated to running
239 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
240 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
241 # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
242 MaxKeepBlobBuffers: 128
244 # API methods to disable. Disabled methods are not listed in the
245 # discovery document, and respond 404 to all requests.
246 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
249 # Interval (seconds) between asynchronous permission view updates. Any
250 # permission-updating API called with the 'async' parameter schedules a an
251 # update on the permission view in the future, if not already scheduled.
252 AsyncPermissionsUpdateInterval: 20s
254 # Maximum number of concurrent outgoing requests to make while
255 # serving a single incoming multi-cluster (federated) request.
256 MaxRequestAmplification: 4
258 # Maximum wall clock time to spend handling an incoming request.
261 # Websocket will send a periodic empty event after 'SendTimeout'
262 # if there is no other activity to maintain the connection /
263 # detect dropped connections.
266 WebsocketClientEventQueue: 64
267 WebsocketServerEventQueue: 4
269 # Timeout on requests to internal Keep services.
270 KeepServiceRequestTimeout: 15s
272 # Vocabulary file path, local to the node running the controller.
273 # This JSON file should contain the description of what's allowed
274 # as object's metadata. Its format is described at:
275 # https://doc.arvados.org/admin/metadata-vocabulary.html
278 # If true, a project must have a non-empty description field in
279 # order to be frozen.
280 FreezeProjectRequiresDescription: false
282 # Project properties that must have non-empty values in order to
283 # freeze a project. Example: "property_name": {}
284 FreezeProjectRequiresProperties:
287 # If true, only an admin user can un-freeze a project. If false,
288 # any user with "manage" permission can un-freeze.
289 UnfreezeProjectRequiresAdmin: false
292 # Config parameters to automatically setup new users. If enabled,
293 # this users will be able to self-activate. Enable this if you want
294 # to run an open instance where anyone can create an account and use
295 # the system without requiring manual approval.
297 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
298 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
299 AutoSetupNewUsers: false
300 AutoSetupNewUsersWithVmUUID: ""
301 AutoSetupNewUsersWithRepository: false
302 AutoSetupUsernameBlacklist:
311 # When NewUsersAreActive is set to true, new users will be active
312 # immediately. This skips the "self-activate" step which enforces
313 # user agreements. Should only be enabled for development.
314 NewUsersAreActive: false
316 # Newly activated users (whether set up by an admin or via
317 # AutoSetupNewUsers) immediately become visible to other active
320 # On a multi-tenant cluster, where the intent is for users to be
321 # invisible to one another unless they have been added to the
322 # same group(s) via Workbench admin interface, change this to
324 ActivatedUsersAreVisibleToOthers: true
326 # The e-mail address of the user you would like to become marked as an admin
327 # user on their first login.
328 AutoAdminUserWithEmail: ""
330 # If AutoAdminFirstUser is set to true, the first user to log in when no
331 # other admin users exist will automatically become an admin user.
332 AutoAdminFirstUser: false
334 # Email address to notify whenever a user creates a profile for the
336 UserProfileNotificationAddress: ""
337 AdminNotifierEmailFrom: arvados@example.com
338 EmailSubjectPrefix: "[ARVADOS] "
339 UserNotifierEmailFrom: arvados@example.com
340 UserNotifierEmailBcc: {}
341 NewUserNotificationRecipients: {}
342 NewInactiveUserNotificationRecipients: {}
344 # Set AnonymousUserToken to enable anonymous user access. Populate this
345 # field with a random string at least 50 characters long.
346 AnonymousUserToken: ""
348 # If a new user has an alternate email address (local@domain)
349 # with the domain given here, its local part becomes the new
350 # user's default username. Otherwise, the user's primary email
352 PreferDomainForUsername: ""
355 <% if not @user.full_name.empty? -%>
356 <%= @user.full_name %>,
361 Your Arvados account has been set up. You can log in at
363 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
366 Your Arvados administrator.
368 # If RoleGroupsVisibleToAll is true, all role groups are visible
369 # to all active users.
371 # If false, users must be granted permission to role groups in
372 # order to see them. This is more appropriate for a multi-tenant
374 RoleGroupsVisibleToAll: true
376 # During each period, a log entry with event_type="activity"
377 # will be recorded for each user who is active during that
378 # period. The object_uuid attribute will indicate the user's
381 # Multiple log entries for the same user may be generated during
382 # a period if there are multiple controller processes or a
383 # controller process is restarted.
385 # Use 0 to disable activity logging.
386 ActivityLoggingPeriod: 24h
389 # Time to keep audit logs, in seconds. (An audit log is a row added
390 # to the "logs" table in the PostgreSQL database each time an
391 # Arvados object is created, modified, or deleted.)
393 # Currently, websocket event notifications rely on audit logs, so
394 # this should not be set lower than 300 (5 minutes).
397 # Maximum number of log rows to delete in a single SQL transaction.
399 # If MaxDeleteBatch is 0, log entries will never be
400 # deleted by Arvados. Cleanup can be done by an external process
401 # without affecting any Arvados system processes, as long as very
402 # recent (<5 minutes old) logs are not deleted.
404 # 100000 is a reasonable batch size for most sites.
407 # Attributes to suppress in events and audit logs. Notably,
408 # specifying {"manifest_text": {}} here typically makes the database
409 # smaller and faster.
411 # Warning: Using any non-empty value here can have undesirable side
412 # effects for any client or component that relies on event logs.
413 # Use at your own risk.
414 UnloggedAttributes: {}
418 # Logging threshold: panic, fatal, error, warn, info, debug, or
422 # Logging format: json or text
425 # Maximum characters of (JSON-encoded) query parameters to include
426 # in each request log entry. When params exceed this size, they will
427 # be JSON-encoded, truncated to this size, and logged as
429 MaxRequestLogParamsSize: 2000
433 # Enable access controls for data stored in Keep. This should
434 # always be set to true on a production cluster.
437 # BlobSigningKey is a string of alphanumeric characters used to
438 # generate permission signatures for Keep locators. It must be
439 # identical to the permission key given to Keep. IMPORTANT: This
440 # is a site secret. It should be at least 50 characters.
442 # Modifying BlobSigningKey will invalidate all existing
443 # signatures, which can cause programs to fail (e.g., arv-put,
444 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
445 # when no such processes are running.
448 # Enable garbage collection of unreferenced blobs in Keep.
451 # Time to leave unreferenced blobs in "trashed" state before
452 # deleting them, or 0 to skip the "trashed" state entirely and
453 # delete unreferenced blobs.
455 # If you use any Amazon S3 buckets as storage volumes, this
456 # must be at least 24h to avoid occasional data loss.
457 BlobTrashLifetime: 336h
459 # How often to check for (and delete) trashed blocks whose
460 # BlobTrashLifetime has expired.
461 BlobTrashCheckInterval: 24h
463 # Maximum number of concurrent "trash blob" and "delete trashed
464 # blob" operations conducted by a single keepstore process. Each
465 # of these can be set to 0 to disable the respective operation.
467 # If BlobTrashLifetime is zero, "trash" and "delete trash"
468 # happen at once, so only the lower of these two values is used.
469 BlobTrashConcurrency: 4
470 BlobDeleteConcurrency: 4
472 # Maximum number of concurrent "create additional replica of
473 # existing blob" operations conducted by a single keepstore
475 BlobReplicateConcurrency: 4
477 # Default replication level for collections. This is used when a
478 # collection's replication_desired attribute is nil.
479 DefaultReplication: 2
481 # BlobSigningTTL determines the minimum lifetime of transient
482 # data, i.e., blocks that are not referenced by
483 # collections. Unreferenced blocks exist for two reasons:
485 # 1) A data block must be written to a disk/cloud backend device
486 # before a collection can be created/updated with a reference to
489 # 2) Deleting or updating a collection can remove the last
490 # remaining reference to a data block.
492 # If BlobSigningTTL is too short, long-running
493 # processes/containers will fail when they take too long (a)
494 # between writing blocks and writing collections that reference
495 # them, or (b) between reading collections and reading the
498 # If BlobSigningTTL is too long, data will still be stored long
499 # after the referring collections are deleted, and you will
500 # needlessly fill up disks or waste money on cloud storage.
502 # Modifying BlobSigningTTL invalidates existing signatures; see
503 # BlobSigningKey note above.
505 # The default is 2 weeks.
508 # When running keep-balance, this is the destination filename for
509 # the list of lost block hashes if there are any, one per line.
510 # Updated automically during each successful run.
511 BlobMissingReport: ""
513 # keep-balance operates periodically, i.e.: do a
514 # scan/balance operation, sleep, repeat.
516 # BalancePeriod determines the interval between start times of
517 # successive scan/balance operations. If a scan/balance operation
518 # takes longer than BalancePeriod, the next one will follow it
521 # If SIGUSR1 is received during an idle period between operations,
522 # the next operation will start immediately.
525 # Limits the number of collections retrieved by keep-balance per
526 # API transaction. If this is zero, page size is
527 # determined by the API server's own page size limits (see
528 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
529 BalanceCollectionBatch: 0
531 # The size of keep-balance's internal queue of
532 # collections. Higher values use more memory and improve throughput
533 # by allowing keep-balance to fetch the next page of collections
534 # while the current page is still being processed. If this is zero
535 # or omitted, pages are processed serially.
536 BalanceCollectionBuffers: 1000
538 # Maximum time for a rebalancing run. This ensures keep-balance
539 # eventually gives up and retries if, for example, a network
540 # error causes a hung connection that is never closed by the
541 # OS. It should be long enough that it doesn't interrupt a
542 # long-running balancing operation.
545 # Maximum number of replication_confirmed /
546 # storage_classes_confirmed updates to write to the database
547 # after a rebalancing run. When many updates are needed, this
548 # spreads them over a few runs rather than applying them all at
550 BalanceUpdateLimit: 100000
552 # Default lifetime for ephemeral collections: 2 weeks. This must not
553 # be less than BlobSigningTTL.
554 DefaultTrashLifetime: 336h
556 # Interval (seconds) between trash sweeps. During a trash sweep,
557 # collections are marked as trash if their trash_at time has
558 # arrived, and deleted if their delete_at time has arrived.
559 TrashSweepInterval: 60s
561 # If true, enable collection versioning.
562 # When a collection's preserve_version field is true or the current version
563 # is older than the amount of seconds defined on PreserveVersionIfIdle,
564 # a snapshot of the collection's previous state is created and linked to
565 # the current collection.
566 CollectionVersioning: true
568 # 0s = auto-create a new version on every update.
569 # -1s = never auto-create new versions.
570 # > 0s = auto-create a new version when older than the specified number of seconds.
571 PreserveVersionIfIdle: 10s
573 # If non-empty, allow project and collection names to contain
574 # the "/" character (slash/stroke/solidus), and replace "/" with
575 # the given string in the filesystem hierarchy presented by
576 # WebDAV. Example values are "%2f" and "{slash}". Names that
577 # contain the substitution string itself may result in confusing
578 # behavior, so a value like "_" is not recommended.
580 # If the default empty value is used, the server will reject
581 # requests to create or rename a collection when the new name
584 # If the value "/" is used, project and collection names
585 # containing "/" will be allowed, but they will not be
586 # accessible via WebDAV.
588 # Use of this feature is not recommended, if it can be avoided.
589 ForwardSlashNameSubstitution: ""
591 # Include "folder objects" in S3 ListObjects responses.
592 S3FolderObjects: true
594 # Managed collection properties. At creation time, if the client didn't
595 # provide the listed keys, they will be automatically populated following
596 # one of the following behaviors:
598 # * UUID of the user who owns the containing project.
599 # responsible_person_uuid: {Function: original_owner, Protected: true}
601 # * Default concrete value.
602 # foo_bar: {Value: baz, Protected: false}
604 # If Protected is true, only an admin user can modify its value.
606 SAMPLE: {Function: original_owner, Protected: true}
608 # In "trust all content" mode, Workbench will redirect download
609 # requests to WebDAV preview link, even in the cases when
610 # WebDAV would have to expose XSS vulnerabilities in order to
611 # handle the redirect (see discussion on Services.WebDAV).
613 # This setting has no effect in the recommended configuration, where the
614 # WebDAV service is configured to have a separate domain for every
615 # collection and XSS protection is provided by browsers' same-origin
618 # The default setting (false) is appropriate for a multi-user site.
619 TrustAllContent: false
621 # Cache parameters for WebDAV content serving:
623 # Time to cache manifests, permission checks, and sessions.
626 # Block cache entries. Each block consumes up to 64 MiB RAM.
629 # Approximate memory limit (in bytes) for session cache.
631 # Note this applies to the in-memory representation of
632 # projects and collections -- metadata, block locators,
633 # filenames, etc. -- excluding cached file content, which is
634 # limited by MaxBlockEntries.
635 MaxCollectionBytes: 100000000
637 # Persistent sessions.
640 # Selectively set permissions for regular users and admins to
641 # download or upload data files using the upload/download
642 # features for Workbench, WebDAV and S3 API support.
651 # Selectively set permissions for regular users and admins to be
652 # able to download or upload blocks using arv-put and
653 # arv-get from outside the cluster.
662 # Post upload / download events to the API server logs table, so
663 # that they can be included in the arv-user-activity report.
664 # You can disable this if you find that it is creating excess
665 # load on the API server and you don't need it.
666 WebDAVLogEvents: true
669 # One of the following mechanisms (Google, PAM, LDAP, or
670 # LoginCluster) should be enabled; see
671 # https://doc.arvados.org/install/setup-login.html
674 # Authenticate with Google.
677 # Use the Google Cloud console to enable the People API (APIs
678 # and Services > Enable APIs and services > Google People API
679 # > Enable), generate a Client ID and secret (APIs and
680 # Services > Credentials > Create credentials > OAuth client
681 # ID > Web application) and add your controller's /login URL
682 # (e.g., "https://zzzzz.example.com/login") as an authorized
687 # Allow users to log in to existing accounts using any verified
688 # email address listed by their Google account. If true, the
689 # Google People API must be enabled in order for Google login to
690 # work. If false, only the primary email address will be used.
691 AlternateEmailAddresses: true
693 # Send additional parameters with authentication requests. See
694 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
695 # for a list of supported parameters.
696 AuthenticationRequestParameters:
697 # Show the "choose which Google account" page, even if the
698 # client is currently logged in to exactly one Google
700 prompt: select_account
705 # Authenticate with an OpenID Connect provider.
708 # Issuer URL, e.g., "https://login.example.com".
710 # This must be exactly equal to the URL returned by the issuer
711 # itself in its config response ("isser" key). If the
712 # configured value is "https://example" and the provider
713 # returns "https://example:443" or "https://example/" then
714 # login will fail, even though those URLs are equivalent
718 # Your client ID and client secret (supplied by the provider).
722 # OpenID claim field containing the user's email
723 # address. Normally "email"; see
724 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
727 # OpenID claim field containing the email verification
728 # flag. Normally "email_verified". To accept every returned
729 # email address without checking a "verified" field at all,
730 # use the empty string "".
731 EmailVerifiedClaim: "email_verified"
733 # OpenID claim field containing the user's preferred
734 # username. If empty, use the mailbox part of the user's email
738 # Send additional parameters with authentication requests,
739 # like {display: page, prompt: consent}. See
740 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
741 # and refer to your provider's documentation for supported
743 AuthenticationRequestParameters:
746 # Accept an OIDC access token as an API token if the OIDC
747 # provider's UserInfo endpoint accepts it.
749 # AcceptAccessTokenScope should also be used when enabling
751 AcceptAccessToken: false
753 # Before accepting an OIDC access token as an API token, first
754 # check that it is a JWT whose "scope" value includes this
755 # value. Example: "https://zzzzz.example.com/" (your Arvados
758 # If this value is empty and AcceptAccessToken is true, all
759 # access tokens will be accepted regardless of scope,
760 # including non-JWT tokens. This is not recommended.
761 AcceptAccessTokenScope: ""
764 # Use PAM to authenticate users.
767 # PAM service name. PAM will apply the policy in the
768 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
769 # there is none, the default "other" config.
772 # Domain name (e.g., "example.com") to use to construct the
773 # user's email address if PAM authentication returns a
774 # username with no "@". If empty, use the PAM username as the
775 # user's email address, whether or not it contains "@".
777 # Note that the email address is used as the primary key for
778 # user records when logging in. Therefore, if you change
779 # PAMDefaultEmailDomain after the initial installation, you
780 # should also update existing user records to reflect the new
781 # domain. Otherwise, next time those users log in, they will
782 # be given new accounts instead of accessing their existing
784 DefaultEmailDomain: ""
787 # Use an LDAP service to authenticate users.
790 # Server URL, like "ldap://ldapserver.example.com:389" or
791 # "ldaps://ldapserver.example.com:636".
792 URL: "ldap://ldap:389"
794 # Use StartTLS upon connecting to the server.
797 # Skip TLS certificate name verification.
800 # Strip the @domain part if a user supplies an email-style
801 # username with this domain. If "*", strip any user-provided
802 # domain. If "", never strip the domain part. Example:
806 # If, after applying StripDomain, the username contains no "@"
807 # character, append this domain to form an email-style
808 # username. Example: "example.com"
811 # The LDAP attribute to filter on when looking up a username
812 # (after applying StripDomain and AppendDomain).
815 # Bind with this username (DN or UPN) and password when
816 # looking up the user record.
818 # Example user: "cn=admin,dc=example,dc=com"
820 SearchBindPassword: ""
822 # Directory base for username lookup. Example:
823 # "ou=Users,dc=example,dc=com"
826 # Additional filters to apply when looking up users' LDAP
827 # entries. This can be used to restrict access to a subset of
828 # LDAP users, or to disambiguate users from other directory
829 # entries that have the SearchAttribute present.
831 # Special characters in assertion values must be escaped (see
834 # Example: "(objectClass=person)"
837 # LDAP attribute to use as the user's email address.
839 # Important: This must not be an attribute whose value can be
840 # edited in the directory by the users themselves. Otherwise,
841 # users can take over other users' Arvados accounts trivially
842 # (email address is the primary key for Arvados accounts.)
845 # LDAP attribute to use as the preferred Arvados username. If
846 # no value is found (or this config is empty) the username
847 # originally supplied by the user will be used.
848 UsernameAttribute: uid
851 # Authenticate users listed here in the config file. This
852 # feature is intended to be used in test environments, and
853 # should not be used in production.
857 Email: alice@example.com
860 # The cluster ID to delegate the user database. When set,
861 # logins on this cluster will be redirected to the login cluster
862 # (login cluster must appear in RemoteClusters with Proxy: true)
865 # How long a cached token belonging to a remote cluster will
866 # remain valid before it needs to be revalidated.
867 RemoteTokenRefresh: 5m
869 # How long a client token created from a login flow will be valid without
870 # asking the user to re-login. Example values: 60m, 8h.
871 # Default value zero means tokens don't have expiration.
874 # If true (default) tokens issued through login are allowed to create
876 # If false, tokens issued through login are not allowed to
877 # viewing/creating other tokens. New tokens can only be created
878 # by going through login again.
879 IssueTrustedTokens: true
881 # When the token is returned to a client, the token itself may
882 # be restricted from viewing/creating other tokens based on whether
883 # the client is "trusted" or not. The local Workbench1 and
884 # Workbench2 are trusted by default, but if this is a
885 # LoginCluster, you probably want to include the other Workbench
886 # instances in the federation in this list.
889 "https://workbench.federate1.example": {}
890 "https://workbench.federate2.example": {}
893 # Path to git or gitolite-shell executable. Each authenticated
894 # request will execute this program with the single argument "http-backend"
895 GitCommand: /usr/bin/git
897 # Path to Gitolite's home directory. If a non-empty path is given,
898 # the CGI environment will be set up to support the use of
899 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
900 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
901 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
904 # Git repositories must be readable by api server, or you won't be
905 # able to submit crunch jobs. To pass the test suites, put a clone
906 # of the arvados tree in {git_repositories_dir}/arvados.git or
907 # {git_repositories_dir}/arvados/.git
908 Repositories: /var/lib/arvados/git/repositories
911 # Use "file:///var/lib/acme/live/example.com/cert" and
912 # ".../privkey" to load externally managed certificates.
916 # Accept invalid certificates when connecting to servers. Never
917 # use this in production.
921 # Obtain certificates automatically for ExternalURL domains
922 # using an ACME server and http-01 validation.
924 # To use Let's Encrypt, specify "LE". To use the Let's
925 # Encrypt staging environment, specify "LE-staging". To use a
926 # different ACME server, specify the full directory URL
929 # Note: this feature is not yet implemented in released
930 # versions, only in the alpha/prerelease arvados-server-easy
933 # Implies agreement with the server's terms of service.
937 # List of supported Docker Registry image formats that compute nodes
938 # are able to use. `arv keep docker` will error out if a user tries
939 # to store an image with an unsupported format. Use an empty array
940 # to skip the compatibility check (and display a warning message to
943 # Example for sites running docker < 1.10: {"v1": {}}
944 # Example for sites running docker >= 1.10: {"v2": {}}
945 # Example for disabling check: {}
946 SupportedDockerImageFormats:
950 # Include details about job reuse decisions in the server log. This
951 # causes additional database queries to run, so it should not be
952 # enabled unless you expect to examine the resulting logs for
953 # troubleshooting purposes.
954 LogReuseDecisions: false
956 # Default value for keep_cache_ram of a container's runtime_constraints.
957 DefaultKeepCacheRAM: 268435456
959 # Number of times a container can be unlocked before being
960 # automatically cancelled.
961 MaxDispatchAttempts: 5
963 # Default value for container_count_max for container requests. This is the
964 # number of times Arvados will create a new container to satisfy a container
965 # request. If a container is cancelled it will retry a new container if
966 # container_count < container_count_max on any container requests associated
967 # with the cancelled container.
970 # The maximum number of compute nodes that can be in use simultaneously
971 # If this limit is reduced, any existing nodes with slot number >= new limit
972 # will not be counted against the new limit. In other words, the new limit
973 # won't be strictly enforced until those nodes with higher slot numbers
977 # Schedule all child containers on preemptible instances (e.g. AWS
978 # Spot Instances) even if not requested by the submitter.
980 # If false, containers are scheduled on preemptible instances
981 # only when requested by the submitter.
983 # This flag is ignored if no preemptible instance types are
984 # configured, and has no effect on top-level containers.
985 AlwaysUsePreemptibleInstances: false
987 # Automatically add a preemptible variant for every
988 # non-preemptible entry in InstanceTypes below. The maximum bid
989 # price for the preemptible variant will be the non-preemptible
990 # price multiplied by PreemptiblePriceFactor. If 0, preemptible
991 # variants are not added automatically.
993 # A price factor of 1.0 is a reasonable starting point.
994 PreemptiblePriceFactor: 0
996 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
997 # cloud dispatcher for executing containers on worker VMs.
998 # Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
999 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
1000 DispatchPrivateKey: ""
1002 # Maximum time to wait for workers to come up before abandoning
1003 # stale locks from a previous dispatch process.
1004 StaleLockTimeout: 1m
1006 # The crunch-run command used to start a container on a worker node.
1008 # When dispatching to cloud VMs, this is used only if
1009 # DeployRunnerBinary in the CloudVMs section is set to the empty
1011 CrunchRunCommand: "crunch-run"
1013 # Extra arguments to add to crunch-run invocation
1014 # Example: ["--cgroup-parent-subsystem=memory"]
1015 CrunchRunArgumentsList: []
1017 # Extra RAM to reserve on the node, in addition to
1018 # the amount specified in the container's RuntimeConstraints
1019 ReserveExtraRAM: 256MiB
1021 # Minimum time between two attempts to run the same container
1024 # Container runtime: "docker" (default) or "singularity"
1025 RuntimeEngine: docker
1027 # When running a container, run a dedicated keepstore process,
1028 # using the specified number of 64 MiB memory buffers per
1029 # allocated CPU core (VCPUs in the container's runtime
1030 # constraints). The dedicated keepstore handles I/O for
1031 # collections mounted in the container, as well as saving
1034 # A zero value disables this feature.
1036 # In order for this feature to be activated, no volume may use
1037 # AccessViaHosts, and no writable volume may have Replication
1038 # lower than Collections.DefaultReplication. If these
1039 # requirements are not satisfied, the feature is disabled
1040 # automatically regardless of the value given here.
1042 # When an HPC dispatcher is in use (see SLURM and LSF sections),
1043 # this feature depends on the operator to ensure an up-to-date
1044 # cluster configuration file (/etc/arvados/config.yml) is
1045 # available on all compute nodes. If it is missing or not
1046 # readable by the crunch-run user, the feature will be disabled
1047 # automatically. To read it from a different location, add a
1048 # "-config=/path/to/config.yml" argument to
1049 # CrunchRunArgumentsList above.
1051 # When the cloud dispatcher is in use (see CloudVMs section) and
1052 # this configuration is enabled, the entire cluster
1053 # configuration file, including the system root token, is copied
1054 # to the worker node and held in memory for the duration of the
1056 LocalKeepBlobBuffersPerVCPU: 1
1058 # When running a dedicated keepstore process for a container
1059 # (see LocalKeepBlobBuffersPerVCPU), write keepstore log
1060 # messages to keepstore.txt in the container's log collection.
1062 # These log messages can reveal some volume configuration
1063 # details, error messages from the cloud storage provider, etc.,
1064 # which are not otherwise visible to users.
1067 # * "none" -- no keepstore.txt file
1068 # * "all" -- all logs, including request and response lines
1069 # * "errors" -- all logs except "response" logs with 2xx
1070 # response codes and "request" logs
1071 LocalKeepLogsToContainerLog: none
1074 # When you run the db:delete_old_container_logs task, it will find
1075 # containers that have been finished for at least this many seconds,
1076 # and delete their stdout, stderr, arv-mount, crunch-run, and
1077 # crunchstat logs from the logs table.
1080 # These two settings control how frequently log events are flushed to the
1081 # database. Log lines are buffered until either crunch_log_bytes_per_event
1082 # has been reached or crunch_log_seconds_between_events has elapsed since
1084 LogBytesPerEvent: 4096
1085 LogSecondsBetweenEvents: 5s
1087 # The sample period for throttling logs.
1088 LogThrottlePeriod: 60s
1090 # Maximum number of bytes that job can log over crunch_log_throttle_period
1091 # before being silenced until the end of the period.
1092 LogThrottleBytes: 65536
1094 # Maximum number of lines that job can log over crunch_log_throttle_period
1095 # before being silenced until the end of the period.
1096 LogThrottleLines: 1024
1098 # Maximum bytes that may be logged by a single job. Log bytes that are
1099 # silenced by throttling are not counted against this total.
1100 LimitLogBytesPerJob: 67108864
1102 LogPartialLineThrottlePeriod: 5s
1104 # Container logs are written to Keep and saved in a
1105 # collection, which is updated periodically while the
1106 # container runs. This value sets the interval between
1107 # collection updates.
1108 LogUpdatePeriod: 30m
1110 # The log collection is also updated when the specified amount of
1111 # log data (given in bytes) is produced in less than one update
1113 LogUpdateSize: 32MiB
1116 # An admin user can use "arvados-client shell" to start an
1117 # interactive shell (with any user ID) in any running
1121 # Any user can use "arvados-client shell" to start an
1122 # interactive shell (with any user ID) in any running
1123 # container that they started, provided it isn't also
1124 # associated with a different user's container request.
1126 # Interactive sessions make it easy to alter the container's
1127 # runtime environment in ways that aren't recorded or
1128 # reproducible. Consider the implications for automatic
1129 # container reuse before enabling and using this feature. In
1130 # particular, note that starting an interactive session does
1131 # not disqualify a container from being reused by a different
1132 # user/workflow in the future.
1137 SbatchArgumentsList: []
1138 SbatchEnvironmentVariables:
1141 # Path to dns server configuration directory
1142 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
1143 # files or touch restart.txt (see below).
1144 DNSServerConfDir: ""
1146 # Template file for the dns server host snippets. See
1147 # unbound.template in this directory for an example. If false, do
1148 # not write any config files.
1149 DNSServerConfTemplate: ""
1151 # String to write to {dns_server_conf_dir}/restart.txt (with a
1152 # trailing newline) after updating local data. If false, do not
1153 # open or write the restart.txt file.
1154 DNSServerReloadCommand: ""
1156 # Command to run after each DNS update. Template variables will be
1157 # substituted; see the "unbound" example below. If false, do not run
1159 DNSServerUpdateCommand: ""
1161 ComputeNodeDomain: ""
1162 ComputeNodeNameservers:
1166 # Hostname to assign to a compute node when it sends a "ping" and the
1167 # hostname in its Node record is nil.
1168 # During bootstrapping, the "ping" script is expected to notice the
1169 # hostname given in the ping response, and update its unix hostname
1171 # If false, leave the hostname alone (this is appropriate if your compute
1172 # nodes' hostnames are already assigned by some other mechanism).
1174 # One way or another, the hostnames of your node records should agree
1175 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1177 # Example for compute0000, compute0001, ....:
1178 # assign_node_hostname: compute%<slot_number>04d
1179 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1180 AssignNodeHostname: "compute%<slot_number>d"
1183 # Arguments to bsub when submitting Arvados containers as LSF jobs.
1185 # Template variables starting with % will be substituted as follows:
1188 # %C number of VCPUs
1191 # %G number of GPU devices (runtime_constraints.cuda.device_count)
1193 # Use %% to express a literal %. The %%J in the default will be changed
1194 # to %J, which is interpreted by bsub itself.
1196 # Note that the default arguments cause LSF to write two files
1197 # in /tmp on the compute node each time an Arvados container
1198 # runs. Ensure you have something in place to delete old files
1199 # from /tmp, or adjust the "-o" and "-e" arguments accordingly.
1200 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]"]
1202 # Arguments that will be appended to the bsub command line
1203 # when submitting Arvados containers as LSF jobs with
1204 # runtime_constraints.cuda.device_count > 0
1205 BsubCUDAArguments: ["-gpu", "num=%G"]
1207 # Use sudo to switch to this user account when submitting LSF
1210 # This account must exist on the hosts where LSF jobs run
1211 # ("execution hosts"), as well as on the host where the
1212 # Arvados LSF dispatcher runs ("submission host").
1213 BsubSudoUser: "crunch"
1216 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
1218 # Note: this only enables read-only access, creating new
1219 # legacy jobs and pipelines is not supported.
1221 # 'auto' -- (default) enable the Jobs API only if it has been used before
1222 # (i.e., there are job records in the database)
1223 # 'true' -- enable the Jobs API despite lack of existing records.
1224 # 'false' -- disable the Jobs API despite presence of existing records.
1227 # Git repositories must be readable by api server, or you won't be
1228 # able to submit crunch jobs. To pass the test suites, put a clone
1229 # of the arvados tree in {git_repositories_dir}/arvados.git or
1230 # {git_repositories_dir}/arvados/.git
1231 GitInternalDir: /var/lib/arvados/internal.git
1234 # Enable the cloud scheduler.
1237 # Name/number of port where workers' SSH services listen.
1240 # Interval between queue polls.
1243 # Shell command to execute on each worker to determine whether
1244 # the worker is booted and ready to run containers. It should
1245 # exit zero if the worker is ready.
1246 BootProbeCommand: "systemctl is-system-running"
1248 # Minimum interval between consecutive probes to a single
1252 # Maximum probes per second, across all workers in a pool.
1253 MaxProbesPerSecond: 10
1255 # Time before repeating SIGTERM when killing a container.
1258 # Time to give up on a process (most likely arv-mount) that
1259 # still holds a container lockfile after its main supervisor
1260 # process has exited, and declare the instance broken.
1261 TimeoutStaleRunLock: 5s
1263 # Time to give up on SIGTERM and write off the worker.
1266 # Maximum create/destroy-instance operations per second (0 =
1268 MaxCloudOpsPerSecond: 10
1270 # Maximum concurrent instance creation operations (0 = unlimited).
1272 # MaxConcurrentInstanceCreateOps limits the number of instance creation
1273 # requests that can be in flight at any one time, whereas
1274 # MaxCloudOpsPerSecond limits the number of create/destroy operations
1275 # that can be started per second.
1277 # Because the API for instance creation on Azure is synchronous, it is
1278 # recommended to increase MaxConcurrentInstanceCreateOps when running
1279 # on Azure. When using managed images, a value of 20 would be
1280 # appropriate. When using Azure Shared Image Galeries, it could be set
1281 # higher. For more information, see
1282 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
1284 # MaxConcurrentInstanceCreateOps can be increased for other cloud
1285 # providers too, if desired.
1286 MaxConcurrentInstanceCreateOps: 1
1288 # Interval between cloud provider syncs/updates ("list all
1292 # Time to leave an idle worker running (in case new containers
1293 # appear in the queue that it can run) before shutting it
1297 # Time to wait for a new worker to boot (i.e., pass
1298 # BootProbeCommand) before giving up and shutting it down.
1301 # Maximum time a worker can stay alive with no successful
1302 # probes before being automatically shut down.
1305 # Time after shutting down a worker to retry the
1306 # shutdown/destroy operation.
1307 TimeoutShutdown: 10s
1309 # Worker VM image ID.
1310 # (aws) AMI identifier
1311 # (azure) managed disks: the name of the managed disk image
1312 # (azure) shared image gallery: the name of the image definition. Also
1313 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1314 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1315 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1318 # An executable file (located on the dispatcher host) to be
1319 # copied to cloud instances at runtime and used as the
1320 # container runner/supervisor. The default value is the
1321 # dispatcher program itself.
1323 # Use the empty string to disable this step: nothing will be
1324 # copied, and cloud instances are assumed to have a suitable
1325 # version of crunch-run installed; see CrunchRunCommand above.
1326 DeployRunnerBinary: "/proc/self/exe"
1328 # Tags to add on all resources (VMs, NICs, disks) created by
1329 # the container dispatcher. (Arvados's own tags --
1330 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1335 # Prefix for predefined tags used by Arvados (InstanceSetID,
1336 # InstanceType, InstanceSecret, IdleBehavior). With the
1337 # default value "Arvados", tags are "ArvadosInstanceSetID",
1338 # "ArvadosInstanceSecret", etc.
1340 # This should only be changed while no cloud resources are in
1341 # use and the cloud dispatcher is not running. Otherwise,
1342 # VMs/resources that were added using the old tag prefix will
1343 # need to be detected and cleaned up manually.
1344 TagKeyPrefix: Arvados
1346 # Cloud driver: "azure" (Microsoft Azure), "ec2" (Amazon AWS),
1347 # or "loopback" (run containers on dispatch host for testing
1351 # Cloud-specific driver parameters.
1354 # (ec2) Credentials. Omit or leave blank if using IAM role.
1358 # (ec2) Instance configuration.
1364 AdminUsername: debian
1365 # (ec2) name of the IAMInstanceProfile for instances started by
1366 # the cloud dispatcher. Leave blank when not needed.
1367 IAMInstanceProfile: ""
1369 # (azure) Credentials.
1375 # (azure) Instance configuration.
1376 CloudEnvironment: AzurePublicCloud
1379 # (azure) The resource group where the VM and virtual NIC will be
1383 # (azure) The resource group of the Network to use for the virtual
1384 # NIC (if different from ResourceGroup)
1385 NetworkResourceGroup: ""
1389 # (azure) managed disks: The resource group where the managed disk
1390 # image can be found (if different from ResourceGroup).
1391 ImageResourceGroup: ""
1393 # (azure) shared image gallery: the name of the gallery
1394 SharedImageGalleryName: ""
1395 # (azure) shared image gallery: the version of the image definition
1396 SharedImageGalleryImageVersion: ""
1398 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1402 # (azure) How long to wait before deleting VHD and NIC
1403 # objects that are no longer being used.
1404 DeleteDanglingResourcesAfter: 20s
1406 # Account (that already exists in the VM image) that will be
1407 # set up with an ssh authorized key to allow the compute
1408 # dispatcher to connect.
1409 AdminUsername: arvados
1413 # Use the instance type name as the key (in place of "SAMPLE" in
1414 # this sample entry).
1416 # Cloud provider's instance type. Defaults to the configured type name.
1420 IncludedScratch: 16GB
1424 # Include this section if the node type includes GPU (CUDA) support
1426 DriverVersion: "11.0"
1427 HardwareCapability: "9.0"
1432 # If you use multiple storage classes, specify them here, using
1433 # the storage class name as the key (in place of "SAMPLE" in
1434 # this sample entry).
1436 # Further info/examples:
1437 # https://doc.arvados.org/admin/storage-classes.html
1440 # Priority determines the order volumes should be searched
1441 # when reading data, in cases where a keepstore server has
1442 # access to multiple volumes with different storage classes.
1445 # Default determines which storage class(es) should be used
1446 # when a user/client writes data or saves a new collection
1447 # without specifying storage classes.
1449 # If any StorageClasses are configured, at least one of them
1450 # must have Default: true.
1455 # AccessViaHosts specifies which keepstore processes can read
1456 # and write data on the volume.
1458 # For a local filesystem, AccessViaHosts has one entry,
1459 # indicating which server the filesystem is located on.
1461 # For a network-attached backend accessible by all keepstore
1462 # servers, like a cloud storage bucket or an NFS mount,
1463 # AccessViaHosts can be empty/omitted.
1465 # Further info/examples:
1466 # https://doc.arvados.org/install/configure-fs-storage.html
1467 # https://doc.arvados.org/install/configure-s3-object-storage.html
1468 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1472 "http://host1.example:25107": {}
1476 # If you have configured storage classes (see StorageClasses
1477 # section above), add an entry here for each storage class
1478 # satisfied by this volume.
1482 # for s3 driver -- see
1483 # https://doc.arvados.org/install/configure-s3-object-storage.html
1486 SecretAccessKey: aaaaa
1490 LocationConstraint: false
1497 # Use aws-s3-go (v2) instead of goamz
1498 UseAWSS3v2Driver: false
1500 # For S3 driver, potentially unsafe tuning parameter,
1501 # intentionally excluded from main documentation.
1503 # Enable deletion (garbage collection) even when the
1504 # configured BlobTrashLifetime is zero. WARNING: eventual
1505 # consistency may result in race conditions that can cause
1506 # data loss. Do not enable this unless you understand and
1510 # for azure driver -- see
1511 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1512 StorageAccountName: aaaaa
1513 StorageAccountKey: aaaaa
1514 StorageBaseURL: core.windows.net
1515 ContainerName: aaaaa
1517 ListBlobsRetryDelay: 10s
1518 ListBlobsMaxAttempts: 10
1520 WriteRaceInterval: 15s
1521 WriteRacePollTime: 1s
1523 # for local directory driver -- see
1524 # https://doc.arvados.org/install/configure-fs-storage.html
1525 Root: /var/lib/arvados/keep-data
1527 # For local directory driver, potentially confusing tuning
1528 # parameter, intentionally excluded from main documentation.
1530 # When true, read and write operations (for whole 64MiB
1531 # blocks) on an individual volume will queued and issued
1532 # serially. When false, read and write operations will be
1533 # issued concurrently.
1535 # May possibly improve throughput if you have physical spinning disks
1536 # and experience contention when there are multiple requests
1537 # to the same volume.
1539 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1540 # should leave this alone.
1546 SendUserSetupNotificationEmail: true
1548 # Bug/issue report notification to and from addresses
1549 IssueReporterEmailFrom: "arvados@example.com"
1550 IssueReporterEmailTo: "arvados@example.com"
1551 SupportEmailAddress: "arvados@example.com"
1553 # Generic issue email from
1554 EmailFrom: "arvados@example.com"
1561 ActivateUsers: false
1563 # API endpoint host or host:port; default is {id}.arvadosapi.com
1564 Host: sample.arvadosapi.com
1566 # Perform a proxy request when a local client requests an
1567 # object belonging to this remote.
1570 # Default "https". Can be set to "http" for testing.
1573 # Disable TLS verify. Can be set to true for testing.
1576 # When users present tokens issued by this remote cluster, and
1577 # their accounts are active on the remote cluster, activate
1578 # them on this cluster too.
1579 ActivateUsers: false
1582 # Workbench1 configs
1584 ActivationContactLink: mailto:info@arvados.org
1585 ArvadosDocsite: https://doc.arvados.org
1586 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1587 ShowUserAgreementInline: false
1590 # Set this configuration to true to avoid providing an easy way for users
1591 # to share data with unauthenticated users; this may be necessary on
1592 # installations where strict data access controls are needed.
1593 DisableSharingURLsUI: false
1595 # Scratch directory used by the remote repository browsing
1596 # feature. If it doesn't exist, it (and any missing parents) will be
1597 # created using mkdir_p.
1598 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1600 # Below is a sample setting of user_profile_form_fields config parameter.
1601 # This configuration parameter should be set to either false (to disable) or
1602 # to a map as shown below.
1603 # Configure the map of input fields to be displayed in the profile page
1604 # using the attribute "key" for each of the input fields.
1605 # This sample shows configuration with one required and one optional form fields.
1606 # For each of these input fields:
1607 # You can specify "Type" as "text" or "select".
1608 # List the "Options" to be displayed for each of the "select" menu.
1609 # Set "Required" as "true" for any of these fields to make them required.
1610 # If any of the required fields are missing in the user's profile, the user will be
1611 # redirected to the profile page before they can access any Workbench features.
1612 UserProfileFormFields:
1615 FormFieldTitle: Best color
1616 FormFieldDescription: your favorite color
1625 # exampleTextValue: # key that will be set in properties
1627 # FormFieldTitle: ""
1628 # FormFieldDescription: ""
1631 # exampleOptionsValue:
1633 # FormFieldTitle: ""
1634 # FormFieldDescription: ""
1642 # Use "UserProfileFormMessage to configure the message you want
1643 # to display on the profile page.
1644 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1646 # Mimetypes of applications for which the view icon
1647 # would be enabled in a collection's show page.
1648 # It is sufficient to list only applications here.
1649 # No need to list text and image types.
1650 ApplicationMimetypesWithViewIcon:
1668 # The maximum number of bytes to load in the log viewer
1669 LogViewerMaxBytes: 1M
1671 # When anonymous_user_token is configured, show public projects page
1672 EnablePublicProjectsPage: true
1674 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1675 EnableGettingStartedPopup: false
1677 # Ask Arvados API server to compress its response payloads.
1678 APIResponseCompression: true
1680 # Timeouts for API requests.
1681 APIClientConnectTimeout: 2m
1682 APIClientReceiveTimeout: 5m
1684 # Maximum number of historic log records of a running job to fetch
1685 # and display in the Log tab, while subscribing to web sockets.
1686 RunningJobLogRecordsToFetch: 2000
1688 # In systems with many shared projects, loading of dashboard and topnav
1689 # can be slow due to collections indexing; use the following parameters
1690 # to suppress these properties
1691 ShowRecentCollectionsOnDashboard: true
1692 ShowUserNotifications: true
1694 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1695 # a link to the multi-site search page on a "home" Workbench site.
1698 # https://workbench.zzzzz.arvadosapi.com/collections/multisite
1701 # Should workbench allow management of local git repositories? Set to false if
1702 # the jobs api is disabled and there are no local git repositories.
1705 SiteName: Arvados Workbench
1706 ProfilingEnabled: false
1708 # This is related to obsolete Google OpenID 1.0 login
1709 # but some workbench stuff still expects it to be set.
1710 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1712 # Workbench2 configs
1713 FileViewersConfigURL: ""
1715 # Idle time after which the user's session will be auto closed.
1716 # This feature is disabled when set to zero.
1719 # Workbench welcome screen, this is HTML text that will be
1720 # incorporated directly onto the page.
1722 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1723 <h2>Please log in.</h2>
1725 <p>If you have never used Arvados Workbench before, logging in
1726 for the first time will automatically create a new
1729 <i>Arvados Workbench uses your information only for
1730 identification, and does not retrieve any other personal
1733 # Workbench screen displayed to inactive users. This is HTML
1734 # text that will be incorporated directly onto the page.
1736 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1737 <h3>Hi! You're logged in, but...</h3>
1738 <p>Your account is inactive.</p>
1739 <p>An administrator must activate your account before you can get
1742 # Connecting to Arvados shell VMs tends to be site-specific.
1743 # Put any special instructions here. This is HTML text that will
1744 # be incorporated directly onto the Workbench page.
1746 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1747 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1749 # Sample text if you are using a "switchyard" ssh proxy.
1750 # Replace "zzzzz" with your Cluster ID.
1752 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1755 # ServerAliveInterval 60
1756 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1759 # If you are using a switchyard ssh proxy, shell node hostnames
1760 # may require a special hostname suffix. In the sample ssh
1761 # configuration above, this would be ".zzzzz"
1762 # This is added to the hostname in the "command line" column
1763 # the Workbench "shell VMs" page.
1765 # If your shell nodes are directly accessible by users without a
1766 # proxy and have fully qualified host names, you should leave
1768 SSHHelpHostSuffix: ""
1770 # (Experimental) Restart services automatically when config file
1771 # changes are detected. Only supported by `arvados-server boot` in
1773 AutoReloadConfig: false