X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/bf2aee923894b06592fa87977787559bb14aac18..feb290061b91fa059aefd251ed3c3532b32620ea:/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 2a0baa7506..e7b20f45a0 100644 --- a/doc/install/install-ws.html.textile.liquid +++ b/doc/install/install-ws.html.textile.liquid @@ -9,7 +9,7 @@ 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. +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/arvados/arvados/services/ws for additional information. # "Update config.yml":#update-config # "Update nginx configuration":#update-nginx @@ -20,13 +20,13 @@ The arvados-ws server provides event notifications to websocket clients. It can h2(#configure). Update config.yml -Edit the cluster config at @/etc/arvados/config.yml@ and set @Services.Websocket.ExternalURL@ and @Services.Websocket.InternalURLs@. Replace @zzzzz@ with your cluster id. +Edit the cluster config at @config.yml@ and set @Services.Websocket.ExternalURL@ and @Services.Websocket.InternalURLs@. Replace @zzzzz@ with your cluster id. 
    Services:
       Websocket:
         InternalURLs:
-	  "http://ws.ClusterID.example.com:8005": {}      
+	  "http://localhost:8005": {}
         ExternalURL: wss://ws.ClusterID.example.com/websocket
@@ -35,7 +35,7 @@ h2(#update-nginx). Update Nginx configuration The arvados-ws service will be accessible from anywhere on the internet, so we recommend using SSL for transport encryption. -Use a text editor to create a new file @/etc/nginx/conf.d/arvados-ws.conf@ with the following configuration. Options that need attention are marked with "TODO". +Use a text editor to create a new file @/etc/nginx/conf.d/arvados-ws.conf@ with the following configuration. Options that need attention are marked in red. 
 upstream arvados-ws {
@@ -43,15 +43,15 @@ upstream arvados-ws {
 }
 
 server {
-  listen                [your public IP address]:443 ssl;
-  server_name           ws.uuid_prefix.your.domain;
+  listen                *:443 ssl;
+  server_name           ws.ClusterID.example.com;
 
   proxy_connect_timeout 90s;
   proxy_read_timeout    300s;
 
   ssl                   on;
-  ssl_certificate       YOUR/PATH/TO/cert.pem;
-  ssl_certificate_key   YOUR/PATH/TO/cert.key;
+  ssl_certificate       /YOUR/PATH/TO/cert.pem;
+  ssl_certificate_key   /YOUR/PATH/TO/cert.key;
 
   location / {
     proxy_pass          http://arvados-ws;
@@ -63,55 +63,13 @@ server {
 }
-h2(#install-packages). Install arvados-ws +{% assign arvados_component = 'arvados-ws' %} -h3. Centos 7 +{% include 'install_packages' %} - -
# yum install arvados-ws
-
- - -h3. Debian and Ubuntu - - -
# apt-get --no-install-recommends install arvados-ws
-
- - -h3. Start the service - -If your system does not use systemd, skip this section and follow the "runit instructions":#runit instead. +{% include 'start_service' %} -If your system uses systemd, the arvados-ws service should already be set up. Start it and check its status: - - -
~$ sudo systemctl restart arvados-ws
-~$ sudo systemctl status arvados-ws
-● arvados-ws.service - Arvados websocket server
-   Loaded: loaded (/lib/systemd/system/arvados-ws.service; enabled)
-   Active: active (running) since Tue 2016-12-06 11:20:48 EST; 10s ago
-     Docs: https://doc.arvados.org/
- Main PID: 9421 (arvados-ws)
-   CGroup: /system.slice/arvados-ws.service
-           └─9421 /usr/bin/arvados-ws
-
-Dec 06 11:20:48 zzzzz arvados-ws[9421]: {"level":"info","msg":"started","time":"2016-12-06T11:20:48.207617188-05:00"}
-Dec 06 11:20:48 zzzzz arvados-ws[9421]: {"Listen":":9003","level":"info","msg":"listening","time":"2016-12-06T11:20:48.244956506-05:00"}
-Dec 06 11:20:48 zzzzz systemd[1]: Started Arvados websocket server.
-
- - -If it is not running, use @journalctl@ to check logs for errors: - - -
~$ sudo journalctl -n10 -u arvados-ws
-...
-Dec 06 11:12:48 zzzzz systemd[1]: Starting Arvados websocket server...
-Dec 06 11:12:48 zzzzz arvados-ws[8918]: {"level":"info","msg":"started","time":"2016-12-06T11:12:48.030496636-05:00"}
-Dec 06 11:12:48 zzzzz arvados-ws[8918]: {"error":"pq: password authentication failed for user \"arvados\"","level":"fatal","msg":"db.Ping failed","time":"2016-12-06T11:12:48.058206400-05:00"}
-
- +{% include 'restart_api' %} h2(#restart-api). Restart the API server and controller @@ -122,12 +80,12 @@ After adding the SSO server to the Services section, make sure the cluster confi -h3(#confirm). Confirm working installation +h2(#confirm). Confirm working installation Confirm the service is listening on its assigned port and responding to requests. -
~$ curl http://0.0.0.0:8005/status.json
+
~$ curl https://ws.ClusterID.example.com/status.json
 {"Clients":1}