projects
/
arvados.git
/ blobdiff
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
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 d2805689210fef467ace420785c7bba31a3c6a75..806c3355da6c693350493a7471bc59e270bfb1e3 100644
(file)
--- a/
services/ws/doc.go
+++ b/
services/ws/doc.go
@@
-1,28
+1,29
@@
-//
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
//
//
// 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
//
//
// -dump-config
//
@@
-34,6
+35,10
@@
//
// A log is printed each time a client connects or disconnects.
//
//
// 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.
// Runtime status
//
// GET /debug.json responds with debug stats.