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