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   -config file
  49         Site configuration file (default may be overridden by setting an ARVADOS_CONFIG environment variable) (default "/etc/arvados/config.yml")
  50   -dump-config
  51         write current configuration to stdout and exit
  52   -legacy-crunch-dispatch-slurm-config file
  53         Legacy crunch-dispatch-slurm configuration file (default "/etc/arvados/crunch-dispatch-slurm/crunch-dispatch-slurm.yml")
  54   -legacy-keepstore-config file
  55         Legacy keepstore configuration file (default "/etc/arvados/keepstore/keepstore.yml")
  56   -legacy-keepweb-config file
  57         Legacy keep-web configuration file (default "/etc/arvados/keep-web/keep-web.yml")
  58   -legacy-ws-config file
  59         Legacy arvados-ws configuration file (default "/etc/arvados/ws/ws.yml")
  60   -skip-legacy
  61         Don't load legacy config files
  62   -version
  63         print version information and exit.
  64 </code></pre>
  65 </notextile>
  66
  67 {% assign railscmd = "bundle exec ./script/get_anonymous_user_token.rb --get" %}
  68 {% assign railsout = "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" %}
  69 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' %}
  70
  71 Install runit to supervise the Keep-web daemon.  {% include 'install_runit' %}
  72
  73 Set the cluster config file like the following:
  74
  75 <notextile>
  76 <pre><code>Clusters:
  77   <span class="userinput">uuid_prefix</span>:
  78     SystemRootToken: "{{railsout}}"
  79     Services:
  80       Controller:
  81         ExternalURL: "https://<span class="userinput">uuid_prefix</span>.your.domain"
  82         Insecure: false
  83       WebDAV:
  84         InternalURLs:
  85           "http://:9002/": {}
  86       WebDAVDownload:
  87         InternalURLs:
  88           "http://:9002/": {}
  89         ExternalURL: "https://download.<span class="userinput">uuid_prefix</span>.your.domain/"
  90     Users:
  91       AnonymousUserToken: "xxxxxxxxxxxxxxxxxxxx"
  92     Collections:
  93       TrustAllContent: false
  94 </code></pre>
  95 </notextile>
  96
  97 The basic command to start Keep-web in the service run script is:
  98
  99 <notextile>
 100 <pre><code>exec sudo -u nobody keep-web -config=/path/to/arvados.yml
 101 </code></pre>
 102 </notextile>
 103
 104 Set @Users.AnonymousUserToken: ""@ (empty string) if you do not want to serve public data.
 105
 106 Set @Services.Controller.Insecure: true@ if your API server's TLS certificate is not signed by a recognized CA.
 107
 108 h3. Set up a reverse proxy with TLS support
 109
 110 The Keep-web service will be accessible from anywhere on the internet, so we recommend using TLS for transport encryption.
 111
 112 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).
 113
 114 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.
 115
 116 For example, using Nginx:
 117
 118 <notextile><pre>
 119 upstream keep-web {
 120   server                127.0.0.1:<span class="userinput">9002</span>;
 121 }
 122
 123 server {
 124   listen                <span class="userinput">[your public IP address]</span>:443 ssl;
 125   server_name           download.<span class="userinput">uuid_prefix</span>.your.domain
 126                         collections.<span class="userinput">uuid_prefix</span>.your.domain
 127                         *.collections.<span class="userinput">uuid_prefix</span>.your.domain
 128                         ~.*--collections.<span class="userinput">uuid_prefix</span>.your.domain;
 129
 130   proxy_connect_timeout 90s;
 131   proxy_read_timeout    300s;
 132
 133   ssl                   on;
 134   ssl_certificate       <span class="userinput"/>YOUR/PATH/TO/cert.pem</span>;
 135   ssl_certificate_key   <span class="userinput"/>YOUR/PATH/TO/cert.key</span>;
 136
 137   location / {
 138     proxy_pass          http://keep-web;
 139     proxy_set_header    Host            $host;
 140     proxy_set_header    X-Forwarded-For $proxy_add_x_forwarded_for;
 141
 142     client_max_body_size    0;
 143     proxy_http_version      1.1;
 144     proxy_request_buffering off;
 145   }
 146 }
 147 </pre></notextile>
 148
 149 {% include 'notebox_begin' %}
 150 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.
 151 {% include 'notebox_end' %}
 152
 153 h3. Configure DNS
 154
 155 Configure your DNS servers so the following names resolve to your Nginx proxy's public IP address.
 156 * @download.uuid_prefix.your.domain@
 157 * @collections.uuid_prefix.your.domain@
 158 * @*--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.
 159 * @*.collections.uuid_prefix.your.domain@, if you have a wildcard TLS certificate valid for these names.
 160
 161 If neither of the above wildcard options is feasible, you have two choices:
 162 # 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.
 163 # In the special case where you know you are immune to XSS exploits, you can enable the "trust all content" mode in Keep-web and Workbench (setting @Collections.TrustAllContent: true@ on the config file). With this 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.
 164
 165 h3. Tell Workbench about the Keep-web service
 166
 167 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.
 168
 169 Add the following entry to your Workbench cluster configuration file (@/etc/arvados/config.yml@). This URL will be used for file downloads.
 170
 171 <notextile>
 172 <pre><code>Clusters:
 173   zzzzz:
 174     Services:
 175       WebDAVDownload:
 176         ExternalURL: "https://download.<span class="userinput">uuid_prefix</span>.your.domain/c=%{uuid_or_pdh}"
 177 </code></pre>
 178 </notextile>
 179
 180 Additionally, add *one* of the following entries to your Workbench cluster 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.
 181
 182 <notextile>
 183 <pre><code>Clusters:
 184   zzzzz:
 185     Services:
 186       WebDAV:
 187         ExternalURL: "https://%{uuid_or_pdh}--collections.<span class="userinput">uuid_prefix</span>.your.domain"
 188         ExternalURL: "https://%{uuid_or_pdh}.collections.<span class="userinput">uuid_prefix</span>.your.domain"
 189         ExternalURL: "https://collections.<span class="userinput">uuid_prefix</span>.your.domain/c=%{uuid_or_pdh}"
 190 </code></pre>
 191 </notextile>