Merge pull request #1 from arvados/master

[arvados.git] / services / ws / doc.go

diff --git a/services/ws/doc.go b/services/ws/doc.go
index 7ccb588d856b28e03cd03db8cacd9db2352a9cbd..806c3355da6c693350493a7471bc59e270bfb1e3 100644 (file)
--- a/services/ws/doc.go
+++ b/services/ws/doc.go
@@ -1,8 +1,12 @@
+// 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.
 //
-// Installation
+// Installation and configuration
 //
 // See https://doc.arvados.org/install/install-ws.html.
 //
@@ -12,25 +16,14 @@
 //
 // Usage
 //
-//     arvados-ws [-config /etc/arvados/ws/ws.yml] [-dump-config]
-//
-// Minimal configuration
-//
-//     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
 //