X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/eb73e21144a3b6460d7550583860b25fba3fffc8..0662b235357dd40b5d27efd06b60044ddcec06f6:/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 f2a518a244..69ff768ee1 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -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:

    @@ -257,6 +244,14 @@ exec chpst -m 1073741824 -u webserver-user:webserver-group -e "$envdir" \ passenger_enabled on; # If you're using RVM, uncomment the line below. #passenger_ruby /usr/local/rvm/wrappers/default/ruby; + + # This value effectively limits the size of API objects users can + # create, especially collections. If you change this, you should + # also ensure the following settings match it: + # * `client_max_body_size` in the server section below + # * `client_max_body_size` in the Workbench Nginx configuration (twice) + # * `max_request_size` in the API server's application.yml file + client_max_body_size 128m; } upstream api { @@ -290,10 +285,7 @@ server { 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. + # Refer to the comment about this setting in the server section above. client_max_body_size 128m; location / { @@ -345,3 +337,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. +