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