X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/e016b28393b74cd30a78ebe03eca7e37a51fefd3..987457b7e545f4ad1e32c7a07c00c29c24326421:/doc/install/install-api-server.html.textile.liquid diff --git a/doc/install/install-api-server.html.textile.liquid b/doc/install/install-api-server.html.textile.liquid index b4019a418a..7201460dde 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -3,6 +3,11 @@ layout: default navsection: installguide title: Install the API server ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} h2. Install prerequisites @@ -153,45 +158,15 @@ Example @application.yml@: -h2(#set_up). Set up Web servers - -For best performance, we recommend you use Nginx as your Web server front-end, with a Passenger backend for the main API server and a Puma backend for API server Websockets. To do that: - - -
    -
  1. Install Nginx and Phusion Passenger.
  2. - -
  3. Install runit to supervise the Puma daemon. {% include 'install_runit' %}

  4. - -
  5. Install the script below as the run script for the Puma service, modifying it as directed by the comments.

    - -
    #!/bin/bash
    -
    -set -e
    -exec 2>&1
    -
    -# Uncomment the line below if you're using RVM.
    -#source /etc/profile.d/rvm.sh
    -
    -envdir="`pwd`/env"
    -mkdir -p "$envdir"
    -echo ws-only > "$envdir/ARVADOS_WEBSOCKETS"
    +h2(#set_up). Set up Nginx and Passenger
     
    -cd /var/www/arvados-api/current
    -echo "Starting puma in `pwd`"
    +The Nginx server will serve API requests using Passenger. It will also be used to proxy SSL requests to other services which are covered later in this guide.
     
    -# Change arguments below to match your deployment, "webserver-user" and
    -# "webserver-group" should be changed to the user and group of the web server
    -# process.  This is typically "www-data:www-data" on Debian systems by default,
    -# other systems may use different defaults such the name of the web server
    -# software (for example, "nginx:nginx").
    -exec chpst -m 1073741824 -u webserver-user:webserver-group -e "$envdir" \
    -  bundle exec puma -t 0:512 -e production -b tcp://127.0.0.1:8100
    -
    -
  6. +First, "Install Nginx and Phusion Passenger":https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_passenger_main.html. -
  7. Edit the http section of your Nginx configuration to run the Passenger server, and act as a front-end for both it and Puma. You might add a block like the following, adding SSL and logging parameters to taste:

    +Edit the http section of your Nginx configuration to run the Passenger server, and serve SSL requests. Add a block like the following, adding SSL and logging parameters to taste: +
    server {
       listen 127.0.0.1:8000;
       server_name localhost-api;
    @@ -216,11 +191,6 @@ upstream api {
       server     127.0.0.1:8000  fail_timeout=10s;
     }
     
    -upstream websockets {
    -  # The address below must match the one specified in puma's -b option.
    -  server     127.0.0.1:8100  fail_timeout=10s;
    -}
    -
     proxy_http_version 1.1;
     
     # When Keep clients request a list of Keep services from the API server, the
    @@ -259,41 +229,14 @@ server {
         proxy_set_header      X-Forwarded-For $proxy_add_x_forwarded_for;
       }
     }
    -
    -server {
    -  listen       [your public IP address]:443 ssl;
    -  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";
    -    proxy_set_header      Host $host;
    -    proxy_set_header      X-Real-IP $remote_addr;
    -    proxy_set_header      X-Forwarded-For $proxy_add_x_forwarded_for;
    -  }
    -}
     
    -
  8. + -
  9. Restart Nginx:

    +Restart Nginx to apply the new configuration. +
    ~$ sudo nginx -s reload
     
    - -
  10. - -
h2. Prepare the API server deployment @@ -303,7 +246,9 @@ h2. Prepare the API server deployment {% include 'notebox_begin' %} You can safely ignore the following messages if they appear while this command 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
+ +
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' %}