16263: Rename no_federation -> bypass_federation

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

diff --git a/services/ws/doc.go b/services/ws/doc.go
index 092539747e29aceb94f58fa46bbf9024aca6e09c..806c3355da6c693350493a7471bc59e270bfb1e3 100644 (file)
--- a/services/ws/doc.go
+++ b/services/ws/doc.go
@@ -6,7 +6,7 @@
 // cache-invalidation event feed at "ws://.../websocket") to
 // websocket clients.
 //
-// Installation
+// Installation and configuration
 //
 // See https://doc.arvados.org/install/install-ws.html.
 //
@@ -16,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
 //