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