X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/e8cc0d73309236d6efc243371969f83808e42d30..6d95130da47af9fd0290d3c8f80a0364faf74957:/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 c1bfb35a4a..f6a4bb5faf 100644 --- a/doc/install/install-ws.html.textile.liquid +++ b/doc/install/install-ws.html.textile.liquid @@ -3,8 +3,13 @@ layout: default navsection: installguide title: Install the websocket server ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -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/keep-web for additional information. +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. By convention, we use the following hostname for the websocket service. @@ -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": {}
+
websocket_address: wss://ws.uuid_prefix.your.domain/websocket
-
-$ 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"}