services/ws/doc.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 // Package ws exposes Arvados APIs (currently just one, the
   6 // cache-invalidation event feed at "ws://.../websocket") to
   7 // websocket clients.
   8 //
   9 // # Installation and configuration
  10 //
  11 // See https://doc.arvados.org/install/install-ws.html.
  12 //
  13 // # Developer info
  14 //
  15 // See https://dev.arvados.org/projects/arvados/wiki/Hacking_websocket_server.
  16 package ws