X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/df48d4e9d64b08e0d82ffba2424fff87c2a07701..7aa1bc6eaf4d340d6e45226003b776d521309d69:/services/keep-web/doc.go diff --git a/services/keep-web/doc.go b/services/keep-web/doc.go index 37f81b1b3a..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.