X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/a812a13a6e9854f37ecebccedeb163b8cbe7130e..8626abb0a44cfc303bef3552a7bc57163c79231a:/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 8625e7f54e..fb43f783f0 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -32,6 +32,8 @@ On a Red Hat-based system, install the following packages: +{% include 'install_git' %} + h2. 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: @@ -84,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@. @@ -155,33 +157,34 @@ 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: wss://ws.zzzzz.example.com
+ websocket_address: wss://ws.zzzzz.example.com/websocket
git_repositories_dir: /var/lib/arvados/git
-
-~$ sudo mkdir -p /var/lib/arvados/git/repositories
+
-Make sure a clone of the arvados repository exists in @git_repositories_dir@.
+If you intend to store your git repositories in a different location, specify that location in @application.yml@.
+
+Default setting in @application.default.yml@:
~$ sudo mkdir -p /var/lib/arvados/git
-~$ sudo git clone --bare git://git.curoverse.com/arvados.git /var/lib/arvados/git/arvados.git
-
git_repositories_dir: /var/lib/arvados/git/repositories
+
+
h3(#git_internal_dir). git_internal_dir
@@ -194,18 +197,6 @@ 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 error message you may see when loading the database structure:
-ERROR: must be owner of extension plpgsql
Restart Nginx:
+ +~$ sudo nginx -s reload
+
+
+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. +