6941: Add note about needing to fill in correct web server user in places where

[arvados.git] / doc / install / install-workbench-app.html.textile.liquid

diff --git a/doc/install/install-workbench-app.html.textile.liquid b/doc/install/install-workbench-app.html.textile.liquid
index 662a5e5ebc9d5f3620fee11d8a01d37b86551428..b478286c9fc056d892f17eeff4d8689530737bbe 100644 (file)
--- a/doc/install/install-workbench-app.html.textile.liquid
+++ b/doc/install/install-workbench-app.html.textile.liquid
@@ -12,32 +12,24 @@ h3(#install_ruby_and_bundler). Install Ruby and Bundler
 
 {% include 'install_ruby_and_bundler' %}
 
 
 {% include 'install_ruby_and_bundler' %}
 

-h3(#build_tools_workbench). Build tools
+h2(#install_workbench). Install Workbench and dependencies

 
 Workbench doesn't need its own database, so it does not need to have PostgreSQL installed.
 
 
 Workbench doesn't need its own database, so it does not need to have PostgreSQL installed.
 

-On older distributions, you may need to use a backports repository to satisfy these requirements.  For example, on older Red Hat-based systems, consider using the "nginx16":https://www.softwarecollections.org/en/scls/rhscl/nginx16/ Software Collection.
-

 On a Debian-based system, install the following packages:
 
 <notextile>
 On a Debian-based system, install the following packages:
 
 <notextile>

-<pre><code>~$ <span class="userinput">sudo apt-get install bison build-essential graphviz git nginx python-arvados-python-client arvados-workbench</span>
+<pre><code>~$ <span class="userinput">sudo apt-get install bison build-essential graphviz git python-arvados-python-client arvados-workbench</span>

 </code></pre>
 </notextile>
 
 On a Red Hat-based system, install the following packages:
 
 <notextile>
 </code></pre>
 </notextile>
 
 On a Red Hat-based system, install the following packages:
 
 <notextile>

-<pre><code>~$ <span class="userinput">sudo yum install bison make automake gcc gcc-c++ graphviz git nginx python27-python-arvados-python-client arvados-workbench</span>
+<pre><code>~$ <span class="userinput">sudo yum install bison make automake gcc gcc-c++ graphviz git python27-python-arvados-python-client arvados-workbench</span>

 </code></pre>
 </notextile>
 
 </code></pre>
 </notextile>
 

-{% include 'notebox_begin' %}
-
-If you intend to use specific versions of these packages from Software Collections, you may have to adapt some of the package names to match; e.g., @nginx16@.
-
-{% include 'notebox_end' %}
-

 {% include 'note_python27_sc' %}
 
 h2. Set up configuration files
 {% include 'note_python27_sc' %}
 
 h2. Set up configuration files


@@ -120,9 +112,7 @@ For best performance, we recommend you use Nginx as your Web server front-end, w
 
 <notextile>
 <ol>
 
 <notextile>
 <ol>

-<li>Install Nginx via your distribution or a backports repository.</li>
-
-<li><a href="https://www.phusionpassenger.com/documentation/Users%20guide%20Nginx.html">Install Phusion Passenger for Nginx</a>.</li>
+<li><a href="https://www.phusionpassenger.com/documentation/Users%20guide%20Nginx.html">Install Nginx and Phusion Passenger</a>.</li>

 
 <li><p>Edit the http section of your Nginx configuration to run the Passenger server, and act as a front-end for it.  You might add a block like the following, adding SSL and logging parameters to taste:</p>
 
 
 <li><p>Edit the http section of your Nginx configuration to run the Passenger server, and act as a front-end for it.  You might add a block like the following, adding SSL and logging parameters to taste:</p>
 


@@ -149,16 +139,20 @@ server {
   server_name  workbench.<span class="userinput">uuid-prefix.your.domain</span>;
 
   ssl on;
   server_name  workbench.<span class="userinput">uuid-prefix.your.domain</span>;
 
   ssl on;

+  ssl_certificate     <span class="userinput">/YOUR/PATH/TO/cert.pem</span>;
+  ssl_certificate_key <span class="userinput">/YOUR/PATH/TO/cert.key</span>;

 
   index  index.html index.htm index.php;
 
   index  index.html index.htm index.php;

+  client_max_body_size 128m;

 
   location / {
     proxy_pass            http://workbench;
     proxy_redirect        off;
 
   location / {
     proxy_pass            http://workbench;
     proxy_redirect        off;

+    proxy_connect_timeout 90s;
+    proxy_read_timeout    300s;

 
     proxy_set_header      X-Forwarded-Proto https;
     proxy_set_header      Host $http_host;
 
     proxy_set_header      X-Forwarded-Proto https;
     proxy_set_header      Host $http_host;

-    proxy_set_header      X-External-Client $external_client;

     proxy_set_header      X-Real-IP $remote_addr;
     proxy_set_header      X-Forwarded-For $proxy_add_x_forwarded_for;
   }
     proxy_set_header      X-Real-IP $remote_addr;
     proxy_set_header      X-Forwarded-For $proxy_add_x_forwarded_for;
   }


@@ -194,9 +188,8 @@ Next, we're going to use the rails console on the <strong>API server</strong> to
 <notextile>
 <pre><code>/var/www/arvados-api/current$ <span class="userinput">RAILS_ENV=production bundle exec rails console</span>
 irb(main):001:0&gt; <span class="userinput">Thread.current[:user] = User.all.select(&:identity_url).last</span>
 <notextile>
 <pre><code>/var/www/arvados-api/current$ <span class="userinput">RAILS_ENV=production bundle exec rails console</span>
 irb(main):001:0&gt; <span class="userinput">Thread.current[:user] = User.all.select(&:identity_url).last</span>

-irb(main):002:0&gt; <span class="userinput">Thread.current[:user].is_admin = true</span>
-irb(main):003:0&gt; <span class="userinput">Thread.current[:user].update_attributes is_admin: true, is_active: true</span>
-irb(main):004:0&gt; <span class="userinput">User.where(is_admin: true).collect &:email</span>
+irb(main):002:0&gt; <span class="userinput">Thread.current[:user].update_attributes is_admin: true, is_active: true</span>
+irb(main):003:0&gt; <span class="userinput">User.where(is_admin: true).collect &:email</span>

 =&gt; ["root", "<b>your_address@example.com</b>"]
 </code></pre></notextile>
 
 =&gt; ["root", "<b>your_address@example.com</b>"]
 </code></pre></notextile>