Merge branch 'master' into 6663-git-server
authorTom Clegg <tom@curoverse.com>
Mon, 3 Aug 2015 19:50:28 +0000 (15:50 -0400)
committerTom Clegg <tom@curoverse.com>
Mon, 3 Aug 2015 19:50:28 +0000 (15:50 -0400)
Conflicts:
doc/install/install-api-server.html.textile.liquid

1  2 
doc/install/install-api-server.html.textile.liquid
services/api/config/application.default.yml

index f5d58253773e47f1bd7c9887ce8bb45111351cf5,3c188e3828f3145ca59717c425526378149586d9..16b32365ac5164be0b8ed4b03505528b25fd6a1a
@@@ -117,26 -147,52 +147,51 @@@ Example @application.yml@
  
  h3. workbench_address
  
- Fill in the url of your workbench application in @workbench_address@, for example
+ Set @workbench_address@ to the URL of your workbench application after following "Install Workbench.":install-workbench-app.html
+ Example @application.yml@:
+ <notextile>
+ <pre><code>  workbench_address: <span class="userinput">https://workbench.zzzzz.example.com</span></code></pre>
+ </notextile>
+ h3. websockets_address
+ Set @websockets_address@ to the @wss://@ URL of the API server websocket endpoint after following "Set up Web servers.":#set_up
+ Example @application.yml@:
+ <notextile>
+ <pre><code>  websockets_address: <span class="userinput">wss://ws.zzzzz.example.com</span></code></pre>
+ </notextile>
+ h3(#git_repositories_dir). git_repositories_dir
  
- &nbsp;&nbsp;https://workbench.@uuid_prefix@.your.domain
 -The @git_repositories_dir@ setting specifies the directory where user git repositories will be stored.  By default this is @/var/lib/arvados/git@.
++The @git_repositories_dir@ setting specifies the directory where user git repositories will be stored.
  
- h3(#omniauth). sso_app_id, sso_app_secret, sso_provider_url
 -Example @application.yml@:
++Some additional git setup will be done on the "next page":install-arv-git-httpd.html. For now, create an empty directory in the default location:
  
- For @sso_app_id@ and @sso_app_secret@, provide the same @app_id@ and @app_secret@ used in the "Create arvados-server client for Single Sign On (SSO)":install-sso.html#client step.
+ <notextile>
 -<pre><code>  git_repositories_dir: <span class="userinput">/var/lib/arvados/git</span>
 -</code></pre>
 -</notextile>
++<pre><code>~$ <span class="userinput">sudo mkdir -p /var/lib/arvados/git/repositories</span>
++</code></pre></notextile>
  
- For @sso_provider_url@, provide the base URL where your SSO server is installed: just the scheme and host, with no trailing slash.
 -Make sure a clone of the arvados repository exists in @git_repositories_dir@.
++Example @application.yml@:
  
  <notextile>
- <pre><code>  sso_app_id: arvados-server
-   sso_app_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-   sso_provider_url: https://sso.example.com
 -<pre><code>~$ <span class="userinput">sudo mkdir -p /var/lib/arvados/git</span>
 -~$ <span class="userinput">sudo git clone --bare git://git.curoverse.com/arvados.git /var/lib/arvados/git/arvados.git</span>
 -</code></pre></notextile>
++<pre><code>  git_repositories_dir: <span class="userinput">/var/lib/arvados/git/repositories</span>
 +</code></pre>
 +</notextile>
  
- h3. Other options
+ h3(#git_internal_dir). git_internal_dir
+ The @git_internal_dir@ setting specifies the location of Arvados' internal git repository.  By default this is @/var/lib/arvados/internal.git@.  This repository stores git commits that have been used to run Crunch jobs.  It should _not_ be a subdirectory of @git_repositories_dir@.
+ Example @application.yml@:
  
- Consult @/var/www/arvados-api/current/config/application.default.yml@ for a full list of configuration options. (But don't edit it. Edit @application.yml@ instead.)
+ <notextile>
+ <pre><code>  git_internal_dir: <span class="userinput">/var/lib/arvados/internal.git</span>
+ </code></pre>
+ </notextile>
  
  h2. Prepare the API server deployment