services/ws/doc.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 // Arvados-ws exposes Arvados APIs (currently just one, the
   6 // cache-invalidation event feed at "ws://.../websocket") to
   7 // websocket clients.
   8 //
   9 // Installation
  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 //
  17 // Usage
  18 //
  19 //     arvados-ws [-config /etc/arvados/ws/ws.yml] [-dump-config]
  20 //
  21 // Minimal configuration
  22 //
  23 //     Client:
  24 //       APIHost: localhost:443
  25 //     Listen: ":1234"
  26 //     Postgres:
  27 //       dbname: arvados_production
  28 //       host: localhost
  29 //       password: xyzzy
  30 //       user: arvados
  31 //
  32 // Options
  33 //
  34 // -config path
  35 //
  36 // Load configuration from the given file instead of the default
  37 // /etc/arvados/ws/ws.yml
  38 //
  39 // -dump-config
  40 //
  41 // Print the loaded configuration to stdout and exit.
  42 //
  43 // Logs
  44 //
  45 // Logs are printed to stderr, formatted as JSON.
  46 //
  47 // A log is printed each time a client connects or disconnects.
  48 //
  49 // Enable additional logs by configuring:
  50 //
  51 //     LogLevel: debug
  52 //
  53 // Runtime status
  54 //
  55 // GET /debug.json responds with debug stats.
  56 //
  57 // GET /status.json responds with health check results and
  58 // activity/usage metrics.
  59 package main