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