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