X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/d3171a9d75eac20b68cee6729dddc28cd7e6c612..5a3935887ab7ef09d44a38cceb97b8a8346713c7:/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 69ff768ee1..b4019a418a 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -12,10 +12,6 @@ h3(#install_ruby_and_bundler). Install Ruby and Bundler {% include 'install_ruby_and_bundler' %} -h3(#install_postgres). Install PostgreSQL - -{% include 'install_postgres' %} - h2(#install_apiserver). Install API server and dependencies On a Debian-based system, install the following packages: @@ -34,57 +30,17 @@ On a Red Hat-based system, install the following packages: {% include 'install_git' %} -h2. Set up the database +h2(#configure). Set up the database -Generate a new database password. Nobody ever needs to memorize it or type it, so we'll make a strong one: +Configure the API server to connect to your database by updating @/etc/arvados/api/database.yml@. Replace the @xxxxxxxx@ database password placeholder with the "password you generated during database setup":install-postgresql.html#api. Be sure to update the @production@ section. -
~$ ruby -e 'puts rand(2**128).to_s(36)'
-6gqa1vu492idd7yca9tfandj3
+
~$ editor /etc/arvados/api/database.yml
 
-Create a new database user. - - -
~$ sudo -u postgres createuser --encrypted -R -S --pwprompt arvados
-[sudo] password for you: yourpassword
-Enter password for new role: paste-password-you-generated
-Enter it again: paste-password-again
-
- -{% include 'notebox_begin' %} - -This user setup assumes that your PostgreSQL is configured to accept password authentication. Red Hat systems use ident-based authentication by default. You may need to either adapt the user creation, or reconfigure PostgreSQL (in @pg_hba.conf@) to accept password authentication. - -{% include 'notebox_end' %} - -Create the database: - - -
~$ sudo -u postgres createdb arvados_production -T template0 -E UTF8 -O arvados
-
-
- -h2. Set up configuration files - -The API server package uses configuration files that you write to @/etc/arvados/api@ and ensures they're consistently deployed. Create this directory and copy the example configuration files to it: - - -
~$ sudo mkdir -p /etc/arvados/api
-~$ sudo chmod 700 /etc/arvados/api
-~$ cd /var/www/arvados-api/current
-/var/www/arvados-api/current$ sudo cp config/database.yml.example /etc/arvados/api/database.yml
-/var/www/arvados-api/current$ sudo cp config/application.yml.example /etc/arvados/api/application.yml
-
-
- -h2. Configure the database connection - -Edit @/etc/arvados/api/database.yml@ and replace the @xxxxxxxx@ database password placeholders with the PostgreSQL password you generated above. - 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. +Edit @/etc/arvados/api/application.yml@ to configure the settings described in the following sections. 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://dev.arvados.org/projects/arvados/repository/revisions/master/entry/services/api/config/application.default.yml for reference. @@ -205,7 +161,9 @@ For best performance, we recommend you use Nginx as your Web server front-end, w
  1. Install Nginx and Phusion Passenger.
  2. -
  3. 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:

    +
  4. Install runit to supervise the Puma daemon. {% include 'install_runit' %}

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

    #!/bin/bash
     
    @@ -340,14 +298,12 @@ 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.
    +{% assign railspkg = "arvados-api-server" %}
    +{% include 'install_rails_reconfigure' %}
     
     {% include 'notebox_begin' %}
    -You can safely ignore the following messages if they appear while this script runs:
    +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
    {% 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. -