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