11002: Merge branch 'master' into 11002-arvput-crash-fix
[arvados.git] / services / ws / doc.go
1 // Arvados-ws exposes Arvados APIs (currently just one, the
2 // cache-invalidation event feed at "ws://.../websocket") to
3 // websocket clients.
4 //
5 // Installation
6 //
7 // See https://doc.arvados.org/install/install-ws.html.
8 //
9 // Developer info
10 //
11 // See https://dev.arvados.org/projects/arvados/wiki/Hacking_websocket_server.
12 //
13 // Usage
14 //
15 //     arvados-ws [-config /etc/arvados/ws/ws.yml] [-dump-config]
16 //
17 // Minimal configuration
18 //
19 //     Client:
20 //       APIHost: localhost:443
21 //     Listen: ":1234"
22 //     Postgres:
23 //       dbname: arvados_production
24 //       host: localhost
25 //       password: xyzzy
26 //       user: arvados
27 //
28 // Options
29 //
30 // -config path
31 //
32 // Load configuration from the given file instead of the default
33 // /etc/arvados/ws/ws.yml
34 //
35 // -dump-config
36 //
37 // Print the loaded configuration to stdout and exit.
38 //
39 // Logs
40 //
41 // Logs are printed to stderr, formatted as JSON.
42 //
43 // A log is printed each time a client connects or disconnects.
44 //
45 // Enable additional logs by configuring:
46 //
47 //     LogLevel: debug
48 //
49 // Runtime status
50 //
51 // GET /debug.json responds with debug stats.
52 //
53 // GET /status.json responds with health check results and
54 // activity/usage metrics.
55 package main