~$ sudo apt-get install bison build-essential libcurl4-openssl-dev git nginx arvados-api-server
+~$ sudo apt-get install bison build-essential libcurl4-openssl-dev git arvados-api-server
~$ sudo yum install bison make automake gcc gcc-c++ libcurl-devel nginx git arvados-api-server
+~$ sudo yum install bison make automake gcc gcc-c++ libcurl-devel git arvados-api-server
~$ ruby -e 'puts rand(2**40).to_s(36)[0,5]'
-zzzzz
-~$ ruby -e 'puts rand(2**400).to_s(36)'
@@ -120,7 +115,7 @@ Example @application.yml@:
h3(#blob_signing_key). blob_signing_key
-The @blob_signing_key@ is used to enforce access control to Keep blocks. This same key must be provided to the Keepstore daemons when "installing Keepstore servers.":install-keepstore.html IMPORTANT: This is a site secret. It should be at least 50 characters. Generate a random value and set it to @application.yml@:
+The @blob_signing_key@ is used to enforce access control to Keep blocks. This same key must be provided to the Keepstore daemons when "installing Keepstore servers.":install-keepstore.html IMPORTANT: This is a site secret. It should be at least 50 characters. Generate a random value and set it in @application.yml@:
~$ ruby -e 'puts rand(2**400).to_s(36)'
@@ -160,42 +155,55 @@ Example @application.yml@:
workbench_address: https://workbench.zzzzz.example.com
-h3. websockets_address
+h3. websocket_address
-Set @websockets_address@ to the @@wss://@ URL of the API server websocket endpoint after following "Set up Web servers.":#set_up
+Set @websocket_address@ to the @wss://@ URL of the API server websocket endpoint after following "Set up Web servers":#set_up. The path of the default endpoint is @/websocket@.
Example @application.yml@:
- websockets_address: https://ws.zzzzz.example.com
+ websocket_address: wss://ws.zzzzz.example.com/websocket
-h3(#git_repositories_dir). git_repositories_dir, git_internal_dir
+h3(#git_repositories_dir). git_repositories_dir
-The @git_repositories_dir@ setting specifies the directory is where user git repositories will be stored. By default this is @/var/lib/arvados/git@. You can change the location by defining it in @application.yml@.
+The @git_repositories_dir@ setting specifies the directory where user git repositories will be stored.
-The @git_internal_dir@ setting specifies the directory is where the system internal git repository will be stored. By default this is @/var/lib/arvados/internal.git@. This repository stores git branches that have been used to run crunch jobs.
+The git server setup process is covered on "its own page":install-arv-git-httpd.html. For now, create an empty directory in the default location:
-Example @application.yml@:
+
+~$ sudo mkdir -p /var/lib/arvados/git/repositories
+
+
+If you intend to store your git repositories in a different location, specify that location in @application.yml@.
+
+Default setting in @application.default.yml@:
- git_repositories_dir: /var/lib/arvados/git
- git_internal_dir: /var/lib/arvados/internal.git
+ git_repositories_dir: /var/lib/arvados/git/repositories
-h3. Additional settings
+h3(#git_internal_dir). git_internal_dir
-The file @config/application.default.yml@ (online at "https://arvados.org/projects/arvados/repository/revisions/master/entry/services/api/config/application.default.yml":https://arvados.org/projects/arvados/repository/revisions/master/entry/services/api/config/application.default.yml documents a number of additional configuration settings. Only put local configuration in @application.yml@, do not edit @application.default.yml@.
+The @git_internal_dir@ setting specifies the location of Arvados' internal git repository. By default this is @/var/lib/arvados/internal.git@. This repository stores git commits that have been used to run Crunch jobs. It should _not_ be a subdirectory of @git_repositories_dir@.
+
+Example @application.yml@:
+
+
+ git_internal_dir: /var/lib/arvados/internal.git
+
+
h2. Prepare the API server deployment
Now that all your configuration is in place, run @/usr/local/bin/arvados-api-server-upgrade.sh@. This will install and check your configuration, install necessary gems, and run any necessary database setup.
{% include 'notebox_begin' %}
-You can safely ignore the following error message you may see when loading the database structure:
-
-ERROR: must be owner of extension plpgsql
+You can safely ignore the following messages if they appear while this script runs:
+Don't run Bundler as root. Bundler can ask for sudo if it is needed, and installing your bundle as root will
+break this application for all non-root users on this machine.
+fatal: Not a git repository (or any of the parent directories): .git
{% include 'notebox_end' %}
This command aborts when it encounters an error. It's safe to rerun multiple times, so if there's a problem with your configuration, you can fix that and try again.
@@ -206,11 +214,9 @@ For best performance, we recommend you use Nginx as your Web server front-end, w
-- Install Nginx via your distribution or a backports repository.
-
-- Install Phusion Passenger for Nginx.
+- Install Nginx and Phusion Passenger.
-Puma is already included with the API server's gems. We recommend you use a tool like runit or something similar. Here's a sample run script for that:
+Puma is already included with the API server's gems. We recommend you run it as a service under runit or a similar tool. Here's a sample runit script for that:
#!/bin/bash
@@ -258,17 +264,37 @@ upstream websockets {
proxy_http_version 1.1;
+# When Keep clients request a list of Keep services from the API server, the
+# server will automatically return the list of available proxies if
+# the request headers include X-External-Client: 1. Following the example
+# here, at the end of this section, add a line for each netmask that has
+# direct access to Keep storage daemons to set this header value to 0.
+geo $external_client {
+ default 1;
+ 10.20.30.0/24 0;
+}
+
server {
listen [your public IP address]:443 ssl;
server_name uuid_prefix.your.domain;
ssl on;
+ ssl_certificate /YOUR/PATH/TO/cert.pem;
+ ssl_certificate_key /YOUR/PATH/TO/cert.key;
index index.html index.htm index.php;
+ # This value effectively limits the size of API objects users can create,
+ # especially collections. If you change this, you should also set
+ # `max_request_size` in the API server's application.yml file to the same
+ # value.
+ client_max_body_size 128m;
+
location / {
proxy_pass http://api;
proxy_redirect off;
+ proxy_connect_timeout 90s;
+ proxy_read_timeout 300s;
proxy_set_header X-Forwarded-Proto https;
proxy_set_header Host $http_host;
@@ -283,12 +309,16 @@ server {
server_name ws.uuid_prefix.your.domain;
ssl on;
+ ssl_certificate /YOUR/PATH/TO/cert.pem;
+ ssl_certificate_key /YOUR/PATH/TO/cert.key;
index index.html index.htm index.php;
location / {
proxy_pass http://websockets;
proxy_redirect off;
+ proxy_connect_timeout 90s;
+ proxy_read_timeout 300s;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
@@ -300,7 +330,12 @@ server {
- Restart Nginx.
+Restart Nginx:
+
+~$ sudo nginx -s reload
+
+
+