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

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install Keep
   5 ...
   6
   7 This installation guide assumes you are on a 64 bit Debian or Ubuntu system.
   8
   9 First add the Arvados apt repository, and then install the Keep package.
  10
  11 <notextile>
  12 <pre><code>~$ <span class="userinput">echo "# apt.arvados.org" > /etc/apt/sources.list.d/apt.arvados.org.list</span>
  13 ~$ <span class="userinput">echo "deb http://apt.arvados.org/ wheezy main" >> /etc/apt/sources.list.d/apt.arvados.org.list</span>
  14 ~$ <span class="userinput">/usr/bin/apt-key adv --keyserver pgp.mit.edu --recv 1078ECD7</span>
  15 ~$ <span class="userinput">/usr/bin/apt-get update</span>
  16 ~$ <span class="userinput">/usr/bin/apt-get install keep</span>
  17 </code></pre>
  18 </notextile>
  19
  20 Verify that Keep is functional:
  21
  22 <notextile>
  23 <pre><code>~$ <span class="userinput">keep -h</span>
  24 keep -h
  25 2014/07/24 15:38:27 Keep started: pid 13606
  26 Usage of keep:
  27   -data-manager-token-file="": File with the API token used by the Data Manager. All DELETE requests or GET /index requests must carry this token.
  28   -enforce-permissions=false: Enforce permission signatures on requests.
  29   -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.
  30   -permission-key-file="": File containing the secret key for generating and verifying permission signatures.
  31   -permission-ttl=1209600: Expiration time (in seconds) for newly generated permission signatures.
  32   -pid="": Path to write pid file
  33   -serialize=false: If set, all read and write operations on local Keep volumes will be serialized.
  34   -volumes="": Comma-separated list of directories to use for Keep volumes, e.g. -volumes=/var/keep1,/var/keep2. If empty or not supplied, Keep will scan mounted filesystems for volumes with a /keep top-level directory.
  35 </code></pre>
  36 </notextile>
  37
  38 Prepare one or more volumes for Keep to use. Simply create a /keep directory on all the partitions you would like Keep to use, and then start Keep. For example, using 2 tmpfs volumes:
  39
  40 <notextile>
  41 <pre><code>~$ <span class="userinput">keep</span>
  42 2014/07/24 11:41:37 Keep started: pid 20736
  43 2014/07/24 11:41:37 adding Keep volume: /tmp/tmp.vwSCtUCyeH/keep
  44 2014/07/24 11:41:37 adding Keep volume: /tmp/tmp.Lsn4w8N3Xv/keep
  45 2014/07/24 11:41:37 Running without a PermissionSecret. Block locators returned by this server will not be signed, and will be rejected by a server that enforces permissions.
  46 2014/07/24 11:41:37 To fix this, run Keep with --permission-key-file=<path> to define the location of a file containing the permission key.
  47
  48 </code></pre>
  49 </notextile>
  50
  51 It's recommended to run Keep under "runit":https://packages.debian.org/search?keywords=runit or something similar.
  52