X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/87fcb4c388573967b0dedf6a23557fcf9888d998..37e995fb7423b2b353c599e2a1b00bda7c29ee6f:/services/keep-web/doc.go diff --git a/services/keep-web/doc.go b/services/keep-web/doc.go index 4483c60f3f..3326dd19d8 100644 --- a/services/keep-web/doc.go +++ b/services/keep-web/doc.go @@ -9,32 +9,30 @@ // 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 // @@ -67,8 +65,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"] //