X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/9d79488376e90532512733748eed1aa78af1c125..645785be096302899e754354504aaaffde4d4760:/services/ws/doc.go diff --git a/services/ws/doc.go b/services/ws/doc.go index 806c3355da..cdb5c467fe 100644 --- a/services/ws/doc.go +++ b/services/ws/doc.go @@ -2,47 +2,15 @@ // // SPDX-License-Identifier: AGPL-3.0 -// Arvados-ws exposes Arvados APIs (currently just one, the +// Package ws exposes Arvados APIs (currently just one, the // cache-invalidation event feed at "ws://.../websocket") to // websocket clients. // -// Installation and configuration +// # Installation and configuration // // See https://doc.arvados.org/install/install-ws.html. // -// Developer info +// # Developer info // // See https://dev.arvados.org/projects/arvados/wiki/Hacking_websocket_server. -// -// Usage -// -// arvados-ws [-legacy-ws-config /etc/arvados/ws/ws.yml] [-dump-config] -// -// Options -// -// -legacy-ws-config path -// -// 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 -// -// 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