doc/install/install-keepproxy.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install Keepproxy server
   5 ...
   6
   7 This installation guide assumes you are on a 64 bit Debian or Ubuntu system.
   8
   9 The Keepproxy server is a gateway into your Keep storage. Unlike the Keepstore servers, which are only accessible on the local LAN, Keepproxy is designed to provide secure access into Keep from anywhere on the internet.
  10
  11 By convention, we use the following hostname for the Keepproxy:
  12
  13 <div class="offset1">
  14 table(table table-bordered table-condensed).
  15 |_Hostname_|
  16 |keep.@uuid_prefix@.your.domain|
  17 </div>
  18
  19 This hostname should resolve from anywhere on the internet.
  20
  21 h2. Install Keepproxy
  22
  23 First add the Arvados apt repository, and then install the Keepproxy package.
  24
  25 <notextile>
  26 <pre><code>~$ <span class="userinput">echo "# apt.arvados.org" > /etc/apt/sources.list.d/apt.arvados.org.list</span>
  27 ~$ <span class="userinput">echo "deb http://apt.arvados.org/ wheezy main" >> /etc/apt/sources.list.d/apt.arvados.org.list</span>
  28 ~$ <span class="userinput">/usr/bin/apt-key adv --keyserver pool.sks-keyservers.net --recv 1078ECD7</span>
  29 ~$ <span class="userinput">/usr/bin/apt-get update</span>
  30 ~$ <span class="userinput">/usr/bin/apt-get install keepproxy</span>
  31 </code></pre>
  32 </notextile>
  33
  34 Verify that Keepproxy is functional:
  35
  36 <notextile>
  37 <pre><code>~$ <span class="userinput">keepproxy -h</span>
  38 Usage of default:
  39   -default-replicas=2: Default number of replicas to write if not specified by the client.
  40   -listen=":25107": Interface on which to listen for requests, in the format ipaddr:port. e.g. -listen=10.0.1.24:8000. Use -listen=:port to listen on all network interfaces.
  41   -no-get=false: If set, disable GET operations
  42   -no-put=false: If set, disable PUT operations
  43   -pid="": Path to write pid file
  44 </code></pre>
  45 </notextile>
  46
  47 It's recommended to run Keepproxy under "runit":https://packages.debian.org/search?keywords=runit or something similar.
  48
  49 h3. Create an API token for the Keepproxy server
  50
  51 The Keepproxy server needs a token to talk to the API server.
  52
  53 On the <strong>API server</strong>, use the following command to create the token:
  54
  55 <notextile>
  56 <pre><code>~/arvados/services/api/script$ <span class="userinput">RAILS_ENV=production ./get_anonymous_user_token.rb</span>
  57 hoShoomoo2bai3Ju1xahg6aeng1siquuaZ1yae2gi2Uhaeng2r
  58 </code></pre></notextile>
  59
  60 The value for the @api_token@ field should be added to Keepproxy's environment as ARVADOS_API_TOKEN. Make sure to also set ARVADOS_API_HOST to @uuid_prefix@.your.domain.
  61
  62 h3. Set up a reverse proxy with SSL support
  63
  64 Because the Keepproxy is intended for access from anywhere on the internet, it is recommended to use SSL for transport encryption.
  65
  66 This is best achieved by putting a reverse proxy with SSL support in front of Keepproxy. Keepproxy itself runs on port 25107 by default; your reverse proxy can run on port 443 and pass requests to Keepproxy on port 25107.
  67
  68 h3. Tell the API server about the Keepproxy server
  69
  70 The API server needs to be informed about the presence of your Keepproxy server. Please execute the following commands on your <strong>shell server</strong>.
  71
  72 <notextile>
  73 <pre><code>~$ <span class="userinput">prefix=`arv --format=uuid user current | cut -d- -f1`</span>
  74 ~$ <span class="userinput">echo "Site prefix is '$prefix'"</span>
  75 ~$ <span class="userinput">read -rd $'\000' keepservice &lt;&lt;EOF; arv keep_service create --keep-service "$keepservice"</span>
  76 <span class="userinput">{
  77  "service_host":"keep.$prefix.your.domain",
  78  "service_port":443,
  79  "service_ssl_flag":true,
  80  "service_type":"proxy"
  81 }
  82 EOF</span>
  83 </code></pre></notextile>
  84