16441: Typo fix, used 'zzzzz' in examples.
[arvados.git] / doc / _includes / _install_ruby_and_bundler.liquid
index cebd5d9f68230ce04999fb0194dc61ed5f3ff538..d14e555f89bcdbe35a93ecc7e859a98cea60587c 100644 (file)
@@ -4,7 +4,7 @@ Copyright (C) The Arvados Authors. All rights reserved.
 SPDX-License-Identifier: CC-BY-SA-3.0
 {% endcomment %}
 
-Ruby 2.5 is recommended; Ruby 2.3 is also known to work.
+Minimum of Ruby 2.3 is required.  Ruby 2.5 is recommended.
 
 * "Option 1: Install from packages":#packages
 * "Option 2: Install with RVM":#rvm
@@ -12,15 +12,21 @@ Ruby 2.5 is recommended; Ruby 2.3 is also known to work.
 
 h2(#packages). Option 1: Install from packages
 
+{% include 'notebox_begin' %}
+Future versions of Arvados may require a newer version of Ruby than is packaged with your OS.  Using OS packages simplifies initial install, but may complicate upgrades that rely on a newer Ruby.  If this is a concern, we recommend using "RVM.":#rvm
+{% include 'notebox_end' %}
+
 h3. Centos 7
 
 The Ruby version shipped with Centos 7 is too old.  Use "RVM.":#rvm
 
 h3. Debian and Ubuntu
 
-<pre>
-apt-get --no-install-recommends install bundler
-</pre>
+Debian 9 (stretch) and Ubuntu 16.04 (xenial) ship Ruby 2.3, which is sufficient to run Arvados.  Later releases have newer versions of Ruby that can also run Arvados.
+
+<notextile>
+<pre><code># <span class="userinput">apt-get --no-install-recommends install ruby ruby-dev bundler</span></code></pre>
+</notextile>
 
 h2(#rvm). Option 2: Install with RVM
 
@@ -41,17 +47,23 @@ apt-get --no-install-recommends install gpg curl
 h3. Install RVM
 
 <notextile>
-<pre><code># <span class="userinput">gpg --keyserver keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
+<pre><code># <span class="userinput">gpg --keyserver pool.sks-keyservers.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
 \curl -sSL https://get.rvm.io | bash -s stable --ruby=2.5
 </span></code></pre></notextile>
 
-Either log out and log back in to activate RVM, or explicitly load it in all open shells like this:
+To use Ruby installed from RVM, load it in an open shell like this:
 
 <notextile>
 <pre><code><span class="userinput">. /usr/local/rvm/scripts/rvm
 </span></code></pre></notextile>
 
-Once RVM is activated in your shell, install Bundler:
+Alternately you can use @rvm-exec@ (the first parameter is the ruby version to use, or "default"), for example:
+
+<notextile>
+<pre><code><span class="userinput">rvm-exec default rails console
+</span></code></pre></notextile>
+
+Finally, install Bundler:
 
 <notextile>
 <pre><code>~$ <span class="userinput">gem install bundler</span>