X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/8ada36c931712304c4b2c70bdcbc316b1ad2c4e2..ef23c3d124b24a461f6947868a28e67e7a0a1010:/doc/install/install-ws.html.textile.liquid diff --git a/doc/install/install-ws.html.textile.liquid b/doc/install/install-ws.html.textile.liquid index 9887f462c6..f6a4bb5faf 100644 --- a/doc/install/install-ws.html.textile.liquid +++ b/doc/install/install-ws.html.textile.liquid @@ -3,6 +3,11 @@ layout: default navsection: installguide title: Install the websocket server ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} The arvados-ws server provides event notifications to websocket clients. It can be installed anywhere with access to Postgres database and the Arvados API server, typically behind a web proxy that provides SSL support. See the "godoc page":http://godoc.org/github.com/curoverse/arvados/services/ws for additional information. @@ -38,26 +43,25 @@ Verify that @arvados-ws@ is functional:
~$ arvados-ws -h
 Usage of arvados-ws:
   -config path
-        path to config file (default "/etc/arvados/ws/ws.yml")
+        path to config file (default "/etc/arvados/config.yml")
   -dump-config
         show current configuration and exit
 
-h3. Create a configuration file +h3. Update cluster config -Create @/etc/arvados/ws/ws.yml@ using the following template. Replace @xxxxxxxx@ with the "password you generated during database setup":install-postgresql.html#api. +Edit the cluster config at @/etc/arvados/config.yml@ and set @Services.Websocket.ExternalURL@ and @Services.Websocket.InternalURLs@. Replace @zzzzz@ with your cluster id. -
Client:
-  APIHost: uuid_prefix.your.domain:443
-Listen: ":9003"
-Postgres:
-  dbname: arvados_production
-  host: localhost
-  password: xxxxxxxx
-  user: arvados
-
+
Clusters:
+  zzzzz:
+    Services:
+      Websocket:
+        ExternalURL: wss://ws.uuid_prefix.your.domain/websocket
+        InternalURLs:
+	  "http://localhost:9003": {}
+
h3. Start the service (option 1: systemd) @@ -175,13 +179,6 @@ If you are upgrading a cluster where Nginx is configured to proxy @ws@ requests h3. Update API server configuration -Ensure the websocket server address is correct in the API server configuration file @/etc/arvados/api/application.yml@. - - -
websocket_address: wss://ws.uuid_prefix.your.domain/websocket
-
-
- Restart Nginx to reload the API server configuration. @@ -191,10 +188,10 @@ Restart Nginx to reload the API server configuration. h3. Verify DNS and proxy setup -Use a host elsewhere on the Internet to confirm that your DNS, proxy, and SSL are configured correctly. +Use a host elsewhere on the Internet to confirm that your DNS, proxy, and SSL are configured correctly. For @Authorization: Bearer xxxx@ replace @xxxx@ with the value from @ManagementToken@ in @config.yml@. -
$ curl https://ws.uuid_prefix.your.domain/status.json
-{"Clients":1}
+
$ curl -H "Authorization: Bearer xxxx" https://ws.uuid_prefix.your.domain/_health/ping
+{"health":"OK"}