X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/f12f617fb736ddd48e4f2b9f57a6983ff8fe1ed3..c5e4c7027338235435e9698057847686baaee6cc:/doc/install/install-keepproxy.html.textile.liquid?ds=sidebyside diff --git a/doc/install/install-keepproxy.html.textile.liquid b/doc/install/install-keepproxy.html.textile.liquid index 43c1c67265..b110a8bd11 100644 --- a/doc/install/install-keepproxy.html.textile.liquid +++ b/doc/install/install-keepproxy.html.textile.liquid @@ -4,11 +4,12 @@ navsection: installguide title: Install Keepproxy server ... -This installation guide assumes you are on a 64 bit Debian or Ubuntu system. +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.) -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. - -By convention, we use the following hostname for the Keepproxy: +By convention, we use the following hostname for the Keepproxy server:
~$ echo "deb http://apt.arvados.org/ wheezy main" | sudo tee /etc/apt/sources.list.d/apt.arvados.org.list
-~$ sudo /usr/bin/apt-key adv --keyserver pool.sks-keyservers.net --recv 1078ECD7
-~$ sudo /usr/bin/apt-get update
-~$ sudo /usr/bin/apt-get install keepproxy
+~$ sudo apt-get install keepproxy
+
+
~$ sudo yum install keepproxy
~$ 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 ./get_anonymous_user_token.rb
-hoShoomoo2bai3Ju1xahg6aeng1siquuaZ1yae2gi2Uhaeng2r
-
ARVADOS_API_TOKEN={{railsout}} ARVADOS_API_HOST=uuid_prefix.your.domain exec keepproxy
+
++upstream keepproxy { + server 127.0.0.1:25107; +} + +server { + listen [your public IP address]:443 ssl; + server_name keep.uuid_prefix.your.domain; + + proxy_connect_timeout 90s; + proxy_read_timeout 300s; + proxy_set_header X-Real-IP $remote_addr; + + ssl on; + ssl_certificate /etc/nginx/keep.uuid_prefix.your.domain-ssl.crt; + ssl_certificate_key /etc/nginx/keep.uuid_prefix.your.domain-ssl.key; + + # Clients need to be able to upload blocks of data up to 64MiB in size. + client_max_body_size 64m; + + location / { + proxy_pass http://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"
}
EOF