X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/dc021c3b57dcdebe464c148d55f9990a74e8246b..2de2c96925cc3439305f16dced7f89bd9124853d:/doc/_includes/_install_ruby_and_bundler.liquid
diff --git a/doc/_includes/_install_ruby_and_bundler.liquid b/doc/_includes/_install_ruby_and_bundler.liquid
index 7871f2dc60..549e144634 100644
--- a/doc/_includes/_install_ruby_and_bundler.liquid
+++ b/doc/_includes/_install_ruby_and_bundler.liquid
@@ -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.
+Ruby 2.6 or newer is required.
* "Option 1: Install from packages":#packages
* "Option 2: Install with RVM":#rvm
@@ -12,14 +12,22 @@ 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
+The Ruby version shipped with Centos 7 is too old. Use "RVM":#rvm to install a newer version of Ruby (we recommend installing version 2.7 or newer).
h3. Debian and Ubuntu
+Debian 10 (buster) and Ubuntu 18.04 (bionic) ship with Ruby 2.5, which is too old for Arvados. Use "RVM":#rvm to install a newer version of Ruby (we recommend installing version 2.7 or newer).
+
+Debian 11 (bullseye) and Ubuntu 20.04 (focal) and later ship with Ruby 2.7 or newer, which is sufficient for Arvados.
+
-# apt-get --no-install-recommends install ruby-dev bundler
+# apt-get --no-install-recommends install ruby ruby-dev
h2(#rvm). Option 2: Install with RVM
@@ -38,38 +46,34 @@ h4. Debian and Ubuntu
apt-get --no-install-recommends install gpg curl
-h3. Install RVM
+h3. Install RVM, Ruby and Bundler
-# gpg --keyserver pool.sks-keyservers.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
-\curl -sSL https://get.rvm.io | bash -s stable --ruby=2.5
+# gpg --keyserver pgp.mit.edu --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
+\curl -sSL https://get.rvm.io | bash -s stable --ruby=2.7
+This command installs the latest Ruby 2.7.x release, as well as the @gem@ and @bundle@ commands.
+
To use Ruby installed from RVM, load it in an open shell like this:
-. /usr/local/rvm/scripts/rvm
+source /usr/local/rvm/scripts/rvm
Alternately you can use @rvm-exec@ (the first parameter is the ruby version to use, or "default"), for example:
-rvm-exec default rails console
+rvm-exec default ruby -v
-Finally, install Bundler:
-
-
-~$ gem install bundler
-
-
h2(#fromsource). Option 3: Install from source
-Install prerequisites for Debian 8:
+Install prerequisites for Debian 10, Ubuntu 18.04 and Ubuntu 20.04:
sudo apt-get install \
- bison build-essential gettext libcurl3 libcurl3-gnutls \
+ bison build-essential gettext libcurl4 \
libcurl4-openssl-dev libpcre3-dev libreadline-dev \
libssl-dev libxslt1.1 zlib1g-dev
@@ -83,25 +87,20 @@ Install prerequisites for CentOS 7:
make automake libtool bison sqlite-devel tar
-Install prerequisites for Ubuntu 12.04 or 14.04:
-
-
-sudo apt-get install \
- gawk g++ gcc make libc6-dev libreadline6-dev zlib1g-dev libssl-dev \
- libyaml-dev libsqlite3-dev sqlite3 autoconf libgdbm-dev \
- libncurses5-dev automake libtool bison pkg-config libffi-dev curl
-
-
Build and install Ruby:
mkdir -p ~/src
cd ~/src
-curl -f http://cache.ruby-lang.org/pub/ruby/2.5/ruby-2.5.5.tar.gz | tar xz
-cd ruby-2.5.5
+curl -f https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.5.tar.gz | tar xz
+cd ruby-2.7.5
./configure --disable-install-rdoc
make
sudo make install
+# Make sure the post install script can find the gem and ruby executables
+sudo ln -s /usr/local/bin/gem /usr/bin/gem
+sudo ln -s /usr/local/bin/ruby /usr/bin/ruby
+# Install bundler
sudo -i gem install bundler