-// Arvados-ws is an Arvados event feed for Websocket clients.
+// Copyright (C) The Arvados Authors. All rights reserved.
//
-// See https://doc.arvados.org/install/install-arvados-ws.html.
+// 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.
//
-// Usage
+// Installation and configuration
+//
+// See https://doc.arvados.org/install/install-ws.html.
+//
+// Developer info
//
-// arvados-ws [-config /etc/arvados/ws/ws.yml] [-dump-config]
+// See https://dev.arvados.org/projects/arvados/wiki/Hacking_websocket_server.
//
-// Minimal configuration
+// 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
//
//
// A log is printed each time a client connects or disconnects.
//
+// Enable additional logs by configuring:
+//
+// LogLevel: debug
+//
// Runtime status
//
// GET /debug.json responds with debug stats.