Skip to content

Latest commit

 

History

History
146 lines (100 loc) · 3.84 KB

INSTALLATION.md

File metadata and controls

146 lines (100 loc) · 3.84 KB

SiteDiff: Installation

The SiteDiff CLI, as the name suggests, is mostly a command-line tool powered by Ruby. Please refer to the proper installation instructions depending on your operating system.

Table of contents

CentOS

These instructions are for CentOS 7 or higher.

You'll need Ruby 3.1.2 or higher.

We recommend using one of the following to install Ruby:

Here are some dependencies which mostly require a manual installation.

sudo yum install libzip-devel gcc patch make
sudo yum install libxml2-devel libxslt-devel libcurl

We recommend installing nokogiri before the SiteDiff gem. If possible, avoid using sudo for gem install.

gem install nokogiri --no-rdoc --no-ri -- --use-system-libraries=true —with-xml2-include=/usr/include/libxml2
gem install sitediff -v '1.2.1'

Docker

There is a Dockerfile in the root of the SiteDiff git repository. It uses the Docker offical Ruby image. Note that SiteDiff will use port 13080 for the result server. The following Docker image tags are available to be pulled.

  • latest (master branch)
  • 1.0.0
  • 1.0.0-rc1
  • 0.0.6
docker run -p 13080:13080 -t -d --name sitediff evolvingweb/sitediff:latest
docker exec -it sitediff /bin/bash

If used on Apple silicon (m1), you can force the amd64 platform:

docker run --platform linux/amd64 -p 13080:13080 -t -d --name sitediff evolvingweb/sitediff:latest
docker exec -it sitediff /bin/bash

MacOS

You will need Homebrew for Mac.

If your version of Ruby is not 3.1.2 or later, you will need to upgrade.

rbenv is recommended for managing Ruby versions.

To install with Homebrew:

brew install rbenv ruby ruby-build

There are many dependencies, which are often already installed on many Macs.

brew install autoconf libffi libtool libyaml openssl pkg-config

If you prefer not to use Homebrew, you can install manually. See: https://github.com/rbenv/rbenv#basic-github-checkout

We recommend installing nokogiri before the sitediff gem. However, on most recent Macs, the nokogiri step below will fail and it can be safely skipped. If possible avoid using sudo for gem install.

gem install nokogiri --no-rdoc --no-ri -- --use-system-libraries=true —with-xml2-include=/usr/include/libxml2
gem install sitediff -v '1.2.1'

Ubuntu

These instructions are for Ubuntu 16.04 or higher.

You'll need Ruby 3.1.2 or higher.

We recommend using one of the following to install Ruby:

Here are some dependencies which mostly require a manual installation.

sudo apt-get install -y ruby-dev libz-dev gcc patch make
sudo apt-get install -y libxml2-dev libxslt-dev libcurl3

We recommend installing nokogiri before the SiteDiff gem. If possible, avoid using sudo for gem install.

gem install nokogiri --no-rdoc --no-ri -- --use-system-libraries=true --with-xml2-include=/usr/include/libxml2
gem install sitediff

Windows

SiteDiff doesn't officially support the Windows operating system. However, you should be able to use SiteDiff inside a VM or a Docker container on Windows.

Development

You will need the same dependencies installed as required for the gem. Depending on what you use for development, please see instructions for CentOS, MacOS, Ubuntu above.

Install bundler on your system.

gem install bundle

There is an up-to-date configuration file for bundle which you can use.

git clone https://github.com/evolvingweb/sitediff
cd sitediff
git checkout dev
bundle install