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