X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/87fcb4c388573967b0dedf6a23557fcf9888d998..bcf069c6a726e219bc40224653268d87776e54aa:/services/keep-web/doc.go

diff --git a/services/keep-web/doc.go b/services/keep-web/doc.go
index 4483c60f3f..b7da3b0e5a 100644
--- a/services/keep-web/doc.go
+++ b/services/keep-web/doc.go
@@ -1,44 +1,46 @@
-// Keep-web provides read-only HTTP access to files stored in Keep. It
-// serves public data to anonymous and unauthenticated clients, and
-// serves private data to clients that supply Arvados API tokens. It
-// can be installed anywhere with access to Keep services, typically
-// behind a web proxy that supports TLS.
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+
+// Keep-web provides read/write HTTP (WebDAV) access to files stored
+// in Keep. It serves public data to anonymous and unauthenticated
+// clients, and serves private data to clients that supply Arvados API
+// tokens. It can be installed anywhere with access to Keep services,
+// typically behind a web proxy that supports TLS.
 //
 // See http://doc.arvados.org/install/install-keep-web.html.
 //
 // Configuration
 //
 // The default configuration file location is
-// /etc/arvados/keep-web/config.json.
+// /etc/arvados/keep-web/keep-web.yml.
 //
 // Example configuration file
 //
-//   {
-//     "Client": {
-//       "APIHost": "zzzzz.arvadosapi.com:443",
-//       "AuthToken": "",
-//       "Insecure": false
-//     },
-//     "Listen":":1234",
-//     "AnonymousTokens":["xxxxxxxxxxxxxxxxxxxx"],
-//     "AttachmentOnlyHost":"",
-//     "TrustAllContent":false
-//   }
+//     Client:
+//       APIHost: "zzzzz.arvadosapi.com:443"
+//       AuthToken: ""
+//       Insecure: false
+//     Listen: :1234
+//     AnonymousTokens:
+//       - xxxxxxxxxxxxxxxxxxxx
+//     AttachmentOnlyHost: ""
+//     TrustAllContent: false
 //
 // Starting the server
 //
 // Start a server using the default config file
-// /etc/arvados/keep-web/config.json:
+// /etc/arvados/keep-web/keep-web.yml:
 //
 //   keep-web
 //
-// Start a server using the config file /path/to/config.json:
+// Start a server using the config file /path/to/keep-web.yml:
 //
-//   keep-web -config /path/to/config.json
+//   keep-web -config /path/to/keep-web.yml
 //
 // Proxy configuration
 //
-// Keep-web does not support SSL natively. Typically, it is installed
+// Keep-web does not support TLS natively. Typically, it is installed
 // behind a proxy like nginx.
 //
 // Here is an example nginx configuration.
@@ -67,8 +69,9 @@
 // Anonymous downloads
 //
 // The "AnonymousTokens" configuration entry is an array of tokens to
-// use when clients try to retrieve files without providing their own
-// Arvados API token.
+// use when processing anonymous requests, i.e., whenever a web client
+// does not supply its own Arvados API token via path, query string,
+// cookie, or request header.
 //
 //   "AnonymousTokens":["xxxxxxxxxxxxxxxxxxxxxxx"]
 //