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