Merge branch '17335-backport-2.1' into 2.1-dev
[arvados.git] / lib / config / generated_config.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 package config
6
7 var DefaultYAML = []byte(`# Copyright (C) The Arvados Authors. All rights reserved.
8 #
9 # SPDX-License-Identifier: AGPL-3.0
10
11 # Do not use this file for site configuration. Create
12 # /etc/arvados/config.yml instead.
13 #
14 # The order of precedence (highest to lowest):
15 # 1. Legacy component-specific config files (deprecated)
16 # 2. /etc/arvados/config.yml
17 # 3. config.default.yml
18
19 Clusters:
20   xxxxx:
21     SystemRootToken: ""
22
23     # Token to be included in all healthcheck requests. Disabled by default.
24     # Server expects request header of the format "Authorization: Bearer xxx"
25     ManagementToken: ""
26
27     Services:
28
29       # In each of the service sections below, the keys under
30       # InternalURLs are the endpoints where the service should be
31       # listening, and reachable from other hosts in the cluster.
32       SAMPLE:
33         InternalURLs:
34           "http://host1.example:12345": {}
35           "http://host2.example:12345":
36             # Rendezvous is normally empty/omitted. When changing the
37             # URL of a Keepstore service, Rendezvous should be set to
38             # the old URL (with trailing slash omitted) to preserve
39             # rendezvous ordering.
40             Rendezvous: ""
41           SAMPLE:
42             Rendezvous: ""
43         ExternalURL: "-"
44
45       RailsAPI:
46         InternalURLs: {}
47         ExternalURL: "-"
48       Controller:
49         InternalURLs: {}
50         ExternalURL: ""
51       Websocket:
52         InternalURLs: {}
53         ExternalURL: ""
54       Keepbalance:
55         InternalURLs: {}
56         ExternalURL: "-"
57       GitHTTP:
58         InternalURLs: {}
59         ExternalURL: ""
60       GitSSH:
61         InternalURLs: {}
62         ExternalURL: ""
63       DispatchCloud:
64         InternalURLs: {}
65         ExternalURL: "-"
66       SSO:
67         InternalURLs: {}
68         ExternalURL: ""
69       Keepproxy:
70         InternalURLs: {}
71         ExternalURL: ""
72       WebDAV:
73         InternalURLs: {}
74         # Base URL for Workbench inline preview.  If blank, use
75         # WebDAVDownload instead, and disable inline preview.
76         # If both are empty, downloading collections from workbench
77         # will be impossible.
78         #
79         # It is important to properly configure the download service
80         # to migitate cross-site-scripting (XSS) attacks.  A HTML page
81         # can be stored in collection.  If an attacker causes a victim
82         # to visit that page through Workbench, it will be rendered by
83         # the browser.  If all collections are served at the same
84         # domain, the browser will consider collections as coming from
85         # the same origin and having access to the same browsing data,
86         # enabling malicious Javascript on that page to access Arvados
87         # on behalf of the victim.
88         #
89         # This is mitigating by having separate domains for each
90         # collection, or limiting preview to circumstances where the
91         # collection is not accessed with the user's regular
92         # full-access token.
93         #
94         # Serve preview links using uuid or pdh in subdomain
95         # (requires wildcard DNS and TLS certificate)
96         #   https://*.collections.uuid_prefix.arvadosapi.com
97         #
98         # Serve preview links using uuid or pdh in main domain
99         # (requires wildcard DNS and TLS certificate)
100         #   https://*--collections.uuid_prefix.arvadosapi.com
101         #
102         # Serve preview links by setting uuid or pdh in the path.
103         # This configuration only allows previews of public data or
104         # collection-sharing links, because these use the anonymous
105         # user token or the token is already embedded in the URL.
106         # Other data must be handled as downloads via WebDAVDownload:
107         #   https://collections.uuid_prefix.arvadosapi.com
108         #
109         ExternalURL: ""
110
111       WebDAVDownload:
112         InternalURLs: {}
113         # Base URL for download links. If blank, serve links to WebDAV
114         # with disposition=attachment query param.  Unlike preview links,
115         # browsers do not render attachments, so there is no risk of XSS.
116         #
117         # If WebDAVDownload is blank, and WebDAV uses a
118         # single-origin form, then Workbench will show an error page
119         #
120         # Serve download links by setting uuid or pdh in the path:
121         #   https://download.uuid_prefix.arvadosapi.com
122         #
123         ExternalURL: ""
124
125       Keepstore:
126         InternalURLs: {}
127         ExternalURL: "-"
128       Composer:
129         InternalURLs: {}
130         ExternalURL: ""
131       WebShell:
132         InternalURLs: {}
133         # ShellInABox service endpoint URL for a given VM.  If empty, do not
134         # offer web shell logins.
135         #
136         # E.g., using a path-based proxy server to forward connections to shell hosts:
137         # https://webshell.uuid_prefix.arvadosapi.com
138         #
139         # E.g., using a name-based proxy server to forward connections to shell hosts:
140         # https://*.webshell.uuid_prefix.arvadosapi.com
141         ExternalURL: ""
142       Workbench1:
143         InternalURLs: {}
144         ExternalURL: ""
145       Workbench2:
146         InternalURLs: {}
147         ExternalURL: ""
148       Health:
149         InternalURLs: {}
150         ExternalURL: "-"
151
152     PostgreSQL:
153       # max concurrent connections per arvados server daemon
154       ConnectionPool: 32
155       Connection:
156         # All parameters here are passed to the PG client library in a connection string;
157         # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
158         host: ""
159         port: ""
160         user: ""
161         password: ""
162         dbname: ""
163         SAMPLE: ""
164     API:
165       # Maximum size (in bytes) allowed for a single API request.  This
166       # limit is published in the discovery document for use by clients.
167       # Note: You must separately configure the upstream web server or
168       # proxy to actually enforce the desired maximum request size on the
169       # server side.
170       MaxRequestSize: 134217728
171
172       # Limit the number of bytes read from the database during an index
173       # request (by retrieving and returning fewer rows than would
174       # normally be returned in a single response).
175       # Note 1: This setting never reduces the number of returned rows to
176       # zero, no matter how big the first data row is.
177       # Note 2: Currently, this is only checked against a specific set of
178       # columns that tend to get large (collections.manifest_text,
179       # containers.mounts, workflows.definition). Other fields (e.g.,
180       # "properties" hashes) are not counted against this limit.
181       MaxIndexDatabaseRead: 134217728
182
183       # Maximum number of items to return when responding to a APIs that
184       # can return partial result sets using limit and offset parameters
185       # (e.g., *.index, groups.contents). If a request specifies a "limit"
186       # parameter higher than this value, this value is used instead.
187       MaxItemsPerResponse: 1000
188
189       # Maximum number of concurrent requests to accept in a single
190       # service process, or 0 for no limit.
191       MaxConcurrentRequests: 0
192
193       # Maximum number of 64MiB memory buffers per Keepstore server process, or
194       # 0 for no limit. When this limit is reached, up to
195       # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
196       # buffers (like GET and PUT) will wait for buffer space to be released.
197       # Any HTTP requests beyond MaxConcurrentRequests will receive an
198       # immediate 503 response.
199       #
200       # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
201       # * 1.1) fits comfortably in memory. On a host dedicated to running
202       # Keepstore, divide total memory by 88MiB to suggest a suitable value.
203       # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
204       # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
205       MaxKeepBlobBuffers: 128
206
207       # API methods to disable. Disabled methods are not listed in the
208       # discovery document, and respond 404 to all requests.
209       # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
210       DisabledAPIs: {}
211
212       # Interval (seconds) between asynchronous permission view updates. Any
213       # permission-updating API called with the 'async' parameter schedules a an
214       # update on the permission view in the future, if not already scheduled.
215       AsyncPermissionsUpdateInterval: 20s
216
217       # Maximum number of concurrent outgoing requests to make while
218       # serving a single incoming multi-cluster (federated) request.
219       MaxRequestAmplification: 4
220
221       # RailsSessionSecretToken is a string of alphanumeric characters
222       # used by Rails to sign session tokens. IMPORTANT: This is a
223       # site secret. It should be at least 50 characters.
224       RailsSessionSecretToken: ""
225
226       # Maximum wall clock time to spend handling an incoming request.
227       RequestTimeout: 5m
228
229       # Websocket will send a periodic empty event after 'SendTimeout'
230       # if there is no other activity to maintain the connection /
231       # detect dropped connections.
232       SendTimeout: 60s
233
234       WebsocketClientEventQueue: 64
235       WebsocketServerEventQueue: 4
236
237       # Timeout on requests to internal Keep services.
238       KeepServiceRequestTimeout: 15s
239
240     Users:
241       # Config parameters to automatically setup new users.  If enabled,
242       # this users will be able to self-activate.  Enable this if you want
243       # to run an open instance where anyone can create an account and use
244       # the system without requiring manual approval.
245       #
246       # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
247       # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
248       AutoSetupNewUsers: false
249       AutoSetupNewUsersWithVmUUID: ""
250       AutoSetupNewUsersWithRepository: false
251       AutoSetupUsernameBlacklist:
252         arvados: {}
253         git: {}
254         gitolite: {}
255         gitolite-admin: {}
256         root: {}
257         syslog: {}
258         SAMPLE: {}
259
260       # When NewUsersAreActive is set to true, new users will be active
261       # immediately.  This skips the "self-activate" step which enforces
262       # user agreements.  Should only be enabled for development.
263       NewUsersAreActive: false
264
265       # The e-mail address of the user you would like to become marked as an admin
266       # user on their first login.
267       AutoAdminUserWithEmail: ""
268
269       # If AutoAdminFirstUser is set to true, the first user to log in when no
270       # other admin users exist will automatically become an admin user.
271       AutoAdminFirstUser: false
272
273       # Email address to notify whenever a user creates a profile for the
274       # first time
275       UserProfileNotificationAddress: ""
276       AdminNotifierEmailFrom: arvados@example.com
277       EmailSubjectPrefix: "[ARVADOS] "
278       UserNotifierEmailFrom: arvados@example.com
279       NewUserNotificationRecipients: {}
280       NewInactiveUserNotificationRecipients: {}
281
282       # Set AnonymousUserToken to enable anonymous user access. Populate this
283       # field with a long random string. Then run "bundle exec
284       # ./script/get_anonymous_user_token.rb" in the directory where your API
285       # server is running to record the token in the database.
286       AnonymousUserToken: ""
287
288       # If a new user has an alternate email address (local@domain)
289       # with the domain given here, its local part becomes the new
290       # user's default username. Otherwise, the user's primary email
291       # address is used.
292       PreferDomainForUsername: ""
293
294       UserSetupMailText: |
295         <% if not @user.full_name.empty? -%>
296         <%= @user.full_name %>,
297         <% else -%>
298         Hi there,
299         <% end -%>
300
301         Your Arvados account has been set up.  You can log in at
302
303         <%= Rails.configuration.Services.Workbench1.ExternalURL %>
304
305         Thanks,
306         Your Arvados administrator.
307
308     AuditLogs:
309       # Time to keep audit logs, in seconds. (An audit log is a row added
310       # to the "logs" table in the PostgreSQL database each time an
311       # Arvados object is created, modified, or deleted.)
312       #
313       # Currently, websocket event notifications rely on audit logs, so
314       # this should not be set lower than 300 (5 minutes).
315       MaxAge: 336h
316
317       # Maximum number of log rows to delete in a single SQL transaction.
318       #
319       # If MaxDeleteBatch is 0, log entries will never be
320       # deleted by Arvados. Cleanup can be done by an external process
321       # without affecting any Arvados system processes, as long as very
322       # recent (<5 minutes old) logs are not deleted.
323       #
324       # 100000 is a reasonable batch size for most sites.
325       MaxDeleteBatch: 0
326
327       # Attributes to suppress in events and audit logs.  Notably,
328       # specifying {"manifest_text": {}} here typically makes the database
329       # smaller and faster.
330       #
331       # Warning: Using any non-empty value here can have undesirable side
332       # effects for any client or component that relies on event logs.
333       # Use at your own risk.
334       UnloggedAttributes: {}
335
336     SystemLogs:
337
338       # Logging threshold: panic, fatal, error, warn, info, debug, or
339       # trace
340       LogLevel: info
341
342       # Logging format: json or text
343       Format: json
344
345       # Maximum characters of (JSON-encoded) query parameters to include
346       # in each request log entry. When params exceed this size, they will
347       # be JSON-encoded, truncated to this size, and logged as
348       # params_truncated.
349       MaxRequestLogParamsSize: 2000
350
351     Collections:
352
353       # Enable access controls for data stored in Keep. This should
354       # always be set to true on a production cluster.
355       BlobSigning: true
356
357       # BlobSigningKey is a string of alphanumeric characters used to
358       # generate permission signatures for Keep locators. It must be
359       # identical to the permission key given to Keep. IMPORTANT: This
360       # is a site secret. It should be at least 50 characters.
361       #
362       # Modifying BlobSigningKey will invalidate all existing
363       # signatures, which can cause programs to fail (e.g., arv-put,
364       # arv-get, and Crunch jobs).  To avoid errors, rotate keys only
365       # when no such processes are running.
366       BlobSigningKey: ""
367
368       # Enable garbage collection of unreferenced blobs in Keep.
369       BlobTrash: true
370
371       # Time to leave unreferenced blobs in "trashed" state before
372       # deleting them, or 0 to skip the "trashed" state entirely and
373       # delete unreferenced blobs.
374       #
375       # If you use any Amazon S3 buckets as storage volumes, this
376       # must be at least 24h to avoid occasional data loss.
377       BlobTrashLifetime: 336h
378
379       # How often to check for (and delete) trashed blocks whose
380       # BlobTrashLifetime has expired.
381       BlobTrashCheckInterval: 24h
382
383       # Maximum number of concurrent "trash blob" and "delete trashed
384       # blob" operations conducted by a single keepstore process. Each
385       # of these can be set to 0 to disable the respective operation.
386       #
387       # If BlobTrashLifetime is zero, "trash" and "delete trash"
388       # happen at once, so only the lower of these two values is used.
389       BlobTrashConcurrency: 4
390       BlobDeleteConcurrency: 4
391
392       # Maximum number of concurrent "create additional replica of
393       # existing blob" operations conducted by a single keepstore
394       # process.
395       BlobReplicateConcurrency: 4
396
397       # Default replication level for collections. This is used when a
398       # collection's replication_desired attribute is nil.
399       DefaultReplication: 2
400
401       # BlobSigningTTL determines the minimum lifetime of transient
402       # data, i.e., blocks that are not referenced by
403       # collections. Unreferenced blocks exist for two reasons:
404       #
405       # 1) A data block must be written to a disk/cloud backend device
406       # before a collection can be created/updated with a reference to
407       # it.
408       #
409       # 2) Deleting or updating a collection can remove the last
410       # remaining reference to a data block.
411       #
412       # If BlobSigningTTL is too short, long-running
413       # processes/containers will fail when they take too long (a)
414       # between writing blocks and writing collections that reference
415       # them, or (b) between reading collections and reading the
416       # referenced blocks.
417       #
418       # If BlobSigningTTL is too long, data will still be stored long
419       # after the referring collections are deleted, and you will
420       # needlessly fill up disks or waste money on cloud storage.
421       #
422       # Modifying BlobSigningTTL invalidates existing signatures; see
423       # BlobSigningKey note above.
424       #
425       # The default is 2 weeks.
426       BlobSigningTTL: 336h
427
428       # When running keep-balance, this is the destination filename for
429       # the list of lost block hashes if there are any, one per line.
430       # Updated automically during each successful run.
431       BlobMissingReport: ""
432
433       # keep-balance operates periodically, i.e.: do a
434       # scan/balance operation, sleep, repeat.
435       #
436       # BalancePeriod determines the interval between start times of
437       # successive scan/balance operations. If a scan/balance operation
438       # takes longer than RunPeriod, the next one will follow it
439       # immediately.
440       #
441       # If SIGUSR1 is received during an idle period between operations,
442       # the next operation will start immediately.
443       BalancePeriod: 10m
444
445       # Limits the number of collections retrieved by keep-balance per
446       # API transaction. If this is zero, page size is
447       # determined by the API server's own page size limits (see
448       # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
449       BalanceCollectionBatch: 0
450
451       # The size of keep-balance's internal queue of
452       # collections. Higher values use more memory and improve throughput
453       # by allowing keep-balance to fetch the next page of collections
454       # while the current page is still being processed. If this is zero
455       # or omitted, pages are processed serially.
456       BalanceCollectionBuffers: 1000
457
458       # Maximum time for a rebalancing run. This ensures keep-balance
459       # eventually gives up and retries if, for example, a network
460       # error causes a hung connection that is never closed by the
461       # OS. It should be long enough that it doesn't interrupt a
462       # long-running balancing operation.
463       BalanceTimeout: 6h
464
465       # Default lifetime for ephemeral collections: 2 weeks. This must not
466       # be less than BlobSigningTTL.
467       DefaultTrashLifetime: 336h
468
469       # Interval (seconds) between trash sweeps. During a trash sweep,
470       # collections are marked as trash if their trash_at time has
471       # arrived, and deleted if their delete_at time has arrived.
472       TrashSweepInterval: 60s
473
474       # If true, enable collection versioning.
475       # When a collection's preserve_version field is true or the current version
476       # is older than the amount of seconds defined on PreserveVersionIfIdle,
477       # a snapshot of the collection's previous state is created and linked to
478       # the current collection.
479       CollectionVersioning: false
480
481       #   0s = auto-create a new version on every update.
482       #  -1s = never auto-create new versions.
483       # > 0s = auto-create a new version when older than the specified number of seconds.
484       PreserveVersionIfIdle: -1s
485
486       # If non-empty, allow project and collection names to contain
487       # the "/" character (slash/stroke/solidus), and replace "/" with
488       # the given string in the filesystem hierarchy presented by
489       # WebDAV. Example values are "%2f" and "{slash}". Names that
490       # contain the substitution string itself may result in confusing
491       # behavior, so a value like "_" is not recommended.
492       #
493       # If the default empty value is used, the server will reject
494       # requests to create or rename a collection when the new name
495       # contains "/".
496       #
497       # If the value "/" is used, project and collection names
498       # containing "/" will be allowed, but they will not be
499       # accessible via WebDAV.
500       #
501       # Use of this feature is not recommended, if it can be avoided.
502       ForwardSlashNameSubstitution: ""
503
504       # Include "folder objects" in S3 ListObjects responses.
505       S3FolderObjects: true
506
507       # Managed collection properties. At creation time, if the client didn't
508       # provide the listed keys, they will be automatically populated following
509       # one of the following behaviors:
510       #
511       # * UUID of the user who owns the containing project.
512       #   responsible_person_uuid: {Function: original_owner, Protected: true}
513       #
514       # * Default concrete value.
515       #   foo_bar: {Value: baz, Protected: false}
516       #
517       # If Protected is true, only an admin user can modify its value.
518       ManagedProperties:
519         SAMPLE: {Function: original_owner, Protected: true}
520
521       # In "trust all content" mode, Workbench will redirect download
522       # requests to WebDAV preview link, even in the cases when
523       # WebDAV would have to expose XSS vulnerabilities in order to
524       # handle the redirect (see discussion on Services.WebDAV).
525       #
526       # This setting has no effect in the recommended configuration,
527       # where the WebDAV is configured to have a separate domain for
528       # every collection; in this case XSS protection is provided by
529       # browsers' same-origin policy.
530       #
531       # The default setting (false) is appropriate for a multi-user site.
532       TrustAllContent: false
533
534       # Cache parameters for WebDAV content serving:
535       # * TTL: Maximum time to cache manifests and permission checks.
536       # * UUIDTTL: Maximum time to cache collection state.
537       # * MaxBlockEntries: Maximum number of block cache entries.
538       # * MaxCollectionEntries: Maximum number of collection cache entries.
539       # * MaxCollectionBytes: Approximate memory limit for collection cache.
540       # * MaxPermissionEntries: Maximum number of permission cache entries.
541       # * MaxUUIDEntries: Maximum number of UUID cache entries.
542       WebDAVCache:
543         TTL: 300s
544         UUIDTTL: 5s
545         MaxBlockEntries:      4
546         MaxCollectionEntries: 1000
547         MaxCollectionBytes:   100000000
548         MaxPermissionEntries: 1000
549         MaxUUIDEntries:       1000
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       SLURM:
900         PrioritySpread: 0
901         SbatchArgumentsList: []
902         SbatchEnvironmentVariables:
903           SAMPLE: ""
904         Managed:
905           # Path to dns server configuration directory
906           # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
907           # files or touch restart.txt (see below).
908           DNSServerConfDir: ""
909
910           # Template file for the dns server host snippets. See
911           # unbound.template in this directory for an example. If false, do
912           # not write any config files.
913           DNSServerConfTemplate: ""
914
915           # String to write to {dns_server_conf_dir}/restart.txt (with a
916           # trailing newline) after updating local data. If false, do not
917           # open or write the restart.txt file.
918           DNSServerReloadCommand: ""
919
920           # Command to run after each DNS update. Template variables will be
921           # substituted; see the "unbound" example below. If false, do not run
922           # a command.
923           DNSServerUpdateCommand: ""
924
925           ComputeNodeDomain: ""
926           ComputeNodeNameservers:
927             "192.168.1.1": {}
928             SAMPLE: {}
929
930           # Hostname to assign to a compute node when it sends a "ping" and the
931           # hostname in its Node record is nil.
932           # During bootstrapping, the "ping" script is expected to notice the
933           # hostname given in the ping response, and update its unix hostname
934           # accordingly.
935           # If false, leave the hostname alone (this is appropriate if your compute
936           # nodes' hostnames are already assigned by some other mechanism).
937           #
938           # One way or another, the hostnames of your node records should agree
939           # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
940           #
941           # Example for compute0000, compute0001, ....:
942           # assign_node_hostname: compute%<slot_number>04d
943           # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
944           AssignNodeHostname: "compute%<slot_number>d"
945
946       JobsAPI:
947         # Enable the legacy 'jobs' API (crunch v1).  This value must be a string.
948         #
949         # Note: this only enables read-only access, creating new
950         # legacy jobs and pipelines is not supported.
951         #
952         # 'auto' -- (default) enable the Jobs API only if it has been used before
953         #         (i.e., there are job records in the database)
954         # 'true' -- enable the Jobs API despite lack of existing records.
955         # 'false' -- disable the Jobs API despite presence of existing records.
956         Enable: 'auto'
957
958         # Git repositories must be readable by api server, or you won't be
959         # able to submit crunch jobs. To pass the test suites, put a clone
960         # of the arvados tree in {git_repositories_dir}/arvados.git or
961         # {git_repositories_dir}/arvados/.git
962         GitInternalDir: /var/lib/arvados/internal.git
963
964       CloudVMs:
965         # Enable the cloud scheduler (experimental).
966         Enable: false
967
968         # Name/number of port where workers' SSH services listen.
969         SSHPort: "22"
970
971         # Interval between queue polls.
972         PollInterval: 10s
973
974         # Shell command to execute on each worker to determine whether
975         # the worker is booted and ready to run containers. It should
976         # exit zero if the worker is ready.
977         BootProbeCommand: "docker ps -q"
978
979         # Minimum interval between consecutive probes to a single
980         # worker.
981         ProbeInterval: 10s
982
983         # Maximum probes per second, across all workers in a pool.
984         MaxProbesPerSecond: 10
985
986         # Time before repeating SIGTERM when killing a container.
987         TimeoutSignal: 5s
988
989         # Time to give up on a process (most likely arv-mount) that
990         # still holds a container lockfile after its main supervisor
991         # process has exited, and declare the instance broken.
992         TimeoutStaleRunLock: 5s
993
994         # Time to give up on SIGTERM and write off the worker.
995         TimeoutTERM: 2m
996
997         # Maximum create/destroy-instance operations per second (0 =
998         # unlimited).
999         MaxCloudOpsPerSecond: 0
1000
1001         # Maximum concurrent node creation operations (0 = unlimited). This is
1002         # recommended by Azure in certain scenarios (see
1003         # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image)
1004         # and can be used with other cloud providers too, if desired.
1005         MaxConcurrentInstanceCreateOps: 0
1006
1007         # Interval between cloud provider syncs/updates ("list all
1008         # instances").
1009         SyncInterval: 1m
1010
1011         # Time to leave an idle worker running (in case new containers
1012         # appear in the queue that it can run) before shutting it
1013         # down.
1014         TimeoutIdle: 1m
1015
1016         # Time to wait for a new worker to boot (i.e., pass
1017         # BootProbeCommand) before giving up and shutting it down.
1018         TimeoutBooting: 10m
1019
1020         # Maximum time a worker can stay alive with no successful
1021         # probes before being automatically shut down.
1022         TimeoutProbe: 10m
1023
1024         # Time after shutting down a worker to retry the
1025         # shutdown/destroy operation.
1026         TimeoutShutdown: 10s
1027
1028         # Worker VM image ID.
1029         # (aws) AMI identifier
1030         # (azure) managed disks: the name of the managed disk image
1031         # (azure) shared image gallery: the name of the image definition. Also
1032         # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1033         # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1034         # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1035         ImageID: ""
1036
1037         # An executable file (located on the dispatcher host) to be
1038         # copied to cloud instances at runtime and used as the
1039         # container runner/supervisor. The default value is the
1040         # dispatcher program itself.
1041         #
1042         # Use the empty string to disable this step: nothing will be
1043         # copied, and cloud instances are assumed to have a suitable
1044         # version of crunch-run installed.
1045         DeployRunnerBinary: "/proc/self/exe"
1046
1047         # Tags to add on all resources (VMs, NICs, disks) created by
1048         # the container dispatcher. (Arvados's own tags --
1049         # InstanceType, IdleBehavior, and InstanceSecret -- will also
1050         # be added.)
1051         ResourceTags:
1052           SAMPLE: "tag value"
1053
1054         # Prefix for predefined tags used by Arvados (InstanceSetID,
1055         # InstanceType, InstanceSecret, IdleBehavior). With the
1056         # default value "Arvados", tags are "ArvadosInstanceSetID",
1057         # "ArvadosInstanceSecret", etc.
1058         #
1059         # This should only be changed while no cloud resources are in
1060         # use and the cloud dispatcher is not running. Otherwise,
1061         # VMs/resources that were added using the old tag prefix will
1062         # need to be detected and cleaned up manually.
1063         TagKeyPrefix: Arvados
1064
1065         # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1066         Driver: ec2
1067
1068         # Cloud-specific driver parameters.
1069         DriverParameters:
1070
1071           # (ec2) Credentials.
1072           AccessKeyID: ""
1073           SecretAccessKey: ""
1074
1075           # (ec2) Instance configuration.
1076           SecurityGroupIDs:
1077             "SAMPLE": {}
1078           SubnetID: ""
1079           Region: ""
1080           EBSVolumeType: gp2
1081           AdminUsername: debian
1082
1083           # (azure) Credentials.
1084           SubscriptionID: ""
1085           ClientID: ""
1086           ClientSecret: ""
1087           TenantID: ""
1088
1089           # (azure) Instance configuration.
1090           CloudEnvironment: AzurePublicCloud
1091           Location: centralus
1092
1093           # (azure) The resource group where the VM and virtual NIC will be
1094           # created.
1095           ResourceGroup: ""
1096
1097           # (azure) The resource group of the Network to use for the virtual
1098           # NIC (if different from ResourceGroup)
1099           NetworkResourceGroup: ""
1100           Network: ""
1101           Subnet: ""
1102
1103           # (azure) managed disks: The resource group where the managed disk
1104           # image can be found (if different from ResourceGroup).
1105           ImageResourceGroup: ""
1106
1107           # (azure) shared image gallery: the name of the gallery
1108           SharedImageGalleryName: ""
1109           # (azure) shared image gallery: the version of the image definition
1110           SharedImageGalleryImageVersion: ""
1111
1112           # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1113           StorageAccount: ""
1114           BlobContainer: ""
1115
1116           # (azure) How long to wait before deleting VHD and NIC
1117           # objects that are no longer being used.
1118           DeleteDanglingResourcesAfter: 20s
1119
1120           # Account (that already exists in the VM image) that will be
1121           # set up with an ssh authorized key to allow the compute
1122           # dispatcher to connect.
1123           AdminUsername: arvados
1124
1125     InstanceTypes:
1126
1127       # Use the instance type name as the key (in place of "SAMPLE" in
1128       # this sample entry).
1129       SAMPLE:
1130         # Cloud provider's instance type. Defaults to the configured type name.
1131         ProviderType: ""
1132         VCPUs: 1
1133         RAM: 128MiB
1134         IncludedScratch: 16GB
1135         AddedScratch: 0
1136         Price: 0.1
1137         Preemptible: false
1138
1139     Volumes:
1140       SAMPLE:
1141         # AccessViaHosts specifies which keepstore processes can read
1142         # and write data on the volume.
1143         #
1144         # For a local filesystem, AccessViaHosts has one entry,
1145         # indicating which server the filesystem is located on.
1146         #
1147         # For a network-attached backend accessible by all keepstore
1148         # servers, like a cloud storage bucket or an NFS mount,
1149         # AccessViaHosts can be empty/omitted.
1150         #
1151         # Further info/examples:
1152         # https://doc.arvados.org/install/configure-fs-storage.html
1153         # https://doc.arvados.org/install/configure-s3-object-storage.html
1154         # https://doc.arvados.org/install/configure-azure-blob-storage.html
1155         AccessViaHosts:
1156           SAMPLE:
1157             ReadOnly: false
1158           "http://host1.example:25107": {}
1159         ReadOnly: false
1160         Replication: 1
1161         StorageClasses:
1162           default: true
1163           SAMPLE: true
1164         Driver: s3
1165         DriverParameters:
1166           # for s3 driver -- see
1167           # https://doc.arvados.org/install/configure-s3-object-storage.html
1168           IAMRole: aaaaa
1169           AccessKey: aaaaa
1170           SecretKey: aaaaa
1171           Endpoint: ""
1172           Region: us-east-1a
1173           Bucket: aaaaa
1174           LocationConstraint: false
1175           V2Signature: false
1176           IndexPageSize: 1000
1177           ConnectTimeout: 1m
1178           ReadTimeout: 10m
1179           RaceWindow: 24h
1180           # Use aws-s3-go (v2) instead of goamz
1181           UseAWSS3v2Driver: false
1182
1183           # For S3 driver, potentially unsafe tuning parameter,
1184           # intentionally excluded from main documentation.
1185           #
1186           # Enable deletion (garbage collection) even when the
1187           # configured BlobTrashLifetime is zero.  WARNING: eventual
1188           # consistency may result in race conditions that can cause
1189           # data loss.  Do not enable this unless you understand and
1190           # accept the risk.
1191           UnsafeDelete: false
1192
1193           # for azure driver -- see
1194           # https://doc.arvados.org/install/configure-azure-blob-storage.html
1195           StorageAccountName: aaaaa
1196           StorageAccountKey: aaaaa
1197           StorageBaseURL: core.windows.net
1198           ContainerName: aaaaa
1199           RequestTimeout: 30s
1200           ListBlobsRetryDelay: 10s
1201           ListBlobsMaxAttempts: 10
1202           MaxGetBytes: 0
1203           WriteRaceInterval: 15s
1204           WriteRacePollTime: 1s
1205
1206           # for local directory driver -- see
1207           # https://doc.arvados.org/install/configure-fs-storage.html
1208           Root: /var/lib/arvados/keep-data
1209
1210           # For local directory driver, potentially confusing tuning
1211           # parameter, intentionally excluded from main documentation.
1212           #
1213           # When true, read and write operations (for whole 64MiB
1214           # blocks) on an individual volume will queued and issued
1215           # serially.  When false, read and write operations will be
1216           # issued concurrently.
1217           #
1218           # May possibly improve throughput if you have physical spinning disks
1219           # and experience contention when there are multiple requests
1220           # to the same volume.
1221           #
1222           # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1223           # should leave this alone.
1224           Serialize: false
1225
1226     Mail:
1227       MailchimpAPIKey: ""
1228       MailchimpListID: ""
1229       SendUserSetupNotificationEmail: true
1230
1231       # Bug/issue report notification to and from addresses
1232       IssueReporterEmailFrom: "arvados@example.com"
1233       IssueReporterEmailTo: "arvados@example.com"
1234       SupportEmailAddress: "arvados@example.com"
1235
1236       # Generic issue email from
1237       EmailFrom: "arvados@example.com"
1238     RemoteClusters:
1239       "*":
1240         Host: ""
1241         Proxy: false
1242         Scheme: https
1243         Insecure: false
1244         ActivateUsers: false
1245       SAMPLE:
1246         # API endpoint host or host:port; default is {id}.arvadosapi.com
1247         Host: sample.arvadosapi.com
1248
1249         # Perform a proxy request when a local client requests an
1250         # object belonging to this remote.
1251         Proxy: false
1252
1253         # Default "https". Can be set to "http" for testing.
1254         Scheme: https
1255
1256         # Disable TLS verify. Can be set to true for testing.
1257         Insecure: false
1258
1259         # When users present tokens issued by this remote cluster, and
1260         # their accounts are active on the remote cluster, activate
1261         # them on this cluster too.
1262         ActivateUsers: false
1263
1264     Workbench:
1265       # Workbench1 configs
1266       Theme: default
1267       ActivationContactLink: mailto:info@arvados.org
1268       ArvadosDocsite: https://doc.arvados.org
1269       ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1270       ShowUserAgreementInline: false
1271       SecretKeyBase: ""
1272
1273       # Scratch directory used by the remote repository browsing
1274       # feature. If it doesn't exist, it (and any missing parents) will be
1275       # created using mkdir_p.
1276       RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1277
1278       # Below is a sample setting of user_profile_form_fields config parameter.
1279       # This configuration parameter should be set to either false (to disable) or
1280       # to a map as shown below.
1281       # Configure the map of input fields to be displayed in the profile page
1282       # using the attribute "key" for each of the input fields.
1283       # This sample shows configuration with one required and one optional form fields.
1284       # For each of these input fields:
1285       #   You can specify "Type" as "text" or "select".
1286       #   List the "Options" to be displayed for each of the "select" menu.
1287       #   Set "Required" as "true" for any of these fields to make them required.
1288       # If any of the required fields are missing in the user's profile, the user will be
1289       # redirected to the profile page before they can access any Workbench features.
1290       UserProfileFormFields:
1291         SAMPLE:
1292           Type: select
1293           FormFieldTitle: Best color
1294           FormFieldDescription: your favorite color
1295           Required: false
1296           Position: 1
1297           Options:
1298             red: {}
1299             blue: {}
1300             green: {}
1301             SAMPLE: {}
1302
1303         # exampleTextValue:  # key that will be set in properties
1304         #   Type: text  #
1305         #   FormFieldTitle: ""
1306         #   FormFieldDescription: ""
1307         #   Required: true
1308         #   Position: 1
1309         # exampleOptionsValue:
1310         #   Type: select
1311         #   FormFieldTitle: ""
1312         #   FormFieldDescription: ""
1313         #   Required: true
1314         #   Position: 1
1315         #   Options:
1316         #     red: {}
1317         #     blue: {}
1318         #     yellow: {}
1319
1320       # Use "UserProfileFormMessage to configure the message you want
1321       # to display on the profile page.
1322       UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1323
1324       # Mimetypes of applications for which the view icon
1325       # would be enabled in a collection's show page.
1326       # It is sufficient to list only applications here.
1327       # No need to list text and image types.
1328       ApplicationMimetypesWithViewIcon:
1329         cwl: {}
1330         fasta: {}
1331         go: {}
1332         javascript: {}
1333         json: {}
1334         pdf: {}
1335         python: {}
1336         x-python: {}
1337         r: {}
1338         rtf: {}
1339         sam: {}
1340         x-sh: {}
1341         vnd.realvnc.bed: {}
1342         xml: {}
1343         xsl: {}
1344         SAMPLE: {}
1345
1346       # The maximum number of bytes to load in the log viewer
1347       LogViewerMaxBytes: 1M
1348
1349       # When anonymous_user_token is configured, show public projects page
1350       EnablePublicProjectsPage: true
1351
1352       # By default, disable the "Getting Started" popup which is specific to Arvados playground
1353       EnableGettingStartedPopup: false
1354
1355       # Ask Arvados API server to compress its response payloads.
1356       APIResponseCompression: true
1357
1358       # Timeouts for API requests.
1359       APIClientConnectTimeout: 2m
1360       APIClientReceiveTimeout: 5m
1361
1362       # Maximum number of historic log records of a running job to fetch
1363       # and display in the Log tab, while subscribing to web sockets.
1364       RunningJobLogRecordsToFetch: 2000
1365
1366       # In systems with many shared projects, loading of dashboard and topnav
1367       # can be slow due to collections indexing; use the following parameters
1368       # to suppress these properties
1369       ShowRecentCollectionsOnDashboard: true
1370       ShowUserNotifications: true
1371
1372       # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1373       # a link to the multi-site search page on a "home" Workbench site.
1374       #
1375       # Example:
1376       #   https://workbench.zzzzz.arvadosapi.com/collections/multisite
1377       MultiSiteSearch: ""
1378
1379       # Should workbench allow management of local git repositories? Set to false if
1380       # the jobs api is disabled and there are no local git repositories.
1381       Repositories: true
1382
1383       SiteName: Arvados Workbench
1384       ProfilingEnabled: false
1385
1386       # This is related to obsolete Google OpenID 1.0 login
1387       # but some workbench stuff still expects it to be set.
1388       DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1389
1390       # Workbench2 configs
1391       VocabularyURL: ""
1392       FileViewersConfigURL: ""
1393
1394       # Idle time after which the user's session will be auto closed.
1395       # This feature is disabled when set to zero.
1396       IdleTimeout: 0s
1397
1398       # Workbench welcome screen, this is HTML text that will be
1399       # incorporated directly onto the page.
1400       WelcomePageHTML: |
1401         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1402         <h2>Please log in.</h2>
1403
1404         <p>The "Log in" button below will show you a sign-in
1405         page. After you log in, you will be redirected back to
1406         Arvados Workbench.</p>
1407
1408         <p>If you have never used Arvados Workbench before, logging in
1409         for the first time will automatically create a new
1410         account.</p>
1411
1412         <i>Arvados Workbench uses your name and email address only for
1413         identification, and does not retrieve any other personal
1414         information.</i>
1415
1416       # Workbench screen displayed to inactive users.  This is HTML
1417       # text that will be incorporated directly onto the page.
1418       InactivePageHTML: |
1419         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1420         <h3>Hi! You're logged in, but...</h3>
1421         <p>Your account is inactive.</p>
1422         <p>An administrator must activate your account before you can get
1423         any further.</p>
1424
1425       # Connecting to Arvados shell VMs tends to be site-specific.
1426       # Put any special instructions here. This is HTML text that will
1427       # be incorporated directly onto the Workbench page.
1428       SSHHelpPageHTML: |
1429         <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1430         Site configurations vary.  Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1431
1432       # Sample text if you are using a "switchyard" ssh proxy.
1433       # Replace "zzzzz" with your Cluster ID.
1434       #SSHHelpPageHTML: |
1435       # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1436       # <pre>Host *.zzzzz
1437       #  TCPKeepAlive yes
1438       #  ServerAliveInterval 60
1439       #  ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1440       # </pre>
1441
1442       # If you are using a switchyard ssh proxy, shell node hostnames
1443       # may require a special hostname suffix.  In the sample ssh
1444       # configuration above, this would be ".zzzzz"
1445       # This is added to the hostname in the "command line" column
1446       # the Workbench "shell VMs" page.
1447       #
1448       # If your shell nodes are directly accessible by users without a
1449       # proxy and have fully qualified host names, you should leave
1450       # this blank.
1451       SSHHelpHostSuffix: ""
1452
1453     # Bypass new (Arvados 1.5) API implementations, and hand off
1454     # requests directly to Rails instead. This can provide a temporary
1455     # workaround for clients that are incompatible with the new API
1456     # implementation. Note that it also disables some new federation
1457     # features and will be removed in a future release.
1458     ForceLegacyAPI14: false
1459
1460 # (Experimental) Restart services automatically when config file
1461 # changes are detected. Only supported by ` + "`" + `arvados-server boot` + "`" + ` in
1462 # dev/test mode.
1463 AutoReloadConfig: false
1464 `)