X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/0eb72b526bf8bbb011551ecf019f604e17a534f1..ba418300c50e1375ca9938562579b7bd6bf9490d:/services/ws/doc.go diff --git a/services/ws/doc.go b/services/ws/doc.go index 092539747e..6a86cbe7a8 100644 --- a/services/ws/doc.go +++ b/services/ws/doc.go @@ -6,54 +6,11 @@ // cache-invalidation event feed at "ws://.../websocket") to // websocket clients. // -// Installation +// Installation and configuration // // See https://doc.arvados.org/install/install-ws.html. // // Developer info // // See https://dev.arvados.org/projects/arvados/wiki/Hacking_websocket_server. -// -// 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 -// -// Options -// -// -config path -// -// Load configuration from the given file instead of the default -// /etc/arvados/ws/ws.yml -// -// -dump-config -// -// Print the loaded configuration to stdout and exit. -// -// Logs -// -// Logs are printed to stderr, formatted as JSON. -// -// 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. -// -// GET /status.json responds with health check results and -// activity/usage metrics. -package main +package ws