The configuration parameter is MaxKeepBlobBuffers, not MaxBuffers.
[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       OpenIDConnect:
580         # Authenticate with an OpenID Connect provider.
581         Enable: false
582
583         # Issuer URL, e.g., "https://login.example.com".
584         #
585         # This must be exactly equal to the URL returned by the issuer
586         # itself in its config response ("isser" key). If the
587         # configured value is "https://example" and the provider
588         # returns "https://example:443" or "https://example/" then
589         # login will fail, even though those URLs are equivalent
590         # (RFC3986).
591         Issuer: ""
592
593         # Your client ID and client secret (supplied by the provider).
594         ClientID: ""
595         ClientSecret: ""
596
597         # OpenID claim field containing the user's email
598         # address. Normally "email"; see
599         # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
600         EmailClaim: "email"
601
602         # OpenID claim field containing the email verification
603         # flag. Normally "email_verified".  To accept every returned
604         # email address without checking a "verified" field at all,
605         # use the empty string "".
606         EmailVerifiedClaim: "email_verified"
607
608         # OpenID claim field containing the user's preferred
609         # username. If empty, use the mailbox part of the user's email
610         # address.
611         UsernameClaim: ""
612
613       PAM:
614         # (Experimental) Use PAM to authenticate users.
615         Enable: false
616
617         # PAM service name. PAM will apply the policy in the
618         # corresponding config file (e.g., /etc/pam.d/arvados) or, if
619         # there is none, the default "other" config.
620         Service: arvados
621
622         # Domain name (e.g., "example.com") to use to construct the
623         # user's email address if PAM authentication returns a
624         # username with no "@". If empty, use the PAM username as the
625         # user's email address, whether or not it contains "@".
626         #
627         # Note that the email address is used as the primary key for
628         # user records when logging in. Therefore, if you change
629         # PAMDefaultEmailDomain after the initial installation, you
630         # should also update existing user records to reflect the new
631         # domain. Otherwise, next time those users log in, they will
632         # be given new accounts instead of accessing their existing
633         # accounts.
634         DefaultEmailDomain: ""
635
636       LDAP:
637         # Use an LDAP service to authenticate users.
638         Enable: false
639
640         # Server URL, like "ldap://ldapserver.example.com:389" or
641         # "ldaps://ldapserver.example.com:636".
642         URL: "ldap://ldap:389"
643
644         # Use StartTLS upon connecting to the server.
645         StartTLS: true
646
647         # Skip TLS certificate name verification.
648         InsecureTLS: false
649
650         # Strip the @domain part if a user supplies an email-style
651         # username with this domain. If "*", strip any user-provided
652         # domain. If "", never strip the domain part. Example:
653         # "example.com"
654         StripDomain: ""
655
656         # If, after applying StripDomain, the username contains no "@"
657         # character, append this domain to form an email-style
658         # username. Example: "example.com"
659         AppendDomain: ""
660
661         # The LDAP attribute to filter on when looking up a username
662         # (after applying StripDomain and AppendDomain).
663         SearchAttribute: uid
664
665         # Bind with this username (DN or UPN) and password when
666         # looking up the user record.
667         #
668         # Example user: "cn=admin,dc=example,dc=com"
669         SearchBindUser: ""
670         SearchBindPassword: ""
671
672         # Directory base for username lookup. Example:
673         # "ou=Users,dc=example,dc=com"
674         SearchBase: ""
675
676         # Additional filters to apply when looking up users' LDAP
677         # entries. This can be used to restrict access to a subset of
678         # LDAP users, or to disambiguate users from other directory
679         # entries that have the SearchAttribute present.
680         #
681         # Special characters in assertion values must be escaped (see
682         # RFC4515).
683         #
684         # Example: "(objectClass=person)"
685         SearchFilters: ""
686
687         # LDAP attribute to use as the user's email address.
688         #
689         # Important: This must not be an attribute whose value can be
690         # edited in the directory by the users themselves. Otherwise,
691         # users can take over other users' Arvados accounts trivially
692         # (email address is the primary key for Arvados accounts.)
693         EmailAttribute: mail
694
695         # LDAP attribute to use as the preferred Arvados username. If
696         # no value is found (or this config is empty) the username
697         # originally supplied by the user will be used.
698         UsernameAttribute: uid
699
700       SSO:
701         # Authenticate with a separate SSO server. (Deprecated)
702         Enable: false
703
704         # ProviderAppID and ProviderAppSecret are generated during SSO
705         # setup; see
706         # https://doc.arvados.org/v2.0/install/install-sso.html#update-config
707         ProviderAppID: ""
708         ProviderAppSecret: ""
709
710       Test:
711         # Authenticate users listed here in the config file. This
712         # feature is intended to be used in test environments, and
713         # should not be used in production.
714         Enable: false
715         Users:
716           SAMPLE:
717             Email: alice@example.com
718             Password: xyzzy
719
720       # The cluster ID to delegate the user database.  When set,
721       # logins on this cluster will be redirected to the login cluster
722       # (login cluster must appear in RemoteClusters with Proxy: true)
723       LoginCluster: ""
724
725       # How long a cached token belonging to a remote cluster will
726       # remain valid before it needs to be revalidated.
727       RemoteTokenRefresh: 5m
728
729       # How long a client token created from a login flow will be valid without
730       # asking the user to re-login. Example values: 60m, 8h.
731       # Default value zero means tokens don't have expiration.
732       TokenLifetime: 0s
733
734       # When the token is returned to a client, the token itself may
735       # be restricted from manipulating other tokens based on whether
736       # the client is "trusted" or not.  The local Workbench1 and
737       # Workbench2 are trusted by default, but if this is a
738       # LoginCluster, you probably want to include the other Workbench
739       # instances in the federation in this list.
740       TrustedClients:
741         SAMPLE:
742           "https://workbench.federate1.example": {}
743           "https://workbench.federate2.example": {}
744
745     Git:
746       # Path to git or gitolite-shell executable. Each authenticated
747       # request will execute this program with the single argument "http-backend"
748       GitCommand: /usr/bin/git
749
750       # Path to Gitolite's home directory. If a non-empty path is given,
751       # the CGI environment will be set up to support the use of
752       # gitolite-shell as a GitCommand: for example, if GitoliteHome is
753       # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
754       # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
755       GitoliteHome: ""
756
757       # Git repositories must be readable by api server, or you won't be
758       # able to submit crunch jobs. To pass the test suites, put a clone
759       # of the arvados tree in {git_repositories_dir}/arvados.git or
760       # {git_repositories_dir}/arvados/.git
761       Repositories: /var/lib/arvados/git/repositories
762
763     TLS:
764       Certificate: ""
765       Key: ""
766       Insecure: false
767
768     Containers:
769       # List of supported Docker Registry image formats that compute nodes
770       # are able to use. ` + "`" + `arv keep docker` + "`" + ` will error out if a user tries
771       # to store an image with an unsupported format. Use an empty array
772       # to skip the compatibility check (and display a warning message to
773       # that effect).
774       #
775       # Example for sites running docker < 1.10: {"v1": {}}
776       # Example for sites running docker >= 1.10: {"v2": {}}
777       # Example for disabling check: {}
778       SupportedDockerImageFormats:
779         "v2": {}
780         SAMPLE: {}
781
782       # Include details about job reuse decisions in the server log. This
783       # causes additional database queries to run, so it should not be
784       # enabled unless you expect to examine the resulting logs for
785       # troubleshooting purposes.
786       LogReuseDecisions: false
787
788       # Default value for keep_cache_ram of a container's runtime_constraints.
789       DefaultKeepCacheRAM: 268435456
790
791       # Number of times a container can be unlocked before being
792       # automatically cancelled.
793       MaxDispatchAttempts: 5
794
795       # Default value for container_count_max for container requests.  This is the
796       # number of times Arvados will create a new container to satisfy a container
797       # request.  If a container is cancelled it will retry a new container if
798       # container_count < container_count_max on any container requests associated
799       # with the cancelled container.
800       MaxRetryAttempts: 3
801
802       # The maximum number of compute nodes that can be in use simultaneously
803       # If this limit is reduced, any existing nodes with slot number >= new limit
804       # will not be counted against the new limit. In other words, the new limit
805       # won't be strictly enforced until those nodes with higher slot numbers
806       # go down.
807       MaxComputeVMs: 64
808
809       # Preemptible instance support (e.g. AWS Spot Instances)
810       # When true, child containers will get created with the preemptible
811       # scheduling parameter parameter set.
812       UsePreemptibleInstances: false
813
814       # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
815       # (experimental) cloud dispatcher for executing containers on
816       # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
817       # and ends with "\n-----END RSA PRIVATE KEY-----\n".
818       DispatchPrivateKey: ""
819
820       # Maximum time to wait for workers to come up before abandoning
821       # stale locks from a previous dispatch process.
822       StaleLockTimeout: 1m
823
824       # The crunch-run command to manage the container on a node
825       CrunchRunCommand: "crunch-run"
826
827       # Extra arguments to add to crunch-run invocation
828       # Example: ["--cgroup-parent-subsystem=memory"]
829       CrunchRunArgumentsList: []
830
831       # Extra RAM to reserve on the node, in addition to
832       # the amount specified in the container's RuntimeConstraints
833       ReserveExtraRAM: 256MiB
834
835       # Minimum time between two attempts to run the same container
836       MinRetryPeriod: 0s
837
838       Logging:
839         # When you run the db:delete_old_container_logs task, it will find
840         # containers that have been finished for at least this many seconds,
841         # and delete their stdout, stderr, arv-mount, crunch-run, and
842         # crunchstat logs from the logs table.
843         MaxAge: 720h
844
845         # These two settings control how frequently log events are flushed to the
846         # database.  Log lines are buffered until either crunch_log_bytes_per_event
847         # has been reached or crunch_log_seconds_between_events has elapsed since
848         # the last flush.
849         LogBytesPerEvent: 4096
850         LogSecondsBetweenEvents: 5s
851
852         # The sample period for throttling logs.
853         LogThrottlePeriod: 60s
854
855         # Maximum number of bytes that job can log over crunch_log_throttle_period
856         # before being silenced until the end of the period.
857         LogThrottleBytes: 65536
858
859         # Maximum number of lines that job can log over crunch_log_throttle_period
860         # before being silenced until the end of the period.
861         LogThrottleLines: 1024
862
863         # Maximum bytes that may be logged by a single job.  Log bytes that are
864         # silenced by throttling are not counted against this total.
865         LimitLogBytesPerJob: 67108864
866
867         LogPartialLineThrottlePeriod: 5s
868
869         # Container logs are written to Keep and saved in a
870         # collection, which is updated periodically while the
871         # container runs.  This value sets the interval between
872         # collection updates.
873         LogUpdatePeriod: 30m
874
875         # The log collection is also updated when the specified amount of
876         # log data (given in bytes) is produced in less than one update
877         # period.
878         LogUpdateSize: 32MiB
879
880       SLURM:
881         PrioritySpread: 0
882         SbatchArgumentsList: []
883         SbatchEnvironmentVariables:
884           SAMPLE: ""
885         Managed:
886           # Path to dns server configuration directory
887           # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
888           # files or touch restart.txt (see below).
889           DNSServerConfDir: ""
890
891           # Template file for the dns server host snippets. See
892           # unbound.template in this directory for an example. If false, do
893           # not write any config files.
894           DNSServerConfTemplate: ""
895
896           # String to write to {dns_server_conf_dir}/restart.txt (with a
897           # trailing newline) after updating local data. If false, do not
898           # open or write the restart.txt file.
899           DNSServerReloadCommand: ""
900
901           # Command to run after each DNS update. Template variables will be
902           # substituted; see the "unbound" example below. If false, do not run
903           # a command.
904           DNSServerUpdateCommand: ""
905
906           ComputeNodeDomain: ""
907           ComputeNodeNameservers:
908             "192.168.1.1": {}
909             SAMPLE: {}
910
911           # Hostname to assign to a compute node when it sends a "ping" and the
912           # hostname in its Node record is nil.
913           # During bootstrapping, the "ping" script is expected to notice the
914           # hostname given in the ping response, and update its unix hostname
915           # accordingly.
916           # If false, leave the hostname alone (this is appropriate if your compute
917           # nodes' hostnames are already assigned by some other mechanism).
918           #
919           # One way or another, the hostnames of your node records should agree
920           # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
921           #
922           # Example for compute0000, compute0001, ....:
923           # assign_node_hostname: compute%<slot_number>04d
924           # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
925           AssignNodeHostname: "compute%<slot_number>d"
926
927       JobsAPI:
928         # Enable the legacy 'jobs' API (crunch v1).  This value must be a string.
929         #
930         # Note: this only enables read-only access, creating new
931         # legacy jobs and pipelines is not supported.
932         #
933         # 'auto' -- (default) enable the Jobs API only if it has been used before
934         #         (i.e., there are job records in the database)
935         # 'true' -- enable the Jobs API despite lack of existing records.
936         # 'false' -- disable the Jobs API despite presence of existing records.
937         Enable: 'auto'
938
939         # Git repositories must be readable by api server, or you won't be
940         # able to submit crunch jobs. To pass the test suites, put a clone
941         # of the arvados tree in {git_repositories_dir}/arvados.git or
942         # {git_repositories_dir}/arvados/.git
943         GitInternalDir: /var/lib/arvados/internal.git
944
945       CloudVMs:
946         # Enable the cloud scheduler (experimental).
947         Enable: false
948
949         # Name/number of port where workers' SSH services listen.
950         SSHPort: "22"
951
952         # Interval between queue polls.
953         PollInterval: 10s
954
955         # Shell command to execute on each worker to determine whether
956         # the worker is booted and ready to run containers. It should
957         # exit zero if the worker is ready.
958         BootProbeCommand: "docker ps -q"
959
960         # Minimum interval between consecutive probes to a single
961         # worker.
962         ProbeInterval: 10s
963
964         # Maximum probes per second, across all workers in a pool.
965         MaxProbesPerSecond: 10
966
967         # Time before repeating SIGTERM when killing a container.
968         TimeoutSignal: 5s
969
970         # Time to give up on a process (most likely arv-mount) that
971         # still holds a container lockfile after its main supervisor
972         # process has exited, and declare the instance broken.
973         TimeoutStaleRunLock: 5s
974
975         # Time to give up on SIGTERM and write off the worker.
976         TimeoutTERM: 2m
977
978         # Maximum create/destroy-instance operations per second (0 =
979         # unlimited).
980         MaxCloudOpsPerSecond: 0
981
982         # Maximum concurrent node creation operations (0 = unlimited). This is
983         # recommended by Azure in certain scenarios (see
984         # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image)
985         # and can be used with other cloud providers too, if desired.
986         MaxConcurrentInstanceCreateOps: 0
987
988         # Interval between cloud provider syncs/updates ("list all
989         # instances").
990         SyncInterval: 1m
991
992         # Time to leave an idle worker running (in case new containers
993         # appear in the queue that it can run) before shutting it
994         # down.
995         TimeoutIdle: 1m
996
997         # Time to wait for a new worker to boot (i.e., pass
998         # BootProbeCommand) before giving up and shutting it down.
999         TimeoutBooting: 10m
1000
1001         # Maximum time a worker can stay alive with no successful
1002         # probes before being automatically shut down.
1003         TimeoutProbe: 10m
1004
1005         # Time after shutting down a worker to retry the
1006         # shutdown/destroy operation.
1007         TimeoutShutdown: 10s
1008
1009         # Worker VM image ID.
1010         # (aws) AMI identifier
1011         # (azure) managed disks: the name of the managed disk image
1012         # (azure) shared image gallery: the name of the image definition. Also
1013         # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1014         # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1015         # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1016         ImageID: ""
1017
1018         # An executable file (located on the dispatcher host) to be
1019         # copied to cloud instances at runtime and used as the
1020         # container runner/supervisor. The default value is the
1021         # dispatcher program itself.
1022         #
1023         # Use the empty string to disable this step: nothing will be
1024         # copied, and cloud instances are assumed to have a suitable
1025         # version of crunch-run installed.
1026         DeployRunnerBinary: "/proc/self/exe"
1027
1028         # Tags to add on all resources (VMs, NICs, disks) created by
1029         # the container dispatcher. (Arvados's own tags --
1030         # InstanceType, IdleBehavior, and InstanceSecret -- will also
1031         # be added.)
1032         ResourceTags:
1033           SAMPLE: "tag value"
1034
1035         # Prefix for predefined tags used by Arvados (InstanceSetID,
1036         # InstanceType, InstanceSecret, IdleBehavior). With the
1037         # default value "Arvados", tags are "ArvadosInstanceSetID",
1038         # "ArvadosInstanceSecret", etc.
1039         #
1040         # This should only be changed while no cloud resources are in
1041         # use and the cloud dispatcher is not running. Otherwise,
1042         # VMs/resources that were added using the old tag prefix will
1043         # need to be detected and cleaned up manually.
1044         TagKeyPrefix: Arvados
1045
1046         # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1047         Driver: ec2
1048
1049         # Cloud-specific driver parameters.
1050         DriverParameters:
1051
1052           # (ec2) Credentials.
1053           AccessKeyID: ""
1054           SecretAccessKey: ""
1055
1056           # (ec2) Instance configuration.
1057           SecurityGroupIDs:
1058             "SAMPLE": {}
1059           SubnetID: ""
1060           Region: ""
1061           EBSVolumeType: gp2
1062           AdminUsername: debian
1063
1064           # (azure) Credentials.
1065           SubscriptionID: ""
1066           ClientID: ""
1067           ClientSecret: ""
1068           TenantID: ""
1069
1070           # (azure) Instance configuration.
1071           CloudEnvironment: AzurePublicCloud
1072           Location: centralus
1073
1074           # (azure) The resource group where the VM and virtual NIC will be
1075           # created.
1076           ResourceGroup: ""
1077
1078           # (azure) The resource group of the Network to use for the virtual
1079           # NIC (if different from ResourceGroup)
1080           NetworkResourceGroup: ""
1081           Network: ""
1082           Subnet: ""
1083
1084           # (azure) managed disks: The resource group where the managed disk
1085           # image can be found (if different from ResourceGroup).
1086           ImageResourceGroup: ""
1087
1088           # (azure) shared image gallery: the name of the gallery
1089           SharedImageGalleryName: ""
1090           # (azure) shared image gallery: the version of the image definition
1091           SharedImageGalleryImageVersion: ""
1092
1093           # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1094           StorageAccount: ""
1095           BlobContainer: ""
1096
1097           # (azure) How long to wait before deleting VHD and NIC
1098           # objects that are no longer being used.
1099           DeleteDanglingResourcesAfter: 20s
1100
1101           # Account (that already exists in the VM image) that will be
1102           # set up with an ssh authorized key to allow the compute
1103           # dispatcher to connect.
1104           AdminUsername: arvados
1105
1106     InstanceTypes:
1107
1108       # Use the instance type name as the key (in place of "SAMPLE" in
1109       # this sample entry).
1110       SAMPLE:
1111         # Cloud provider's instance type. Defaults to the configured type name.
1112         ProviderType: ""
1113         VCPUs: 1
1114         RAM: 128MiB
1115         IncludedScratch: 16GB
1116         AddedScratch: 0
1117         Price: 0.1
1118         Preemptible: false
1119
1120     Volumes:
1121       SAMPLE:
1122         # AccessViaHosts specifies which keepstore processes can read
1123         # and write data on the volume.
1124         #
1125         # For a local filesystem, AccessViaHosts has one entry,
1126         # indicating which server the filesystem is located on.
1127         #
1128         # For a network-attached backend accessible by all keepstore
1129         # servers, like a cloud storage bucket or an NFS mount,
1130         # AccessViaHosts can be empty/omitted.
1131         #
1132         # Further info/examples:
1133         # https://doc.arvados.org/install/configure-fs-storage.html
1134         # https://doc.arvados.org/install/configure-s3-object-storage.html
1135         # https://doc.arvados.org/install/configure-azure-blob-storage.html
1136         AccessViaHosts:
1137           SAMPLE:
1138             ReadOnly: false
1139           "http://host1.example:25107": {}
1140         ReadOnly: false
1141         Replication: 1
1142         StorageClasses:
1143           default: true
1144           SAMPLE: true
1145         Driver: s3
1146         DriverParameters:
1147           # for s3 driver -- see
1148           # https://doc.arvados.org/install/configure-s3-object-storage.html
1149           IAMRole: aaaaa
1150           AccessKey: aaaaa
1151           SecretKey: aaaaa
1152           Endpoint: ""
1153           Region: us-east-1a
1154           Bucket: aaaaa
1155           LocationConstraint: false
1156           V2Signature: false
1157           IndexPageSize: 1000
1158           ConnectTimeout: 1m
1159           ReadTimeout: 10m
1160           RaceWindow: 24h
1161           # Use aws-s3-go (v2) instead of goamz
1162           UseAWSS3v2Driver: false
1163
1164           # For S3 driver, potentially unsafe tuning parameter,
1165           # intentionally excluded from main documentation.
1166           #
1167           # Enable deletion (garbage collection) even when the
1168           # configured BlobTrashLifetime is zero.  WARNING: eventual
1169           # consistency may result in race conditions that can cause
1170           # data loss.  Do not enable this unless you understand and
1171           # accept the risk.
1172           UnsafeDelete: false
1173
1174           # for azure driver -- see
1175           # https://doc.arvados.org/install/configure-azure-blob-storage.html
1176           StorageAccountName: aaaaa
1177           StorageAccountKey: aaaaa
1178           StorageBaseURL: core.windows.net
1179           ContainerName: aaaaa
1180           RequestTimeout: 30s
1181           ListBlobsRetryDelay: 10s
1182           ListBlobsMaxAttempts: 10
1183           MaxGetBytes: 0
1184           WriteRaceInterval: 15s
1185           WriteRacePollTime: 1s
1186
1187           # for local directory driver -- see
1188           # https://doc.arvados.org/install/configure-fs-storage.html
1189           Root: /var/lib/arvados/keep-data
1190
1191           # For local directory driver, potentially confusing tuning
1192           # parameter, intentionally excluded from main documentation.
1193           #
1194           # When true, read and write operations (for whole 64MiB
1195           # blocks) on an individual volume will queued and issued
1196           # serially.  When false, read and write operations will be
1197           # issued concurrently.
1198           #
1199           # May possibly improve throughput if you have physical spinning disks
1200           # and experience contention when there are multiple requests
1201           # to the same volume.
1202           #
1203           # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1204           # should leave this alone.
1205           Serialize: false
1206
1207     Mail:
1208       MailchimpAPIKey: ""
1209       MailchimpListID: ""
1210       SendUserSetupNotificationEmail: true
1211
1212       # Bug/issue report notification to and from addresses
1213       IssueReporterEmailFrom: "arvados@example.com"
1214       IssueReporterEmailTo: "arvados@example.com"
1215       SupportEmailAddress: "arvados@example.com"
1216
1217       # Generic issue email from
1218       EmailFrom: "arvados@example.com"
1219     RemoteClusters:
1220       "*":
1221         Host: ""
1222         Proxy: false
1223         Scheme: https
1224         Insecure: false
1225         ActivateUsers: false
1226       SAMPLE:
1227         # API endpoint host or host:port; default is {id}.arvadosapi.com
1228         Host: sample.arvadosapi.com
1229
1230         # Perform a proxy request when a local client requests an
1231         # object belonging to this remote.
1232         Proxy: false
1233
1234         # Default "https". Can be set to "http" for testing.
1235         Scheme: https
1236
1237         # Disable TLS verify. Can be set to true for testing.
1238         Insecure: false
1239
1240         # When users present tokens issued by this remote cluster, and
1241         # their accounts are active on the remote cluster, activate
1242         # them on this cluster too.
1243         ActivateUsers: false
1244
1245     Workbench:
1246       # Workbench1 configs
1247       Theme: default
1248       ActivationContactLink: mailto:info@arvados.org
1249       ArvadosDocsite: https://doc.arvados.org
1250       ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1251       ShowUserAgreementInline: false
1252       SecretKeyBase: ""
1253
1254       # Scratch directory used by the remote repository browsing
1255       # feature. If it doesn't exist, it (and any missing parents) will be
1256       # created using mkdir_p.
1257       RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1258
1259       # Below is a sample setting of user_profile_form_fields config parameter.
1260       # This configuration parameter should be set to either false (to disable) or
1261       # to a map as shown below.
1262       # Configure the map of input fields to be displayed in the profile page
1263       # using the attribute "key" for each of the input fields.
1264       # This sample shows configuration with one required and one optional form fields.
1265       # For each of these input fields:
1266       #   You can specify "Type" as "text" or "select".
1267       #   List the "Options" to be displayed for each of the "select" menu.
1268       #   Set "Required" as "true" for any of these fields to make them required.
1269       # If any of the required fields are missing in the user's profile, the user will be
1270       # redirected to the profile page before they can access any Workbench features.
1271       UserProfileFormFields:
1272         SAMPLE:
1273           Type: select
1274           FormFieldTitle: Best color
1275           FormFieldDescription: your favorite color
1276           Required: false
1277           Position: 1
1278           Options:
1279             red: {}
1280             blue: {}
1281             green: {}
1282             SAMPLE: {}
1283
1284         # exampleTextValue:  # key that will be set in properties
1285         #   Type: text  #
1286         #   FormFieldTitle: ""
1287         #   FormFieldDescription: ""
1288         #   Required: true
1289         #   Position: 1
1290         # exampleOptionsValue:
1291         #   Type: select
1292         #   FormFieldTitle: ""
1293         #   FormFieldDescription: ""
1294         #   Required: true
1295         #   Position: 1
1296         #   Options:
1297         #     red: {}
1298         #     blue: {}
1299         #     yellow: {}
1300
1301       # Use "UserProfileFormMessage to configure the message you want
1302       # to display on the profile page.
1303       UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1304
1305       # Mimetypes of applications for which the view icon
1306       # would be enabled in a collection's show page.
1307       # It is sufficient to list only applications here.
1308       # No need to list text and image types.
1309       ApplicationMimetypesWithViewIcon:
1310         cwl: {}
1311         fasta: {}
1312         go: {}
1313         javascript: {}
1314         json: {}
1315         pdf: {}
1316         python: {}
1317         x-python: {}
1318         r: {}
1319         rtf: {}
1320         sam: {}
1321         x-sh: {}
1322         vnd.realvnc.bed: {}
1323         xml: {}
1324         xsl: {}
1325         SAMPLE: {}
1326
1327       # The maximum number of bytes to load in the log viewer
1328       LogViewerMaxBytes: 1M
1329
1330       # When anonymous_user_token is configured, show public projects page
1331       EnablePublicProjectsPage: true
1332
1333       # By default, disable the "Getting Started" popup which is specific to Arvados playground
1334       EnableGettingStartedPopup: false
1335
1336       # Ask Arvados API server to compress its response payloads.
1337       APIResponseCompression: true
1338
1339       # Timeouts for API requests.
1340       APIClientConnectTimeout: 2m
1341       APIClientReceiveTimeout: 5m
1342
1343       # Maximum number of historic log records of a running job to fetch
1344       # and display in the Log tab, while subscribing to web sockets.
1345       RunningJobLogRecordsToFetch: 2000
1346
1347       # In systems with many shared projects, loading of dashboard and topnav
1348       # can be slow due to collections indexing; use the following parameters
1349       # to suppress these properties
1350       ShowRecentCollectionsOnDashboard: true
1351       ShowUserNotifications: true
1352
1353       # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1354       # a link to the multi-site search page on a "home" Workbench site.
1355       #
1356       # Example:
1357       #   https://workbench.zzzzz.arvadosapi.com/collections/multisite
1358       MultiSiteSearch: ""
1359
1360       # Should workbench allow management of local git repositories? Set to false if
1361       # the jobs api is disabled and there are no local git repositories.
1362       Repositories: true
1363
1364       SiteName: Arvados Workbench
1365       ProfilingEnabled: false
1366
1367       # This is related to obsolete Google OpenID 1.0 login
1368       # but some workbench stuff still expects it to be set.
1369       DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1370
1371       # Workbench2 configs
1372       VocabularyURL: ""
1373       FileViewersConfigURL: ""
1374
1375       # Idle time after which the user's session will be auto closed.
1376       # This feature is disabled when set to zero.
1377       IdleTimeout: 0s
1378
1379       # Workbench welcome screen, this is HTML text that will be
1380       # incorporated directly onto the page.
1381       WelcomePageHTML: |
1382         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1383         <h2>Please log in.</h2>
1384
1385         <p>The "Log in" button below will show you a sign-in
1386         page. After you log in, you will be redirected back to
1387         Arvados Workbench.</p>
1388
1389         <p>If you have never used Arvados Workbench before, logging in
1390         for the first time will automatically create a new
1391         account.</p>
1392
1393         <i>Arvados Workbench uses your name and email address only for
1394         identification, and does not retrieve any other personal
1395         information.</i>
1396
1397       # Workbench screen displayed to inactive users.  This is HTML
1398       # text that will be incorporated directly onto the page.
1399       InactivePageHTML: |
1400         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1401         <h3>Hi! You're logged in, but...</h3>
1402         <p>Your account is inactive.</p>
1403         <p>An administrator must activate your account before you can get
1404         any further.</p>
1405
1406       # Connecting to Arvados shell VMs tends to be site-specific.
1407       # Put any special instructions here. This is HTML text that will
1408       # be incorporated directly onto the Workbench page.
1409       SSHHelpPageHTML: |
1410         <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1411         Site configurations vary.  Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1412
1413       # Sample text if you are using a "switchyard" ssh proxy.
1414       # Replace "zzzzz" with your Cluster ID.
1415       #SSHHelpPageHTML: |
1416       # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1417       # <pre>Host *.zzzzz
1418       #  TCPKeepAlive yes
1419       #  ServerAliveInterval 60
1420       #  ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1421       # </pre>
1422
1423       # If you are using a switchyard ssh proxy, shell node hostnames
1424       # may require a special hostname suffix.  In the sample ssh
1425       # configuration above, this would be ".zzzzz"
1426       # This is added to the hostname in the "command line" column
1427       # the Workbench "shell VMs" page.
1428       #
1429       # If your shell nodes are directly accessible by users without a
1430       # proxy and have fully qualified host names, you should leave
1431       # this blank.
1432       SSHHelpHostSuffix: ""
1433
1434     # Bypass new (Arvados 1.5) API implementations, and hand off
1435     # requests directly to Rails instead. This can provide a temporary
1436     # workaround for clients that are incompatible with the new API
1437     # implementation. Note that it also disables some new federation
1438     # features and will be removed in a future release.
1439     ForceLegacyAPI14: false
1440
1441 # (Experimental) Restart services automatically when config file
1442 # changes are detected. Only supported by ` + "`" + `arvados-server boot` + "`" + ` in
1443 # dev/test mode.
1444 AutoReloadConfig: false
1445 `)