X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/53ee080ab32335c5b77906fea6c50f7bb9ba837f..206451cdcaee133836761024c8517629de429f10:/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 3b5ce04a12..695584fa24 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -86,7 +86,7 @@ h2(#configure_application). Configure the API server Edit @/etc/arvados/api/application.yml@ to configure the settings described in the following sections. The deployment script will consistently deploy this to the API server's configuration directory. The API server reads both @application.yml@ and its own @config/application.default.yml@ file. The settings in @application.yml@ take precedence over the defaults that are defined in @config/application.default.yml@. The @config/application.yml.example@ file is not read by the API server and is provided as a starting template only. -@config/application.default.yml@ documents additional configuration settings not listed here. You can "view the current source version":https://arvados.org/projects/arvados/repository/revisions/master/entry/services/api/config/application.default.yml for reference. +@config/application.default.yml@ documents additional configuration settings not listed here. You can "view the current source version":https://dev.arvados.org/projects/arvados/repository/revisions/master/entry/services/api/config/application.default.yml for reference. Only put local configuration in @application.yml@. Do not edit @application.default.yml@. @@ -197,26 +197,13 @@ Example @application.yml@: -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 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. - 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 Nginx and Phusion Passenger.
  4. 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:

    @@ -235,8 +222,12 @@ echo ws-only > "$envdir/ARVADOS_WEBSOCKETS" cd /var/www/arvados-api/current echo "Starting puma in `pwd`" -# You may need to change arguments below to match your deployment, especially -u. -exec chpst -m 1073741824 -u www-data:www-data -e "$envdir" \ +# 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
  5. @@ -341,3 +332,17 @@ server {
+ +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 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. +