Merge branch '21666-provision-test-improvement'

[arvados.git] / services / keep-web / doc.go

diff --git a/services/keep-web/doc.go b/services/keep-web/doc.go
index be81bb68c71c74a439a2dbd02cf11acefea127b7..4f7d2ca968bfd12834639b6d560f9c7752f0491c 100644 (file)
--- a/services/keep-web/doc.go
+++ b/services/keep-web/doc.go
@@ -10,47 +10,46 @@
 //
 // See http://doc.arvados.org/install/install-keep-web.html.
 //
-// Configuration
+// # Configuration
 //
 // The default cluster configuration file location is
 // /etc/arvados/config.yml.
 //
 // Example configuration file
 //
-//   Clusters:
-//     zzzzz:
-//       SystemRootToken: ""
-//       Services:
-//         Controller:
-//           ExternalURL: "https://example.com"
-//           Insecure: false
-//         WebDAV:
-//           InternalURLs:
-//             "http://:1234/": {}
-//         WebDAVDownload:
-//           InternalURLs:
-//             "http://:1234/": {}
-//           ExternalURL: "https://download.example.com/"
-//       Users:
-//         AnonymousUserToken: "xxxxxxxxxxxxxxxxxxxx"
-//       Collections:
-//         TrustAllContent: false
-//
-// Starting the server
+//     Clusters:
+//       zzzzz:
+//         SystemRootToken: ""
+//         Services:
+//           Controller:
+//             ExternalURL: "https://example.com"
+//             Insecure: false
+//           WebDAV:
+//             InternalURLs:
+//               "http://:1234/": {}
+//           WebDAVDownload:
+//             InternalURLs:
+//               "http://:1234/": {}
+//             ExternalURL: "https://download.example.com/"
+//         Users:
+//           AnonymousUserToken: "xxxxxxxxxxxxxxxxxxxx"
+//         Collections:
+//           TrustAllContent: false
+//
+// # Starting the server
 //
 // Start a server using the default config file
 // /etc/arvados/config.yml:
 //
-//   keep-web
+//     keep-web
 //
 // Start a server using the config file /path/to/config.yml:
 //
-//   keep-web -config /path/to/config.yml
+//     keep-web -config /path/to/config.yml
 //
-// Proxy configuration
+// # Proxy configuration
 //
-// Keep-web does not support TLS natively. Typically, it is installed
-// behind a proxy like nginx.
+// Typically, keep-web is installed behind a proxy like nginx.
 //
 // Here is an example nginx configuration.
 //
@@ -72,28 +71,28 @@
 //     }
 //
 // It is not necessary to run keep-web on the same host as the nginx
-// proxy. However, TLS is not used between nginx and keep-web, so
+// proxy. However, if TLS is not used between nginx and keep-web, the
 // intervening networks must be secured by other means.
 //
-// Anonymous downloads
+// # Anonymous downloads
 //
 // The "Users.AnonymousUserToken" configuration entry used when
 // 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.
 //
-//   Clusters:
-//     zzzzz:
-//       Users:
-//         AnonymousUserToken: "xxxxxxxxxxxxxxxxxxxxxxx"
+//     Clusters:
+//       zzzzz:
+//         Users:
+//           AnonymousUserToken: "xxxxxxxxxxxxxxxxxxxxxxx"
 //
 // See http://doc.arvados.org/install/install-keep-web.html for examples.
 //
-// Download URLs
+// # Download URLs
 //
 // See http://doc.arvados.org/api/keep-web-urls.html
 //
-// Attachment-Only host
+// # Attachment-Only host
 //
 // It is possible to serve untrusted content and accept user
 // credentials at the same origin as long as the content is only
@@ -104,13 +103,13 @@
 // only when the designated origin matches exactly the Host header
 // provided by the client or downstream proxy.
 //
-//   Clusters:
-//     zzzzz:
-//       Services:
-//         WebDAVDownload:
-//           ExternalURL: "https://domain.example:9999"
+//     Clusters:
+//       zzzzz:
+//         Services:
+//           WebDAVDownload:
+//             ExternalURL: "https://domain.example:9999"
 //
-// Trust All Content mode
+// # Trust All Content mode
 //
 // In TrustAllContent mode, Keep-web will accept credentials (API
 // tokens) and serve any collection X at
@@ -121,32 +120,31 @@
 //
 // In such cases you can enable trust-all-content mode.
 //
-//   Clusters:
-//     zzzzz:
-//       Collections:
-//         TrustAllContent: true
+//     Clusters:
+//       zzzzz:
+//         Collections:
+//           TrustAllContent: true
 //
 // When TrustAllContent is enabled, the only effect of the
 // Attachment-Only host setting is to add a "Content-Disposition:
 // attachment" header.
 //
-//   Clusters:
-//     zzzzz:
-//       Services:
-//         WebDAVDownload:
-//           ExternalURL: "https://domain.example:9999"
-//       Collections:
-//         TrustAllContent: true
+//     Clusters:
+//       zzzzz:
+//         Services:
+//           WebDAVDownload:
+//             ExternalURL: "https://domain.example:9999"
+//         Collections:
+//           TrustAllContent: true
 //
 // Depending on your site configuration, you might also want to enable
 // the "trust all content" setting in Workbench. Normally, Workbench
 // avoids redirecting requests to keep-web if they depend on
 // TrustAllContent being enabled.
 //
-// Metrics
+// # Metrics
 //
 // Keep-web exposes request metrics in Prometheus text-based format at
 // /metrics. The same information is also available as JSON at
 // /metrics.json.
-//
-package main
+package keepweb