doc/install/install-keep-web.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install Keep-web server
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 The Keep-web server provides read/write HTTP (WebDAV) access to files stored in Keep. It serves public data to unauthenticated clients, and serves private data to clients that supply Arvados API tokens. It can be installed anywhere with access to Keep services, typically behind a web proxy that provides TLS support. See the "godoc page":http://godoc.org/github.com/curoverse/arvados/services/keep-web for more detail.
  13
  14 By convention, we use the following hostnames for the Keep-web service:
  15
  16 <notextile>
  17 <pre><code>download.<span class="userinput">uuid_prefix</span>.your.domain
  18 collections.<span class="userinput">uuid_prefix</span>.your.domain
  19 *.collections.<span class="userinput">uuid_prefix</span>.your.domain
  20 </code></pre>
  21 </notextile>
  22
  23 The above hostnames should resolve from anywhere on the internet.
  24
  25 h2. Install Keep-web
  26
  27 Typically Keep-web runs on the same host as Keepproxy.
  28
  29 On Debian-based systems:
  30
  31 <notextile>
  32 <pre><code>~$ <span class="userinput">sudo apt-get install keep-web</span>
  33 </code></pre>
  34 </notextile>
  35
  36 On Red Hat-based systems:
  37
  38 <notextile>
  39 <pre><code>~$ <span class="userinput">sudo yum install keep-web</span>
  40 </code></pre>
  41 </notextile>
  42
  43 Verify that @Keep-web@ is functional:
  44
  45 <notextile>
  46 <pre><code>~$ <span class="userinput">keep-web -h</span>
  47 Usage of keep-web:
  48   -allow-anonymous
  49         Serve public data to anonymous clients. Try the token supplied in the ARVADOS_API_TOKEN environment variable when none of the tokens provided in an HTTP request succeed in reading the desired collection. (default false)
  50   -attachment-only-host string
  51         Accept credentials, and add "Content-Disposition: attachment" response headers, for requests at this hostname:port. Prohibiting inline display makes it possible to serve untrusted and non-public content from a single origin, i.e., without wildcard DNS or TLS.
  52   -listen string
  53         Address to listen on: "host:port", or ":port" to listen on all interfaces. (default ":80")
  54   -trust-all-content
  55         Serve non-public content from a single origin. Dangerous: read docs before using!
  56 </code></pre>
  57 </notextile>
  58
  59 {% assign railscmd = "bundle exec ./script/get_anonymous_user_token.rb --get" %}
  60 {% assign railsout = "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" %}
  61 If you intend to use Keep-web to serve public data to anonymous clients, configure it with an anonymous token. You can use the same one you used when you set up your Keepproxy server, or use the following command on the <strong>API server</strong> to create another. {% include 'install_rails_command' %}
  62
  63 Install runit to supervise the Keep-web daemon.  {% include 'install_runit' %}
  64
  65 The basic command to start Keep-web in the service run script is:
  66
  67 <notextile>
  68 <pre><code>export ARVADOS_API_HOST=<span class="userinput">uuid_prefix</span>.your.domain
  69 export ARVADOS_API_TOKEN="<span class="userinput">{{railsout}}</span>"
  70 exec sudo -u nobody keep-web \
  71  -listen=<span class="userinput">:9002</span> \
  72  -attachment-only-host=<span class="userinput">download.uuid_prefix.your.domain</span> \
  73  -allow-anonymous \
  74  2&gt;&amp;1
  75 </code></pre>
  76 </notextile>
  77
  78 Omit the @-allow-anonymous@ argument if you do not want to serve public data.
  79
  80 Set @ARVADOS_API_HOST_INSECURE=1@ if your API server's TLS certificate is not signed by a recognized CA.
  81
  82 h3. Set up a reverse proxy with TLS support
  83
  84 The Keep-web service will be accessible from anywhere on the internet, so we recommend using TLS for transport encryption.
  85
  86 This is best achieved by putting a reverse proxy with TLS support in front of Keep-web, running on port 443 and passing requests to Keep-web on port 9002 (or whatever port you chose in your run script).
  87
  88 Note: A wildcard TLS certificate is required in order to support a full-featured secure Keep-web service. Without it, Keep-web can offer file downloads for all Keep data; however, in order to avoid cross-site scripting vulnerabilities, Keep-web refuses to serve private data as web content except when it is accessed using a "secret link" share. With a wildcard TLS certificate and DNS configured appropriately, all data can be served as web content.
  89
  90 For example, using Nginx:
  91
  92 <notextile><pre>
  93 upstream keep-web {
  94   server                127.0.0.1:<span class="userinput">9002</span>;
  95 }
  96
  97 server {
  98   listen                <span class="userinput">[your public IP address]</span>:443 ssl;
  99   server_name           download.<span class="userinput">uuid_prefix</span>.your.domain
 100                         collections.<span class="userinput">uuid_prefix</span>.your.domain
 101                         *.collections.<span class="userinput">uuid_prefix</span>.your.domain
 102                         ~.*--collections.<span class="userinput">uuid_prefix</span>.your.domain;
 103
 104   proxy_connect_timeout 90s;
 105   proxy_read_timeout    300s;
 106
 107   ssl                   on;
 108   ssl_certificate       <span class="userinput"/>YOUR/PATH/TO/cert.pem</span>;
 109   ssl_certificate_key   <span class="userinput"/>YOUR/PATH/TO/cert.key</span>;
 110
 111   location / {
 112     proxy_pass          http://keep-web;
 113     proxy_set_header    Host            $host;
 114     proxy_set_header    X-Forwarded-For $proxy_add_x_forwarded_for;
 115   }
 116 }
 117 </pre></notextile>
 118
 119 {% include 'notebox_begin' %}
 120 If you restrict access to your Arvados services based on network topology -- for example, your proxy server is not reachable from the public internet -- additional proxy configuration might be needed to thwart cross-site scripting attacks that would circumvent your restrictions. Read the "'Intranet mode' section of the Keep-web documentation":https://godoc.org/github.com/curoverse/arvados/services/keep-web#hdr-Intranet_mode now.
 121 {% include 'notebox_end' %}
 122
 123 h3. Configure DNS
 124
 125 Configure your DNS servers so the following names resolve to your Nginx proxy's public IP address.
 126 * @download.uuid_prefix.your.domain@
 127 * @collections.uuid_prefix.your.domain@
 128 * @*--collections.uuid_prefix.your.domain@, if you have a wildcard TLS certificate valid for @*.uuid_prefix.your.domain@ and your DNS server allows this without interfering with other DNS names.
 129 * @*.collections.uuid_prefix.your.domain@, if you have a wildcard TLS certificate valid for these names.
 130
 131 If neither of the above wildcard options is feasible, you have two choices:
 132 # Serve web content at @collections.uuid_prefix.your.domain@, but only for unauthenticated requests (public data and collection sharing links). Authenticated requests will always result in file downloads, using the @download@ name. For example, the Workbench "preview" button and the "view entire log file" link will invoke file downloads instead of displaying content in the browser window.
 133 # In the special case where you know you are immune to XSS exploits, you can enable the "trust all content" mode in Keep-web (with the @-trust-all-content@ command line flag) and Workbench (with the @trust_all_content@ item in @application.yml@). With both of these enabled, inline web content can be served from a single @collections@ host name; no wildcard DNS or certificate is needed. Do not do this without understanding the security implications described in the "Keep-web documentation":http://godoc.org/github.com/curoverse/arvados/services/keep-web.
 134
 135 h3. Tell Workbench about the Keep-web service
 136
 137 Workbench has features like "download file from collection" and "show image" which work better if the content is served by Keep-web rather than Workbench itself. We recommend using the two different hostnames ("download" and "collections" above) for file downloads and inline content respectively.
 138
 139 Add the following entry to your Workbench configuration file (@/etc/arvados/workbench/application.yml@). This URL will be used for file downloads.
 140
 141 <notextile>
 142 <pre><code>keep_web_download_url: https://download.<span class="userinput">uuid_prefix</span>.your.domain/c=%{uuid_or_pdh}
 143 </code></pre>
 144 </notextile>
 145
 146 Additionally, add *one* of the following entries to your Workbench configuration file, depending on your DNS setup. This URL will be used to serve user content that can be displayed in the browser, like image previews and static HTML pages.
 147
 148 <notextile>
 149 <pre><code>keep_web_url: https://%{uuid_or_pdh}--collections.<span class="userinput">uuid_prefix</span>.your.domain
 150 keep_web_url: https://%{uuid_or_pdh}.collections.<span class="userinput">uuid_prefix</span>.your.domain
 151 keep_web_url: https://collections.<span class="userinput">uuid_prefix</span>.your.domain/c=%{uuid_or_pdh}
 152 </code></pre>
 153 </notextile>