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.7 or newer is required.
   8
   9 * "Option 1: Install from packages":#packages
  10 * "Option 2: Install with RVM":#rvm
  11
  12 h2(#packages). Option 1: Install from packages
  13
  14 h3. Alma/CentOS/Red Hat/Rocky
  15
  16 Version 7 of these distributions does not provide a new enough Ruby version.  Use "RVM":#rvm to install Ruby 2.7 or newer.
  17
  18 Version 8 of these distributions provides Ruby 2.7. You can install it by running:
  19
  20 <notextile>
  21 <pre><code># <span class="userinput">dnf module enable ruby:2.7</span>
  22 # <span class="userinput">dnf install --enablerepo=devel ruby ruby-devel</span></code></pre>
  23 </notextile>
  24
  25 h3. Debian and Ubuntu
  26
  27 Debian 10 (buster) and Ubuntu 18.04 (bionic) ship with Ruby 2.5, which is too old for Arvados. Use "RVM":#rvm to install Ruby 2.7 or newer.
  28
  29 Debian 11 (bullseye) and Ubuntu 20.04 (focal) and later ship with Ruby 2.7 or newer, which is sufficient for Arvados.
  30
  31 <notextile>
  32 <pre><code># <span class="userinput">apt-get --no-install-recommends install ruby ruby-dev</span></code></pre>
  33 </notextile>
  34
  35 h2(#rvm). Option 2: Install with RVM
  36
  37 {% include 'notebox_begin_warning' %}
  38 We do not recommend using RVM unless the Ruby version provided by your OS distribution is older than 2.7.
  39 {% include 'notebox_end' %}
  40
  41 h3. Install gpg and curl
  42
  43 h4. CentOS/Red Hat 7
  44
  45 <pre>
  46 yum install gpg curl which findutils procps
  47 </pre>
  48
  49 {% comment %}
  50 To build ruby 3.2.2 on CentOS 7, add: "yum --enablerepo=powertools install libyaml-devel"
  51 {% endcomment %}
  52
  53 h4. Alma/CentOS/Red Hat/Rocky 8+
  54
  55 <pre>
  56 dnf install gpg curl which findutils procps
  57 </pre>
  58
  59 h4. Debian and Ubuntu
  60
  61 <pre>
  62 apt-get --no-install-recommends install gpg curl ca-certificates dirmngr procps
  63 </pre>
  64
  65 h3. Install RVM, Ruby and Bundler
  66
  67 <notextile>
  68 <pre><code><span class="userinput">gpg --keyserver pgp.mit.edu --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
  69 \curl -sSL https://get.rvm.io | bash -s stable --ruby=2.7.7
  70 </span></code></pre></notextile>
  71
  72 This command installs the Ruby 2.7.7 release, as well as the @gem@ and @bundle@ commands.
  73
  74 To use Ruby installed from RVM, load it in an open shell like this:
  75
  76 <notextile>
  77 <pre><code><span class="userinput">source /usr/local/rvm/scripts/rvm
  78 </span></code></pre></notextile>
  79
  80 Alternately you can use @rvm-exec@ (the first parameter is the ruby version to use, or "default"), for example:
  81
  82 <notextile>
  83 <pre><code><span class="userinput">rvm-exec default ruby -v
  84 </span></code></pre></notextile>