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