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