X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/d63601c63f651ab9fe4fefb5a7e8d76bf0495da3..e94ed22c9f40ecafd3cb1ee1349eaee018b4d883:/services/ws/doc.go diff --git a/services/ws/doc.go b/services/ws/doc.go index 1f01b68f6f..806c3355da 100644 --- a/services/ws/doc.go +++ b/services/ws/doc.go @@ -1,30 +1,29 @@ +// Copyright (C) The Arvados Authors. All rights reserved. +// +// SPDX-License-Identifier: AGPL-3.0 + // Arvados-ws exposes Arvados APIs (currently just one, the // cache-invalidation event feed at "ws://.../websocket") to // websocket clients. // -// See https://doc.arvados.org/install/install-arvados-ws.html. +// Installation and configuration // -// Usage +// See https://doc.arvados.org/install/install-ws.html. // -// arvados-ws [-config /etc/arvados/ws/ws.yml] [-dump-config] +// Developer info // -// Minimal configuration +// See https://dev.arvados.org/projects/arvados/wiki/Hacking_websocket_server. +// +// Usage // -// Client: -// APIHost: localhost:443 -// Listen: ":1234" -// Postgres: -// dbname: arvados_production -// host: localhost -// password: xyzzy -// user: arvados +// arvados-ws [-legacy-ws-config /etc/arvados/ws/ws.yml] [-dump-config] // // Options // -// -config path +// -legacy-ws-config path // -// Load configuration from the given file instead of the default -// /etc/arvados/ws/ws.yml +// Load legacy configuration from the given file instead of the default +// /etc/arvados/ws/ws.yml, legacy config overrides the clusterwide config.yml. // // -dump-config //