Installation: General Process

This page describes general install process of sup.

If your OS is not listed in Home#Platform-specific-instructions, this page might be helpful.

The following C libraries and their header files are required. It's recommended to install them via your system's native package manager like rpm.

• ncursesw
• uuid
• zlib

Also, a C/C++ compiler like GCC or clang is needed.

Sup runs on MRI Ruby. Ruby versions from 2.0 onwards are supported, but only 2.4+ are regularly tested.

Also, ruby's header files are required since we need to build some extenions.

You can install Ruby via either your system's native package manager or 3rd-party tools like rvm or rbenv.

By default, Sup will try to install the xapian-ruby gem, which bundles a copy of the Xapian bindings for Ruby and builds them from source.

You may prefer to install the Xapian bindings from your system package manager instead, or build them from source, if the xapian-ruby gem is not working. In these cases, set SUP_SKIP_XAPIAN_GEM_INSTALL in your environment when you install Sup. This will skip the dependency on the xapian-ruby gem. You will need to ensure the Xapian bindings are visible in RUBYLIB when running Sup.

Now you can just install sup via gem i sup and rubygems can install all dependencies in Ruby automatically.

If you're running sup from source, see Running from git#Install-dependencies-in-Ruby for how to install dependencies via bundler.

See New User Guide.