doc/_includes/_install_ruby_and_bundler.liquid

   1 {% comment %}
   2 Copyright (C) The Arvados Authors. All rights reserved.
   3
   4 SPDX-License-Identifier: CC-BY-SA-3.0
   5 {% endcomment %}
   6
   7 Ruby 2.6 or newer is required.
   8
   9 * "Option 1: Install from packages":#packages
  10 * "Option 2: Install with RVM":#rvm
  11 * "Option 3: Install from source":#fromsource
  12
  13 h2(#packages). Option 1: Install from packages
  14
  15 {% include 'notebox_begin' %}
  16 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.
  17 {% include 'notebox_end' %}
  18
  19 h3. Centos 7
  20
  21 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).
  22
  23 h3. Debian and Ubuntu
  24
  25 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).
  26
  27 Debian 11 (bullseye) and Ubuntu 20.04 (focal) and later ship with Ruby 2.7 or newer, which is sufficient for Arvados.
  28
  29 <notextile>
  30 <pre><code># <span class="userinput">apt-get --no-install-recommends install ruby ruby-dev</span></code></pre>
  31 </notextile>
  32
  33 h2(#rvm). Option 2: Install with RVM
  34
  35 h3. Install gpg and curl
  36
  37 h4. Centos 7
  38
  39 <pre>
  40 yum install gpg curl which
  41 </pre>
  42
  43 h4. Debian and Ubuntu
  44
  45 <pre>
  46 apt-get --no-install-recommends install gpg curl
  47 </pre>
  48
  49 h3. Install RVM, Ruby and Bundler
  50
  51 <notextile>
  52 <pre><code># <span class="userinput">gpg --keyserver pgp.mit.edu --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
  53 \curl -sSL https://get.rvm.io | bash -s stable --ruby=2.7
  54 </span></code></pre></notextile>
  55
  56 This command installs the latest Ruby 2.7.x release, as well as the @gem@ and @bundle@ commands.
  57
  58 To use Ruby installed from RVM, load it in an open shell like this:
  59
  60 <notextile>
  61 <pre><code><span class="userinput">source /usr/local/rvm/scripts/rvm
  62 </span></code></pre></notextile>
  63
  64 Alternately you can use @rvm-exec@ (the first parameter is the ruby version to use, or "default"), for example:
  65
  66 <notextile>
  67 <pre><code><span class="userinput">rvm-exec default ruby -v
  68 </span></code></pre></notextile>
  69
  70 h2(#fromsource). Option 3: Install from source
  71
  72 Install prerequisites for Debian 10, Ubuntu 18.04 and Ubuntu 20.04:
  73
  74 <notextile>
  75 <pre><code><span class="userinput">sudo apt-get install \
  76     bison build-essential gettext libcurl4 \
  77     libcurl4-openssl-dev libpcre3-dev libreadline-dev \
  78     libssl-dev libxslt1.1 zlib1g-dev
  79 </span></code></pre></notextile>
  80
  81 Install prerequisites for CentOS 7:
  82
  83 <notextile>
  84 <pre><code><span class="userinput">sudo yum install \
  85     libyaml-devel glibc-headers autoconf gcc-c++ glibc-devel \
  86     patch readline-devel zlib-devel libffi-devel openssl-devel \
  87     make automake libtool bison sqlite-devel tar
  88 </span></code></pre></notextile>
  89
  90 Build and install Ruby:
  91
  92 <notextile>
  93 <pre><code><span class="userinput">mkdir -p ~/src
  94 cd ~/src
  95 curl -f https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.5.tar.gz | tar xz
  96 cd ruby-2.7.5
  97 ./configure --disable-install-rdoc
  98 make
  99 sudo make install
 100
 101 # Make sure the post install script can find the gem and ruby executables
 102 sudo ln -s /usr/local/bin/gem /usr/bin/gem
 103 sudo ln -s /usr/local/bin/ruby /usr/bin/ruby
 104 # Install bundler
 105 sudo -i gem install bundler</span>
 106 </code></pre></notextile>