16745: Keep a SiteFileSystem alive for multiple read requests.
[arvados.git] / lib / config / config.default.yml
1 # Copyright (C) The Arvados Authors. All rights reserved.
2 #
3 # SPDX-License-Identifier: AGPL-3.0
4
5 # Do not use this file for site configuration. Create
6 # /etc/arvados/config.yml instead.
7 #
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
12
13 Clusters:
14   xxxxx:
15     # Token used internally by Arvados components to authenticate to
16     # one another. Use a string of at least 50 random alphanumerics.
17     SystemRootToken: ""
18
19     # Token to be included in all healthcheck requests. Disabled by default.
20     # Server expects request header of the format "Authorization: Bearer xxx"
21     ManagementToken: ""
22
23     Services:
24
25       # In each of the service sections below, the keys under
26       # InternalURLs are the endpoints where the service should be
27       # listening, and reachable from other hosts in the cluster.
28       SAMPLE:
29         InternalURLs:
30           "http://host1.example:12345": {}
31           "http://host2.example:12345":
32             # Rendezvous is normally empty/omitted. When changing the
33             # URL of a Keepstore service, Rendezvous should be set to
34             # the old URL (with trailing slash omitted) to preserve
35             # rendezvous ordering.
36             Rendezvous: ""
37           SAMPLE:
38             Rendezvous: ""
39         ExternalURL: "-"
40
41       RailsAPI:
42         InternalURLs: {}
43         ExternalURL: "-"
44       Controller:
45         InternalURLs: {}
46         ExternalURL: ""
47       Websocket:
48         InternalURLs: {}
49         ExternalURL: ""
50       Keepbalance:
51         InternalURLs: {}
52         ExternalURL: "-"
53       GitHTTP:
54         InternalURLs: {}
55         ExternalURL: ""
56       GitSSH:
57         InternalURLs: {}
58         ExternalURL: ""
59       DispatchCloud:
60         InternalURLs: {}
61         ExternalURL: "-"
62       SSO:
63         InternalURLs: {}
64         ExternalURL: ""
65       Keepproxy:
66         InternalURLs: {}
67         ExternalURL: ""
68       WebDAV:
69         InternalURLs: {}
70         # Base URL for Workbench inline preview.  If blank, use
71         # WebDAVDownload instead, and disable inline preview.
72         # If both are empty, downloading collections from workbench
73         # will be impossible.
74         #
75         # It is important to properly configure the download service
76         # to migitate cross-site-scripting (XSS) attacks.  A HTML page
77         # can be stored in collection.  If an attacker causes a victim
78         # to visit that page through Workbench, it will be rendered by
79         # the browser.  If all collections are served at the same
80         # domain, the browser will consider collections as coming from
81         # the same origin and having access to the same browsing data,
82         # enabling malicious Javascript on that page to access Arvados
83         # on behalf of the victim.
84         #
85         # This is mitigating by having separate domains for each
86         # collection, or limiting preview to circumstances where the
87         # collection is not accessed with the user's regular
88         # full-access token.
89         #
90         # Serve preview links using uuid or pdh in subdomain
91         # (requires wildcard DNS and TLS certificate)
92         #   https://*.collections.uuid_prefix.arvadosapi.com
93         #
94         # Serve preview links using uuid or pdh in main domain
95         # (requires wildcard DNS and TLS certificate)
96         #   https://*--collections.uuid_prefix.arvadosapi.com
97         #
98         # Serve preview links by setting uuid or pdh in the path.
99         # This configuration only allows previews of public data or
100         # collection-sharing links, because these use the anonymous
101         # user token or the token is already embedded in the URL.
102         # Other data must be handled as downloads via WebDAVDownload:
103         #   https://collections.uuid_prefix.arvadosapi.com
104         #
105         ExternalURL: ""
106
107       WebDAVDownload:
108         InternalURLs: {}
109         # Base URL for download links. If blank, serve links to WebDAV
110         # with disposition=attachment query param.  Unlike preview links,
111         # browsers do not render attachments, so there is no risk of XSS.
112         #
113         # If WebDAVDownload is blank, and WebDAV uses a
114         # single-origin form, then Workbench will show an error page
115         #
116         # Serve download links by setting uuid or pdh in the path:
117         #   https://download.uuid_prefix.arvadosapi.com
118         #
119         ExternalURL: ""
120
121       Keepstore:
122         InternalURLs: {}
123         ExternalURL: "-"
124       Composer:
125         InternalURLs: {}
126         ExternalURL: ""
127       WebShell:
128         InternalURLs: {}
129         # ShellInABox service endpoint URL for a given VM.  If empty, do not
130         # offer web shell logins.
131         #
132         # E.g., using a path-based proxy server to forward connections to shell hosts:
133         # https://webshell.uuid_prefix.arvadosapi.com
134         #
135         # E.g., using a name-based proxy server to forward connections to shell hosts:
136         # https://*.webshell.uuid_prefix.arvadosapi.com
137         ExternalURL: ""
138       Workbench1:
139         InternalURLs: {}
140         ExternalURL: ""
141       Workbench2:
142         InternalURLs: {}
143         ExternalURL: ""
144       Health:
145         InternalURLs: {}
146         ExternalURL: "-"
147
148     PostgreSQL:
149       # max concurrent connections per arvados server daemon
150       ConnectionPool: 32
151       Connection:
152         # All parameters here are passed to the PG client library in a connection string;
153         # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
154         host: ""
155         port: ""
156         user: ""
157         password: ""
158         dbname: ""
159         SAMPLE: ""
160     API:
161       # Maximum size (in bytes) allowed for a single API request.  This
162       # limit is published in the discovery document for use by clients.
163       # Note: You must separately configure the upstream web server or
164       # proxy to actually enforce the desired maximum request size on the
165       # server side.
166       MaxRequestSize: 134217728
167
168       # Limit the number of bytes read from the database during an index
169       # request (by retrieving and returning fewer rows than would
170       # normally be returned in a single response).
171       # Note 1: This setting never reduces the number of returned rows to
172       # zero, no matter how big the first data row is.
173       # Note 2: Currently, this is only checked against a specific set of
174       # columns that tend to get large (collections.manifest_text,
175       # containers.mounts, workflows.definition). Other fields (e.g.,
176       # "properties" hashes) are not counted against this limit.
177       MaxIndexDatabaseRead: 134217728
178
179       # Maximum number of items to return when responding to a APIs that
180       # can return partial result sets using limit and offset parameters
181       # (e.g., *.index, groups.contents). If a request specifies a "limit"
182       # parameter higher than this value, this value is used instead.
183       MaxItemsPerResponse: 1000
184
185       # Maximum number of concurrent requests to accept in a single
186       # service process, or 0 for no limit.
187       MaxConcurrentRequests: 0
188
189       # Maximum number of 64MiB memory buffers per Keepstore server process, or
190       # 0 for no limit. When this limit is reached, up to
191       # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
192       # buffers (like GET and PUT) will wait for buffer space to be released.
193       # Any HTTP requests beyond MaxConcurrentRequests will receive an
194       # immediate 503 response.
195       #
196       # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
197       # * 1.1) fits comfortably in memory. On a host dedicated to running
198       # Keepstore, divide total memory by 88MiB to suggest a suitable value.
199       # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
200       # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
201       MaxKeepBlobBuffers: 128
202
203       # API methods to disable. Disabled methods are not listed in the
204       # discovery document, and respond 404 to all requests.
205       # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
206       DisabledAPIs: {}
207
208       # Interval (seconds) between asynchronous permission view updates. Any
209       # permission-updating API called with the 'async' parameter schedules a an
210       # update on the permission view in the future, if not already scheduled.
211       AsyncPermissionsUpdateInterval: 20s
212
213       # Maximum number of concurrent outgoing requests to make while
214       # serving a single incoming multi-cluster (federated) request.
215       MaxRequestAmplification: 4
216
217       # Maximum wall clock time to spend handling an incoming request.
218       RequestTimeout: 5m
219
220       # Websocket will send a periodic empty event after 'SendTimeout'
221       # if there is no other activity to maintain the connection /
222       # detect dropped connections.
223       SendTimeout: 60s
224
225       WebsocketClientEventQueue: 64
226       WebsocketServerEventQueue: 4
227
228       # Timeout on requests to internal Keep services.
229       KeepServiceRequestTimeout: 15s
230
231     Users:
232       # Config parameters to automatically setup new users.  If enabled,
233       # this users will be able to self-activate.  Enable this if you want
234       # to run an open instance where anyone can create an account and use
235       # the system without requiring manual approval.
236       #
237       # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
238       # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
239       AutoSetupNewUsers: false
240       AutoSetupNewUsersWithVmUUID: ""
241       AutoSetupNewUsersWithRepository: false
242       AutoSetupUsernameBlacklist:
243         arvados: {}
244         git: {}
245         gitolite: {}
246         gitolite-admin: {}
247         root: {}
248         syslog: {}
249         SAMPLE: {}
250
251       # When NewUsersAreActive is set to true, new users will be active
252       # immediately.  This skips the "self-activate" step which enforces
253       # user agreements.  Should only be enabled for development.
254       NewUsersAreActive: false
255
256       # The e-mail address of the user you would like to become marked as an admin
257       # user on their first login.
258       AutoAdminUserWithEmail: ""
259
260       # If AutoAdminFirstUser is set to true, the first user to log in when no
261       # other admin users exist will automatically become an admin user.
262       AutoAdminFirstUser: false
263
264       # Email address to notify whenever a user creates a profile for the
265       # first time
266       UserProfileNotificationAddress: ""
267       AdminNotifierEmailFrom: arvados@example.com
268       EmailSubjectPrefix: "[ARVADOS] "
269       UserNotifierEmailFrom: arvados@example.com
270       NewUserNotificationRecipients: {}
271       NewInactiveUserNotificationRecipients: {}
272
273       # Set AnonymousUserToken to enable anonymous user access. Populate this
274       # field with a long random string. Then run "bundle exec
275       # ./script/get_anonymous_user_token.rb" in the directory where your API
276       # server is running to record the token in the database.
277       AnonymousUserToken: ""
278
279       # If a new user has an alternate email address (local@domain)
280       # with the domain given here, its local part becomes the new
281       # user's default username. Otherwise, the user's primary email
282       # address is used.
283       PreferDomainForUsername: ""
284
285       UserSetupMailText: |
286         <% if not @user.full_name.empty? -%>
287         <%= @user.full_name %>,
288         <% else -%>
289         Hi there,
290         <% end -%>
291
292         Your Arvados account has been set up.  You can log in at
293
294         <%= Rails.configuration.Services.Workbench1.ExternalURL %>
295
296         Thanks,
297         Your Arvados administrator.
298
299     AuditLogs:
300       # Time to keep audit logs, in seconds. (An audit log is a row added
301       # to the "logs" table in the PostgreSQL database each time an
302       # Arvados object is created, modified, or deleted.)
303       #
304       # Currently, websocket event notifications rely on audit logs, so
305       # this should not be set lower than 300 (5 minutes).
306       MaxAge: 336h
307
308       # Maximum number of log rows to delete in a single SQL transaction.
309       #
310       # If MaxDeleteBatch is 0, log entries will never be
311       # deleted by Arvados. Cleanup can be done by an external process
312       # without affecting any Arvados system processes, as long as very
313       # recent (<5 minutes old) logs are not deleted.
314       #
315       # 100000 is a reasonable batch size for most sites.
316       MaxDeleteBatch: 0
317
318       # Attributes to suppress in events and audit logs.  Notably,
319       # specifying {"manifest_text": {}} here typically makes the database
320       # smaller and faster.
321       #
322       # Warning: Using any non-empty value here can have undesirable side
323       # effects for any client or component that relies on event logs.
324       # Use at your own risk.
325       UnloggedAttributes: {}
326
327     SystemLogs:
328
329       # Logging threshold: panic, fatal, error, warn, info, debug, or
330       # trace
331       LogLevel: info
332
333       # Logging format: json or text
334       Format: json
335
336       # Maximum characters of (JSON-encoded) query parameters to include
337       # in each request log entry. When params exceed this size, they will
338       # be JSON-encoded, truncated to this size, and logged as
339       # params_truncated.
340       MaxRequestLogParamsSize: 2000
341
342     Collections:
343
344       # Enable access controls for data stored in Keep. This should
345       # always be set to true on a production cluster.
346       BlobSigning: true
347
348       # BlobSigningKey is a string of alphanumeric characters used to
349       # generate permission signatures for Keep locators. It must be
350       # identical to the permission key given to Keep. IMPORTANT: This
351       # is a site secret. It should be at least 50 characters.
352       #
353       # Modifying BlobSigningKey will invalidate all existing
354       # signatures, which can cause programs to fail (e.g., arv-put,
355       # arv-get, and Crunch jobs).  To avoid errors, rotate keys only
356       # when no such processes are running.
357       BlobSigningKey: ""
358
359       # Enable garbage collection of unreferenced blobs in Keep.
360       BlobTrash: true
361
362       # Time to leave unreferenced blobs in "trashed" state before
363       # deleting them, or 0 to skip the "trashed" state entirely and
364       # delete unreferenced blobs.
365       #
366       # If you use any Amazon S3 buckets as storage volumes, this
367       # must be at least 24h to avoid occasional data loss.
368       BlobTrashLifetime: 336h
369
370       # How often to check for (and delete) trashed blocks whose
371       # BlobTrashLifetime has expired.
372       BlobTrashCheckInterval: 24h
373
374       # Maximum number of concurrent "trash blob" and "delete trashed
375       # blob" operations conducted by a single keepstore process. Each
376       # of these can be set to 0 to disable the respective operation.
377       #
378       # If BlobTrashLifetime is zero, "trash" and "delete trash"
379       # happen at once, so only the lower of these two values is used.
380       BlobTrashConcurrency: 4
381       BlobDeleteConcurrency: 4
382
383       # Maximum number of concurrent "create additional replica of
384       # existing blob" operations conducted by a single keepstore
385       # process.
386       BlobReplicateConcurrency: 4
387
388       # Default replication level for collections. This is used when a
389       # collection's replication_desired attribute is nil.
390       DefaultReplication: 2
391
392       # BlobSigningTTL determines the minimum lifetime of transient
393       # data, i.e., blocks that are not referenced by
394       # collections. Unreferenced blocks exist for two reasons:
395       #
396       # 1) A data block must be written to a disk/cloud backend device
397       # before a collection can be created/updated with a reference to
398       # it.
399       #
400       # 2) Deleting or updating a collection can remove the last
401       # remaining reference to a data block.
402       #
403       # If BlobSigningTTL is too short, long-running
404       # processes/containers will fail when they take too long (a)
405       # between writing blocks and writing collections that reference
406       # them, or (b) between reading collections and reading the
407       # referenced blocks.
408       #
409       # If BlobSigningTTL is too long, data will still be stored long
410       # after the referring collections are deleted, and you will
411       # needlessly fill up disks or waste money on cloud storage.
412       #
413       # Modifying BlobSigningTTL invalidates existing signatures; see
414       # BlobSigningKey note above.
415       #
416       # The default is 2 weeks.
417       BlobSigningTTL: 336h
418
419       # When running keep-balance, this is the destination filename for
420       # the list of lost block hashes if there are any, one per line.
421       # Updated automically during each successful run.
422       BlobMissingReport: ""
423
424       # keep-balance operates periodically, i.e.: do a
425       # scan/balance operation, sleep, repeat.
426       #
427       # BalancePeriod determines the interval between start times of
428       # successive scan/balance operations. If a scan/balance operation
429       # takes longer than RunPeriod, the next one will follow it
430       # immediately.
431       #
432       # If SIGUSR1 is received during an idle period between operations,
433       # the next operation will start immediately.
434       BalancePeriod: 10m
435
436       # Limits the number of collections retrieved by keep-balance per
437       # API transaction. If this is zero, page size is
438       # determined by the API server's own page size limits (see
439       # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
440       BalanceCollectionBatch: 0
441
442       # The size of keep-balance's internal queue of
443       # collections. Higher values use more memory and improve throughput
444       # by allowing keep-balance to fetch the next page of collections
445       # while the current page is still being processed. If this is zero
446       # or omitted, pages are processed serially.
447       BalanceCollectionBuffers: 1000
448
449       # Maximum time for a rebalancing run. This ensures keep-balance
450       # eventually gives up and retries if, for example, a network
451       # error causes a hung connection that is never closed by the
452       # OS. It should be long enough that it doesn't interrupt a
453       # long-running balancing operation.
454       BalanceTimeout: 6h
455
456       # Default lifetime for ephemeral collections: 2 weeks. This must not
457       # be less than BlobSigningTTL.
458       DefaultTrashLifetime: 336h
459
460       # Interval (seconds) between trash sweeps. During a trash sweep,
461       # collections are marked as trash if their trash_at time has
462       # arrived, and deleted if their delete_at time has arrived.
463       TrashSweepInterval: 60s
464
465       # If true, enable collection versioning.
466       # When a collection's preserve_version field is true or the current version
467       # is older than the amount of seconds defined on PreserveVersionIfIdle,
468       # a snapshot of the collection's previous state is created and linked to
469       # the current collection.
470       CollectionVersioning: false
471
472       #   0s = auto-create a new version on every update.
473       #  -1s = never auto-create new versions.
474       # > 0s = auto-create a new version when older than the specified number of seconds.
475       PreserveVersionIfIdle: -1s
476
477       # If non-empty, allow project and collection names to contain
478       # the "/" character (slash/stroke/solidus), and replace "/" with
479       # the given string in the filesystem hierarchy presented by
480       # WebDAV. Example values are "%2f" and "{slash}". Names that
481       # contain the substitution string itself may result in confusing
482       # behavior, so a value like "_" is not recommended.
483       #
484       # If the default empty value is used, the server will reject
485       # requests to create or rename a collection when the new name
486       # contains "/".
487       #
488       # If the value "/" is used, project and collection names
489       # containing "/" will be allowed, but they will not be
490       # accessible via WebDAV.
491       #
492       # Use of this feature is not recommended, if it can be avoided.
493       ForwardSlashNameSubstitution: ""
494
495       # Include "folder objects" in S3 ListObjects responses.
496       S3FolderObjects: true
497
498       # Managed collection properties. At creation time, if the client didn't
499       # provide the listed keys, they will be automatically populated following
500       # one of the following behaviors:
501       #
502       # * UUID of the user who owns the containing project.
503       #   responsible_person_uuid: {Function: original_owner, Protected: true}
504       #
505       # * Default concrete value.
506       #   foo_bar: {Value: baz, Protected: false}
507       #
508       # If Protected is true, only an admin user can modify its value.
509       ManagedProperties:
510         SAMPLE: {Function: original_owner, Protected: true}
511
512       # In "trust all content" mode, Workbench will redirect download
513       # requests to WebDAV preview link, even in the cases when
514       # WebDAV would have to expose XSS vulnerabilities in order to
515       # handle the redirect (see discussion on Services.WebDAV).
516       #
517       # This setting has no effect in the recommended configuration,
518       # where the WebDAV is configured to have a separate domain for
519       # every collection; in this case XSS protection is provided by
520       # browsers' same-origin policy.
521       #
522       # The default setting (false) is appropriate for a multi-user site.
523       TrustAllContent: false
524
525       # Cache parameters for WebDAV content serving:
526       WebDAVCache:
527         # Time to cache manifests, permission checks, and sessions.
528         TTL: 300s
529
530         # Time to cache collection state.
531         UUIDTTL: 5s
532
533         # Block cache entries. Each block consumes up to 64 MiB RAM.
534         MaxBlockEntries: 4
535
536         # Collection cache entries.
537         MaxCollectionEntries: 1000
538
539         # Approximate memory limit (in bytes) for collection cache.
540         MaxCollectionBytes: 100000000
541
542         # Permission cache entries.
543         MaxPermissionEntries: 1000
544
545         # UUID cache entries.
546         MaxUUIDEntries: 1000
547
548         # Persistent sessions.
549         MaxSessions: 100
550
551     Login:
552       # One of the following mechanisms (SSO, Google, PAM, LDAP, or
553       # LoginCluster) should be enabled; see
554       # https://doc.arvados.org/install/setup-login.html
555
556       Google:
557         # Authenticate with Google.
558         Enable: false
559
560         # Use the Google Cloud console to enable the People API (APIs
561         # and Services > Enable APIs and services > Google People API
562         # > Enable), generate a Client ID and secret (APIs and
563         # Services > Credentials > Create credentials > OAuth client
564         # ID > Web application) and add your controller's /login URL
565         # (e.g., "https://zzzzz.example.com/login") as an authorized
566         # redirect URL.
567         #
568         # Incompatible with ForceLegacyAPI14. ProviderAppID must be
569         # blank.
570         ClientID: ""
571         ClientSecret: ""
572
573         # Allow users to log in to existing accounts using any verified
574         # email address listed by their Google account. If true, the
575         # Google People API must be enabled in order for Google login to
576         # work. If false, only the primary email address will be used.
577         AlternateEmailAddresses: true
578
579         # Send additional parameters with authentication requests. See
580         # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
581         # for a list of supported parameters.
582         AuthenticationRequestParameters:
583           # Show the "choose which Google account" page, even if the
584           # client is currently logged in to exactly one Google
585           # account.
586           prompt: select_account
587
588           SAMPLE: ""
589
590       OpenIDConnect:
591         # Authenticate with an OpenID Connect provider.
592         Enable: false
593
594         # Issuer URL, e.g., "https://login.example.com".
595         #
596         # This must be exactly equal to the URL returned by the issuer
597         # itself in its config response ("isser" key). If the
598         # configured value is "https://example" and the provider
599         # returns "https://example:443" or "https://example/" then
600         # login will fail, even though those URLs are equivalent
601         # (RFC3986).
602         Issuer: ""
603
604         # Your client ID and client secret (supplied by the provider).
605         ClientID: ""
606         ClientSecret: ""
607
608         # OpenID claim field containing the user's email
609         # address. Normally "email"; see
610         # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
611         EmailClaim: "email"
612
613         # OpenID claim field containing the email verification
614         # flag. Normally "email_verified".  To accept every returned
615         # email address without checking a "verified" field at all,
616         # use the empty string "".
617         EmailVerifiedClaim: "email_verified"
618
619         # OpenID claim field containing the user's preferred
620         # username. If empty, use the mailbox part of the user's email
621         # address.
622         UsernameClaim: ""
623
624         # Send additional parameters with authentication requests,
625         # like {display: page, prompt: consent}. See
626         # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
627         # and refer to your provider's documentation for supported
628         # parameters.
629         AuthenticationRequestParameters:
630           SAMPLE: ""
631
632       PAM:
633         # (Experimental) Use PAM to authenticate users.
634         Enable: false
635
636         # PAM service name. PAM will apply the policy in the
637         # corresponding config file (e.g., /etc/pam.d/arvados) or, if
638         # there is none, the default "other" config.
639         Service: arvados
640
641         # Domain name (e.g., "example.com") to use to construct the
642         # user's email address if PAM authentication returns a
643         # username with no "@". If empty, use the PAM username as the
644         # user's email address, whether or not it contains "@".
645         #
646         # Note that the email address is used as the primary key for
647         # user records when logging in. Therefore, if you change
648         # PAMDefaultEmailDomain after the initial installation, you
649         # should also update existing user records to reflect the new
650         # domain. Otherwise, next time those users log in, they will
651         # be given new accounts instead of accessing their existing
652         # accounts.
653         DefaultEmailDomain: ""
654
655       LDAP:
656         # Use an LDAP service to authenticate users.
657         Enable: false
658
659         # Server URL, like "ldap://ldapserver.example.com:389" or
660         # "ldaps://ldapserver.example.com:636".
661         URL: "ldap://ldap:389"
662
663         # Use StartTLS upon connecting to the server.
664         StartTLS: true
665
666         # Skip TLS certificate name verification.
667         InsecureTLS: false
668
669         # Strip the @domain part if a user supplies an email-style
670         # username with this domain. If "*", strip any user-provided
671         # domain. If "", never strip the domain part. Example:
672         # "example.com"
673         StripDomain: ""
674
675         # If, after applying StripDomain, the username contains no "@"
676         # character, append this domain to form an email-style
677         # username. Example: "example.com"
678         AppendDomain: ""
679
680         # The LDAP attribute to filter on when looking up a username
681         # (after applying StripDomain and AppendDomain).
682         SearchAttribute: uid
683
684         # Bind with this username (DN or UPN) and password when
685         # looking up the user record.
686         #
687         # Example user: "cn=admin,dc=example,dc=com"
688         SearchBindUser: ""
689         SearchBindPassword: ""
690
691         # Directory base for username lookup. Example:
692         # "ou=Users,dc=example,dc=com"
693         SearchBase: ""
694
695         # Additional filters to apply when looking up users' LDAP
696         # entries. This can be used to restrict access to a subset of
697         # LDAP users, or to disambiguate users from other directory
698         # entries that have the SearchAttribute present.
699         #
700         # Special characters in assertion values must be escaped (see
701         # RFC4515).
702         #
703         # Example: "(objectClass=person)"
704         SearchFilters: ""
705
706         # LDAP attribute to use as the user's email address.
707         #
708         # Important: This must not be an attribute whose value can be
709         # edited in the directory by the users themselves. Otherwise,
710         # users can take over other users' Arvados accounts trivially
711         # (email address is the primary key for Arvados accounts.)
712         EmailAttribute: mail
713
714         # LDAP attribute to use as the preferred Arvados username. If
715         # no value is found (or this config is empty) the username
716         # originally supplied by the user will be used.
717         UsernameAttribute: uid
718
719       SSO:
720         # Authenticate with a separate SSO server. (Deprecated)
721         Enable: false
722
723         # ProviderAppID and ProviderAppSecret are generated during SSO
724         # setup; see
725         # https://doc.arvados.org/v2.0/install/install-sso.html#update-config
726         ProviderAppID: ""
727         ProviderAppSecret: ""
728
729       Test:
730         # Authenticate users listed here in the config file. This
731         # feature is intended to be used in test environments, and
732         # should not be used in production.
733         Enable: false
734         Users:
735           SAMPLE:
736             Email: alice@example.com
737             Password: xyzzy
738
739       # The cluster ID to delegate the user database.  When set,
740       # logins on this cluster will be redirected to the login cluster
741       # (login cluster must appear in RemoteClusters with Proxy: true)
742       LoginCluster: ""
743
744       # How long a cached token belonging to a remote cluster will
745       # remain valid before it needs to be revalidated.
746       RemoteTokenRefresh: 5m
747
748       # How long a client token created from a login flow will be valid without
749       # asking the user to re-login. Example values: 60m, 8h.
750       # Default value zero means tokens don't have expiration.
751       TokenLifetime: 0s
752
753       # When the token is returned to a client, the token itself may
754       # be restricted from manipulating other tokens based on whether
755       # the client is "trusted" or not.  The local Workbench1 and
756       # Workbench2 are trusted by default, but if this is a
757       # LoginCluster, you probably want to include the other Workbench
758       # instances in the federation in this list.
759       TrustedClients:
760         SAMPLE:
761           "https://workbench.federate1.example": {}
762           "https://workbench.federate2.example": {}
763
764     Git:
765       # Path to git or gitolite-shell executable. Each authenticated
766       # request will execute this program with the single argument "http-backend"
767       GitCommand: /usr/bin/git
768
769       # Path to Gitolite's home directory. If a non-empty path is given,
770       # the CGI environment will be set up to support the use of
771       # gitolite-shell as a GitCommand: for example, if GitoliteHome is
772       # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
773       # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
774       GitoliteHome: ""
775
776       # Git repositories must be readable by api server, or you won't be
777       # able to submit crunch jobs. To pass the test suites, put a clone
778       # of the arvados tree in {git_repositories_dir}/arvados.git or
779       # {git_repositories_dir}/arvados/.git
780       Repositories: /var/lib/arvados/git/repositories
781
782     TLS:
783       Certificate: ""
784       Key: ""
785       Insecure: false
786
787     Containers:
788       # List of supported Docker Registry image formats that compute nodes
789       # are able to use. `arv keep docker` will error out if a user tries
790       # to store an image with an unsupported format. Use an empty array
791       # to skip the compatibility check (and display a warning message to
792       # that effect).
793       #
794       # Example for sites running docker < 1.10: {"v1": {}}
795       # Example for sites running docker >= 1.10: {"v2": {}}
796       # Example for disabling check: {}
797       SupportedDockerImageFormats:
798         "v2": {}
799         SAMPLE: {}
800
801       # Include details about job reuse decisions in the server log. This
802       # causes additional database queries to run, so it should not be
803       # enabled unless you expect to examine the resulting logs for
804       # troubleshooting purposes.
805       LogReuseDecisions: false
806
807       # Default value for keep_cache_ram of a container's runtime_constraints.
808       DefaultKeepCacheRAM: 268435456
809
810       # Number of times a container can be unlocked before being
811       # automatically cancelled.
812       MaxDispatchAttempts: 5
813
814       # Default value for container_count_max for container requests.  This is the
815       # number of times Arvados will create a new container to satisfy a container
816       # request.  If a container is cancelled it will retry a new container if
817       # container_count < container_count_max on any container requests associated
818       # with the cancelled container.
819       MaxRetryAttempts: 3
820
821       # The maximum number of compute nodes that can be in use simultaneously
822       # If this limit is reduced, any existing nodes with slot number >= new limit
823       # will not be counted against the new limit. In other words, the new limit
824       # won't be strictly enforced until those nodes with higher slot numbers
825       # go down.
826       MaxComputeVMs: 64
827
828       # Preemptible instance support (e.g. AWS Spot Instances)
829       # When true, child containers will get created with the preemptible
830       # scheduling parameter parameter set.
831       UsePreemptibleInstances: false
832
833       # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
834       # (experimental) cloud dispatcher for executing containers on
835       # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
836       # and ends with "\n-----END RSA PRIVATE KEY-----\n".
837       DispatchPrivateKey: ""
838
839       # Maximum time to wait for workers to come up before abandoning
840       # stale locks from a previous dispatch process.
841       StaleLockTimeout: 1m
842
843       # The crunch-run command to manage the container on a node
844       CrunchRunCommand: "crunch-run"
845
846       # Extra arguments to add to crunch-run invocation
847       # Example: ["--cgroup-parent-subsystem=memory"]
848       CrunchRunArgumentsList: []
849
850       # Extra RAM to reserve on the node, in addition to
851       # the amount specified in the container's RuntimeConstraints
852       ReserveExtraRAM: 256MiB
853
854       # Minimum time between two attempts to run the same container
855       MinRetryPeriod: 0s
856
857       Logging:
858         # When you run the db:delete_old_container_logs task, it will find
859         # containers that have been finished for at least this many seconds,
860         # and delete their stdout, stderr, arv-mount, crunch-run, and
861         # crunchstat logs from the logs table.
862         MaxAge: 720h
863
864         # These two settings control how frequently log events are flushed to the
865         # database.  Log lines are buffered until either crunch_log_bytes_per_event
866         # has been reached or crunch_log_seconds_between_events has elapsed since
867         # the last flush.
868         LogBytesPerEvent: 4096
869         LogSecondsBetweenEvents: 5s
870
871         # The sample period for throttling logs.
872         LogThrottlePeriod: 60s
873
874         # Maximum number of bytes that job can log over crunch_log_throttle_period
875         # before being silenced until the end of the period.
876         LogThrottleBytes: 65536
877
878         # Maximum number of lines that job can log over crunch_log_throttle_period
879         # before being silenced until the end of the period.
880         LogThrottleLines: 1024
881
882         # Maximum bytes that may be logged by a single job.  Log bytes that are
883         # silenced by throttling are not counted against this total.
884         LimitLogBytesPerJob: 67108864
885
886         LogPartialLineThrottlePeriod: 5s
887
888         # Container logs are written to Keep and saved in a
889         # collection, which is updated periodically while the
890         # container runs.  This value sets the interval between
891         # collection updates.
892         LogUpdatePeriod: 30m
893
894         # The log collection is also updated when the specified amount of
895         # log data (given in bytes) is produced in less than one update
896         # period.
897         LogUpdateSize: 32MiB
898
899       ShellAccess:
900         # An admin user can use "arvados-client shell" to start an
901         # interactive shell (with any user ID) in any running
902         # container.
903         Admin: false
904
905         # Any user can use "arvados-client shell" to start an
906         # interactive shell (with any user ID) in any running
907         # container that they started, provided it isn't also
908         # associated with a different user's container request.
909         #
910         # Interactive sessions make it easy to alter the container's
911         # runtime environment in ways that aren't recorded or
912         # reproducible. Consider the implications for automatic
913         # container reuse before enabling and using this feature. In
914         # particular, note that starting an interactive session does
915         # not disqualify a container from being reused by a different
916         # user/workflow in the future.
917         User: false
918
919       SLURM:
920         PrioritySpread: 0
921         SbatchArgumentsList: []
922         SbatchEnvironmentVariables:
923           SAMPLE: ""
924         Managed:
925           # Path to dns server configuration directory
926           # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
927           # files or touch restart.txt (see below).
928           DNSServerConfDir: ""
929
930           # Template file for the dns server host snippets. See
931           # unbound.template in this directory for an example. If false, do
932           # not write any config files.
933           DNSServerConfTemplate: ""
934
935           # String to write to {dns_server_conf_dir}/restart.txt (with a
936           # trailing newline) after updating local data. If false, do not
937           # open or write the restart.txt file.
938           DNSServerReloadCommand: ""
939
940           # Command to run after each DNS update. Template variables will be
941           # substituted; see the "unbound" example below. If false, do not run
942           # a command.
943           DNSServerUpdateCommand: ""
944
945           ComputeNodeDomain: ""
946           ComputeNodeNameservers:
947             "192.168.1.1": {}
948             SAMPLE: {}
949
950           # Hostname to assign to a compute node when it sends a "ping" and the
951           # hostname in its Node record is nil.
952           # During bootstrapping, the "ping" script is expected to notice the
953           # hostname given in the ping response, and update its unix hostname
954           # accordingly.
955           # If false, leave the hostname alone (this is appropriate if your compute
956           # nodes' hostnames are already assigned by some other mechanism).
957           #
958           # One way or another, the hostnames of your node records should agree
959           # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
960           #
961           # Example for compute0000, compute0001, ....:
962           # assign_node_hostname: compute%<slot_number>04d
963           # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
964           AssignNodeHostname: "compute%<slot_number>d"
965
966       JobsAPI:
967         # Enable the legacy 'jobs' API (crunch v1).  This value must be a string.
968         #
969         # Note: this only enables read-only access, creating new
970         # legacy jobs and pipelines is not supported.
971         #
972         # 'auto' -- (default) enable the Jobs API only if it has been used before
973         #         (i.e., there are job records in the database)
974         # 'true' -- enable the Jobs API despite lack of existing records.
975         # 'false' -- disable the Jobs API despite presence of existing records.
976         Enable: 'auto'
977
978         # Git repositories must be readable by api server, or you won't be
979         # able to submit crunch jobs. To pass the test suites, put a clone
980         # of the arvados tree in {git_repositories_dir}/arvados.git or
981         # {git_repositories_dir}/arvados/.git
982         GitInternalDir: /var/lib/arvados/internal.git
983
984       CloudVMs:
985         # Enable the cloud scheduler (experimental).
986         Enable: false
987
988         # Name/number of port where workers' SSH services listen.
989         SSHPort: "22"
990
991         # Interval between queue polls.
992         PollInterval: 10s
993
994         # Shell command to execute on each worker to determine whether
995         # the worker is booted and ready to run containers. It should
996         # exit zero if the worker is ready.
997         BootProbeCommand: "docker ps -q"
998
999         # Minimum interval between consecutive probes to a single
1000         # worker.
1001         ProbeInterval: 10s
1002
1003         # Maximum probes per second, across all workers in a pool.
1004         MaxProbesPerSecond: 10
1005
1006         # Time before repeating SIGTERM when killing a container.
1007         TimeoutSignal: 5s
1008
1009         # Time to give up on a process (most likely arv-mount) that
1010         # still holds a container lockfile after its main supervisor
1011         # process has exited, and declare the instance broken.
1012         TimeoutStaleRunLock: 5s
1013
1014         # Time to give up on SIGTERM and write off the worker.
1015         TimeoutTERM: 2m
1016
1017         # Maximum create/destroy-instance operations per second (0 =
1018         # unlimited).
1019         MaxCloudOpsPerSecond: 0
1020
1021         # Maximum concurrent node creation operations (0 = unlimited). This is
1022         # recommended by Azure in certain scenarios (see
1023         # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image)
1024         # and can be used with other cloud providers too, if desired.
1025         MaxConcurrentInstanceCreateOps: 0
1026
1027         # Interval between cloud provider syncs/updates ("list all
1028         # instances").
1029         SyncInterval: 1m
1030
1031         # Time to leave an idle worker running (in case new containers
1032         # appear in the queue that it can run) before shutting it
1033         # down.
1034         TimeoutIdle: 1m
1035
1036         # Time to wait for a new worker to boot (i.e., pass
1037         # BootProbeCommand) before giving up and shutting it down.
1038         TimeoutBooting: 10m
1039
1040         # Maximum time a worker can stay alive with no successful
1041         # probes before being automatically shut down.
1042         TimeoutProbe: 10m
1043
1044         # Time after shutting down a worker to retry the
1045         # shutdown/destroy operation.
1046         TimeoutShutdown: 10s
1047
1048         # Worker VM image ID.
1049         # (aws) AMI identifier
1050         # (azure) managed disks: the name of the managed disk image
1051         # (azure) shared image gallery: the name of the image definition. Also
1052         # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1053         # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1054         # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1055         ImageID: ""
1056
1057         # An executable file (located on the dispatcher host) to be
1058         # copied to cloud instances at runtime and used as the
1059         # container runner/supervisor. The default value is the
1060         # dispatcher program itself.
1061         #
1062         # Use the empty string to disable this step: nothing will be
1063         # copied, and cloud instances are assumed to have a suitable
1064         # version of crunch-run installed.
1065         DeployRunnerBinary: "/proc/self/exe"
1066
1067         # Tags to add on all resources (VMs, NICs, disks) created by
1068         # the container dispatcher. (Arvados's own tags --
1069         # InstanceType, IdleBehavior, and InstanceSecret -- will also
1070         # be added.)
1071         ResourceTags:
1072           SAMPLE: "tag value"
1073
1074         # Prefix for predefined tags used by Arvados (InstanceSetID,
1075         # InstanceType, InstanceSecret, IdleBehavior). With the
1076         # default value "Arvados", tags are "ArvadosInstanceSetID",
1077         # "ArvadosInstanceSecret", etc.
1078         #
1079         # This should only be changed while no cloud resources are in
1080         # use and the cloud dispatcher is not running. Otherwise,
1081         # VMs/resources that were added using the old tag prefix will
1082         # need to be detected and cleaned up manually.
1083         TagKeyPrefix: Arvados
1084
1085         # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1086         Driver: ec2
1087
1088         # Cloud-specific driver parameters.
1089         DriverParameters:
1090
1091           # (ec2) Credentials. Omit or leave blank if using IAM role.
1092           AccessKeyID: ""
1093           SecretAccessKey: ""
1094
1095           # (ec2) Instance configuration.
1096           SecurityGroupIDs:
1097             "SAMPLE": {}
1098           SubnetID: ""
1099           Region: ""
1100           EBSVolumeType: gp2
1101           AdminUsername: debian
1102
1103           # (azure) Credentials.
1104           SubscriptionID: ""
1105           ClientID: ""
1106           ClientSecret: ""
1107           TenantID: ""
1108
1109           # (azure) Instance configuration.
1110           CloudEnvironment: AzurePublicCloud
1111           Location: centralus
1112
1113           # (azure) The resource group where the VM and virtual NIC will be
1114           # created.
1115           ResourceGroup: ""
1116
1117           # (azure) The resource group of the Network to use for the virtual
1118           # NIC (if different from ResourceGroup)
1119           NetworkResourceGroup: ""
1120           Network: ""
1121           Subnet: ""
1122
1123           # (azure) managed disks: The resource group where the managed disk
1124           # image can be found (if different from ResourceGroup).
1125           ImageResourceGroup: ""
1126
1127           # (azure) shared image gallery: the name of the gallery
1128           SharedImageGalleryName: ""
1129           # (azure) shared image gallery: the version of the image definition
1130           SharedImageGalleryImageVersion: ""
1131
1132           # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1133           StorageAccount: ""
1134           BlobContainer: ""
1135
1136           # (azure) How long to wait before deleting VHD and NIC
1137           # objects that are no longer being used.
1138           DeleteDanglingResourcesAfter: 20s
1139
1140           # Account (that already exists in the VM image) that will be
1141           # set up with an ssh authorized key to allow the compute
1142           # dispatcher to connect.
1143           AdminUsername: arvados
1144
1145     InstanceTypes:
1146
1147       # Use the instance type name as the key (in place of "SAMPLE" in
1148       # this sample entry).
1149       SAMPLE:
1150         # Cloud provider's instance type. Defaults to the configured type name.
1151         ProviderType: ""
1152         VCPUs: 1
1153         RAM: 128MiB
1154         IncludedScratch: 16GB
1155         AddedScratch: 0
1156         Price: 0.1
1157         Preemptible: false
1158
1159     Volumes:
1160       SAMPLE:
1161         # AccessViaHosts specifies which keepstore processes can read
1162         # and write data on the volume.
1163         #
1164         # For a local filesystem, AccessViaHosts has one entry,
1165         # indicating which server the filesystem is located on.
1166         #
1167         # For a network-attached backend accessible by all keepstore
1168         # servers, like a cloud storage bucket or an NFS mount,
1169         # AccessViaHosts can be empty/omitted.
1170         #
1171         # Further info/examples:
1172         # https://doc.arvados.org/install/configure-fs-storage.html
1173         # https://doc.arvados.org/install/configure-s3-object-storage.html
1174         # https://doc.arvados.org/install/configure-azure-blob-storage.html
1175         AccessViaHosts:
1176           SAMPLE:
1177             ReadOnly: false
1178           "http://host1.example:25107": {}
1179         ReadOnly: false
1180         Replication: 1
1181         StorageClasses:
1182           default: true
1183           SAMPLE: true
1184         Driver: s3
1185         DriverParameters:
1186           # for s3 driver -- see
1187           # https://doc.arvados.org/install/configure-s3-object-storage.html
1188           IAMRole: aaaaa
1189           AccessKey: aaaaa
1190           SecretKey: aaaaa
1191           Endpoint: ""
1192           Region: us-east-1a
1193           Bucket: aaaaa
1194           LocationConstraint: false
1195           V2Signature: false
1196           IndexPageSize: 1000
1197           ConnectTimeout: 1m
1198           ReadTimeout: 10m
1199           RaceWindow: 24h
1200           # Use aws-s3-go (v2) instead of goamz
1201           UseAWSS3v2Driver: false
1202
1203           # For S3 driver, potentially unsafe tuning parameter,
1204           # intentionally excluded from main documentation.
1205           #
1206           # Enable deletion (garbage collection) even when the
1207           # configured BlobTrashLifetime is zero.  WARNING: eventual
1208           # consistency may result in race conditions that can cause
1209           # data loss.  Do not enable this unless you understand and
1210           # accept the risk.
1211           UnsafeDelete: false
1212
1213           # for azure driver -- see
1214           # https://doc.arvados.org/install/configure-azure-blob-storage.html
1215           StorageAccountName: aaaaa
1216           StorageAccountKey: aaaaa
1217           StorageBaseURL: core.windows.net
1218           ContainerName: aaaaa
1219           RequestTimeout: 30s
1220           ListBlobsRetryDelay: 10s
1221           ListBlobsMaxAttempts: 10
1222           MaxGetBytes: 0
1223           WriteRaceInterval: 15s
1224           WriteRacePollTime: 1s
1225
1226           # for local directory driver -- see
1227           # https://doc.arvados.org/install/configure-fs-storage.html
1228           Root: /var/lib/arvados/keep-data
1229
1230           # For local directory driver, potentially confusing tuning
1231           # parameter, intentionally excluded from main documentation.
1232           #
1233           # When true, read and write operations (for whole 64MiB
1234           # blocks) on an individual volume will queued and issued
1235           # serially.  When false, read and write operations will be
1236           # issued concurrently.
1237           #
1238           # May possibly improve throughput if you have physical spinning disks
1239           # and experience contention when there are multiple requests
1240           # to the same volume.
1241           #
1242           # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1243           # should leave this alone.
1244           Serialize: false
1245
1246     Mail:
1247       MailchimpAPIKey: ""
1248       MailchimpListID: ""
1249       SendUserSetupNotificationEmail: true
1250
1251       # Bug/issue report notification to and from addresses
1252       IssueReporterEmailFrom: "arvados@example.com"
1253       IssueReporterEmailTo: "arvados@example.com"
1254       SupportEmailAddress: "arvados@example.com"
1255
1256       # Generic issue email from
1257       EmailFrom: "arvados@example.com"
1258     RemoteClusters:
1259       "*":
1260         Host: ""
1261         Proxy: false
1262         Scheme: https
1263         Insecure: false
1264         ActivateUsers: false
1265       SAMPLE:
1266         # API endpoint host or host:port; default is {id}.arvadosapi.com
1267         Host: sample.arvadosapi.com
1268
1269         # Perform a proxy request when a local client requests an
1270         # object belonging to this remote.
1271         Proxy: false
1272
1273         # Default "https". Can be set to "http" for testing.
1274         Scheme: https
1275
1276         # Disable TLS verify. Can be set to true for testing.
1277         Insecure: false
1278
1279         # When users present tokens issued by this remote cluster, and
1280         # their accounts are active on the remote cluster, activate
1281         # them on this cluster too.
1282         ActivateUsers: false
1283
1284     Workbench:
1285       # Workbench1 configs
1286       Theme: default
1287       ActivationContactLink: mailto:info@arvados.org
1288       ArvadosDocsite: https://doc.arvados.org
1289       ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1290       ShowUserAgreementInline: false
1291       SecretKeyBase: ""
1292
1293       # Scratch directory used by the remote repository browsing
1294       # feature. If it doesn't exist, it (and any missing parents) will be
1295       # created using mkdir_p.
1296       RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1297
1298       # Below is a sample setting of user_profile_form_fields config parameter.
1299       # This configuration parameter should be set to either false (to disable) or
1300       # to a map as shown below.
1301       # Configure the map of input fields to be displayed in the profile page
1302       # using the attribute "key" for each of the input fields.
1303       # This sample shows configuration with one required and one optional form fields.
1304       # For each of these input fields:
1305       #   You can specify "Type" as "text" or "select".
1306       #   List the "Options" to be displayed for each of the "select" menu.
1307       #   Set "Required" as "true" for any of these fields to make them required.
1308       # If any of the required fields are missing in the user's profile, the user will be
1309       # redirected to the profile page before they can access any Workbench features.
1310       UserProfileFormFields:
1311         SAMPLE:
1312           Type: select
1313           FormFieldTitle: Best color
1314           FormFieldDescription: your favorite color
1315           Required: false
1316           Position: 1
1317           Options:
1318             red: {}
1319             blue: {}
1320             green: {}
1321             SAMPLE: {}
1322
1323         # exampleTextValue:  # key that will be set in properties
1324         #   Type: text  #
1325         #   FormFieldTitle: ""
1326         #   FormFieldDescription: ""
1327         #   Required: true
1328         #   Position: 1
1329         # exampleOptionsValue:
1330         #   Type: select
1331         #   FormFieldTitle: ""
1332         #   FormFieldDescription: ""
1333         #   Required: true
1334         #   Position: 1
1335         #   Options:
1336         #     red: {}
1337         #     blue: {}
1338         #     yellow: {}
1339
1340       # Use "UserProfileFormMessage to configure the message you want
1341       # to display on the profile page.
1342       UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1343
1344       # Mimetypes of applications for which the view icon
1345       # would be enabled in a collection's show page.
1346       # It is sufficient to list only applications here.
1347       # No need to list text and image types.
1348       ApplicationMimetypesWithViewIcon:
1349         cwl: {}
1350         fasta: {}
1351         go: {}
1352         javascript: {}
1353         json: {}
1354         pdf: {}
1355         python: {}
1356         x-python: {}
1357         r: {}
1358         rtf: {}
1359         sam: {}
1360         x-sh: {}
1361         vnd.realvnc.bed: {}
1362         xml: {}
1363         xsl: {}
1364         SAMPLE: {}
1365
1366       # The maximum number of bytes to load in the log viewer
1367       LogViewerMaxBytes: 1M
1368
1369       # When anonymous_user_token is configured, show public projects page
1370       EnablePublicProjectsPage: true
1371
1372       # By default, disable the "Getting Started" popup which is specific to Arvados playground
1373       EnableGettingStartedPopup: false
1374
1375       # Ask Arvados API server to compress its response payloads.
1376       APIResponseCompression: true
1377
1378       # Timeouts for API requests.
1379       APIClientConnectTimeout: 2m
1380       APIClientReceiveTimeout: 5m
1381
1382       # Maximum number of historic log records of a running job to fetch
1383       # and display in the Log tab, while subscribing to web sockets.
1384       RunningJobLogRecordsToFetch: 2000
1385
1386       # In systems with many shared projects, loading of dashboard and topnav
1387       # can be slow due to collections indexing; use the following parameters
1388       # to suppress these properties
1389       ShowRecentCollectionsOnDashboard: true
1390       ShowUserNotifications: true
1391
1392       # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1393       # a link to the multi-site search page on a "home" Workbench site.
1394       #
1395       # Example:
1396       #   https://workbench.zzzzz.arvadosapi.com/collections/multisite
1397       MultiSiteSearch: ""
1398
1399       # Should workbench allow management of local git repositories? Set to false if
1400       # the jobs api is disabled and there are no local git repositories.
1401       Repositories: true
1402
1403       SiteName: Arvados Workbench
1404       ProfilingEnabled: false
1405
1406       # This is related to obsolete Google OpenID 1.0 login
1407       # but some workbench stuff still expects it to be set.
1408       DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1409
1410       # Workbench2 configs
1411       VocabularyURL: ""
1412       FileViewersConfigURL: ""
1413
1414       # Idle time after which the user's session will be auto closed.
1415       # This feature is disabled when set to zero.
1416       IdleTimeout: 0s
1417
1418       # Workbench welcome screen, this is HTML text that will be
1419       # incorporated directly onto the page.
1420       WelcomePageHTML: |
1421         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1422         <h2>Please log in.</h2>
1423
1424         <p>The "Log in" button below will show you a sign-in
1425         page. After you log in, you will be redirected back to
1426         Arvados Workbench.</p>
1427
1428         <p>If you have never used Arvados Workbench before, logging in
1429         for the first time will automatically create a new
1430         account.</p>
1431
1432         <i>Arvados Workbench uses your name and email address only for
1433         identification, and does not retrieve any other personal
1434         information.</i>
1435
1436       # Workbench screen displayed to inactive users.  This is HTML
1437       # text that will be incorporated directly onto the page.
1438       InactivePageHTML: |
1439         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1440         <h3>Hi! You're logged in, but...</h3>
1441         <p>Your account is inactive.</p>
1442         <p>An administrator must activate your account before you can get
1443         any further.</p>
1444
1445       # Connecting to Arvados shell VMs tends to be site-specific.
1446       # Put any special instructions here. This is HTML text that will
1447       # be incorporated directly onto the Workbench page.
1448       SSHHelpPageHTML: |
1449         <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1450         Site configurations vary.  Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1451
1452       # Sample text if you are using a "switchyard" ssh proxy.
1453       # Replace "zzzzz" with your Cluster ID.
1454       #SSHHelpPageHTML: |
1455       # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1456       # <pre>Host *.zzzzz
1457       #  TCPKeepAlive yes
1458       #  ServerAliveInterval 60
1459       #  ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1460       # </pre>
1461
1462       # If you are using a switchyard ssh proxy, shell node hostnames
1463       # may require a special hostname suffix.  In the sample ssh
1464       # configuration above, this would be ".zzzzz"
1465       # This is added to the hostname in the "command line" column
1466       # the Workbench "shell VMs" page.
1467       #
1468       # If your shell nodes are directly accessible by users without a
1469       # proxy and have fully qualified host names, you should leave
1470       # this blank.
1471       SSHHelpHostSuffix: ""
1472
1473     # Bypass new (Arvados 1.5) API implementations, and hand off
1474     # requests directly to Rails instead. This can provide a temporary
1475     # workaround for clients that are incompatible with the new API
1476     # implementation. Note that it also disables some new federation
1477     # features and will be removed in a future release.
1478     ForceLegacyAPI14: false
1479
1480 # (Experimental) Restart services automatically when config file
1481 # changes are detected. Only supported by `arvados-server boot` in
1482 # dev/test mode.
1483 AutoReloadConfig: false