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