From: Peter Amstutz <peter.amstutz@curii.com>
Date: Mon, 30 Dec 2019 15:02:36 +0000 (-0500)
Subject: Merge branch 'master' into 15572-new-install-docs
X-Git-Tag: 2.0.0~72^2~1
X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/dc021c3b57dcdebe464c148d55f9990a74e8246b

Merge branch 'master' into 15572-new-install-docs

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>
---

dc021c3b57dcdebe464c148d55f9990a74e8246b
diff --cc doc/install/install-ws.html.textile.liquid
index b2605d86c6,0db21573e2..e7b20f45a0
--- a/doc/install/install-ws.html.textile.liquid
+++ b/doc/install/install-ws.html.textile.liquid
@@@ -9,25 -9,58 +9,25 @@@ Copyright (C) The Arvados Authors. All 
  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.
  
 -By convention, we use the following hostname for the websocket service.
 +# "Update config.yml":#update-config
 +# "Update nginx configuration":#update-nginx
 +# "Install arvados-ws package":#install-packages
 +# "Start the service":#start-service
 +# "Restart the API server and controller":#restart-api
 +# "Confirm working installation":#confirm-working
  
 -<notextile>
 -<pre><code>ws.<span class="userinput">uuid_prefix.your.domain</span></code></pre>
 -</notextile>
 -
 -The above hostname should resolve from anywhere on the internet.
 -
 -h2. Install arvados-ws
 -
 -Typically arvados-ws runs on the same host as the API server.
 -
 -On Debian-based systems:
 -
 -<notextile>
 -<pre><code>~$ <span class="userinput">sudo apt-get install arvados-ws</span>
 -</code></pre>
 -</notextile>
 -
 -On Red Hat-based systems:
 -
 -<notextile>
 -<pre><code>~$ <span class="userinput">sudo yum install arvados-ws</span>
 -</code></pre>
 -</notextile>
 +h2(#configure). Update config.yml
  
 -Verify that @arvados-ws@ is functional:
 +Edit the cluster config at @config.yml@ and set @Services.Websocket.ExternalURL@ and @Services.Websocket.InternalURLs@.  Replace @zzzzz@ with your cluster id.
  
  <notextile>
 -<pre><code>~$ <span class="userinput">arvados-ws -h</span>
 -Usage of arvados-ws:
 -  -config path
 -        path to config file (default "/etc/arvados/config.yml")
 -  -dump-config
 -        show current configuration and exit
 -</code></pre>
 -</notextile>
 -
 -h3. Update cluster config
 -
 -Edit the cluster config at @/etc/arvados/config.yml@ and set @Services.Websocket.ExternalURL@ and @Services.Websocket.InternalURLs@.  Replace @zzzzz@ with your cluster id.
 -
 -<notextile>
 -<pre><code>Clusters:
 -  zzzzz:
 -    Services:
 -      <span class="userinput">Websocket:
 -        ExternalURL: wss://ws.uuid_prefix.your.domain/websocket
 +<pre><code>    Services:
 +      Websocket:
          InternalURLs:
 -	  "http://localhost:9003": {}
 +	  "http://localhost:8005"</span>: {}
 +        ExternalURL: <span class="userinput">wss://ws.ClusterID.example.com/websocket</span>
  </span></code></pre>
  </notextile>