Merge branch 'master' into 4091-test-infinite-scrolling

[arvados.git] / doc / install / install-keep.html.textile.liquid

diff --git a/doc/install/install-keep.html.textile.liquid b/doc/install/install-keep.html.textile.liquid
index dbb411b46540a67f2d204cf85c2f692fcde4fdfe..20670f3740601f34b92bc1ae0ab2354079ee8a0a 100644 (file)
--- a/doc/install/install-keep.html.textile.liquid
+++ b/doc/install/install-keep.html.textile.liquid
@@ -13,20 +13,20 @@ First add the Arvados apt repository, and then install the Keep package.
 ~$ <span class="userinput">echo "deb http://apt.arvados.org/ wheezy main" >> /etc/apt/sources.list.d/apt.arvados.org.list</span>
 ~$ <span class="userinput">/usr/bin/apt-key adv --keyserver pgp.mit.edu --recv 1078ECD7</span>
 ~$ <span class="userinput">/usr/bin/apt-get update</span>
-~$ <span class="userinput">/usr/bin/apt-get install keep</span>
+~$ <span class="userinput">/usr/bin/apt-get install keepstore</span>
 </code></pre>
 </notextile>
 
 Verify that Keep is functional:
 
 <notextile>
-<pre><code>~$ <span class="userinput">keep -h</span>
-keep -h
+<pre><code>~$ <span class="userinput">keepstore -h</span>
 2014/07/24 15:38:27 Keep started: pid 13606
-Usage of keep:
+Usage of keepstore:
   -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.
   -enforce-permissions=false: Enforce permission signatures on requests.
   -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.
+  -never-delete=false: If set, nothing will be deleted. HTTP 405 will be returned for valid DELETE requests.
   -permission-key-file="": File containing the secret key for generating and verifying permission signatures.
   -permission-ttl=1209600: Expiration time (in seconds) for newly generated permission signatures.
   -pid="": Path to write pid file
@@ -35,10 +35,12 @@ Usage of keep:
 </code></pre>
 </notextile>
 
+If you want access control on your Keep server(s), you should provide a permission key. The @-permission-key-file@ argument should contain the path to a file that contains a single line with a long random alphanumeric string. It should be the same as the @blob_signing_key@ that can be set in the "API server":install-api-server.html config/application.yml file.
+
 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:
 
 <notextile>
-<pre><code>~$ <span class="userinput">keep</span>
+<pre><code>~$ <span class="userinput">keepstore</span>
 2014/07/24 11:41:37 Keep started: pid 20736
 2014/07/24 11:41:37 adding Keep volume: /tmp/tmp.vwSCtUCyeH/keep
 2014/07/24 11:41:37 adding Keep volume: /tmp/tmp.Lsn4w8N3Xv/keep