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