X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/9f277b55034436e3a4ed251e4e86ea088adef20e..6ac835d8869876955d85a86a4b6d35c12b0d63ac:/doc/install/install-keepproxy.html.textile.liquid diff --git a/doc/install/install-keepproxy.html.textile.liquid b/doc/install/install-keepproxy.html.textile.liquid index 26addb7529..fe690a5eda 100644 --- a/doc/install/install-keepproxy.html.textile.liquid +++ b/doc/install/install-keepproxy.html.textile.liquid @@ -3,10 +3,18 @@ layout: default navsection: installguide title: Install Keepproxy server ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -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. +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} -By convention, we use the following hostname for the Keepproxy: +The Keepproxy server is a gateway into your Keep storage. Unlike the Keepstore servers, which are only accessible on the local LAN, Keepproxy is suitable for clients located elsewhere on the internet. Specifically, in contrast to Keepstore: +* A client writing through Keepproxy generates less network traffic: the client sends a single copy of a data block, and Keepproxy sends copies to the appropriate Keepstore servers. +* A client can write through Keepproxy without precomputing content hashes. Notably, the browser-based upload feature in Workbench requires Keepproxy. +* Keepproxy checks API token validity before processing requests. (Clients that can connect directly to Keepstore can use it as scratch space even without a valid API token.) + +By convention, we use the following hostname for the Keepproxy server:
~$ keepproxy -h
-Usage of default:
- -default-replicas=2: Default number of replicas to write if not specified by the client.
- -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.
- -no-get=false: If set, disable GET operations
- -no-put=false: If set, disable PUT operations
- -pid="": Path to write pid file
+...
+Usage: keepproxy [-config path/to/keepproxy.yml]
+...
~/arvados/services/api/script$ RAILS_ENV=production bundle exec ./get_anonymous_user_token.rb
-hoShoomoo2bai3Ju1xahg6aeng1siquuaZ1yae2gi2Uhaeng2r
-
ARVADOS_API_TOKEN=[generated token] ARVADOS_API_HOST=uuid_prefix.your.domain exec keepproxy
+ARVADOS_API_TOKEN={{railsout}} ARVADOS_API_HOST=uuid_prefix.your.domain exec keepproxy
~$ prefix=`arv --format=uuid user current | cut -d- -f1`
-~$ echo "Site prefix is '$prefix'"
+~$ uuid_prefix=`arv --format=uuid user current | cut -d- -f1`
+~$ echo "Site prefix is '$uuid_prefix'"
~$ read -rd $'\000' keepservice <<EOF; arv keep_service create --keep-service "$keepservice"
{
- "service_host":"keep.$prefix.your.domain",
+ "service_host":"keep.$uuid_prefix.your.domain",
"service_port":443,
"service_ssl_flag":true,
"service_type":"proxy"