Skip to content

Latest commit

 

History

History
96 lines (75 loc) · 3.22 KB

INSTALL.md

File metadata and controls

96 lines (75 loc) · 3.22 KB
Raw

This is how you install zold Ruby gem on different platform.

We are very interested in your contribution to this document. If and when you experience any problems, make changes here via a pull request.

Basically, you need to install Ruby 2.3+, Rubygems, and then the gem.

We recommend to host nodes at AWS or DigitalOcean.

Debian 9.4

$ sudo apt update -y
$ sudo apt install -y ruby-dev rubygems zlib1g-dev libssl-dev make build-essential
$ gem install --no-ri --no-rdoc zold

Ubuntu 16.04

$ sudo apt-get update -y
$ sudo apt-get install -y ruby-dev rubygems zlib1g-dev libssl-dev build-essential
$ gem install --no-ri --no-rdoc zold

OSX

With Homebrew (recommended):

$ brew install rbenv ruby-build
$ rbenv install 2.5.1
$ rbenv global 2.5.1
$ ruby -v
$ gem install --no-ri --no-rdoc zold

Without homebrew:

... please contribute ...

Windows

Download and install RubyInstaller (with Devkit).
If Windows Defender (or antivirus software) throws an error, ignore it and allow the file. This file is known to trigger false positives.
Download and install RubyGems. Manual install ruby setup.rb works.
Install Zold gem gem install --no-ri --no-rdoc zold

CentOS 7.5

As a root user:

$ sudo yum install zlib-devel gcc gcc-c++ ruby-devel rubygems ruby
$ gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
$ curl -sSL https://get.rvm.io | bash -s stable
$ source /etc/profile.d/rvm.sh
$ rvm install 2.5.1
$ gem install --no-ri --no-rdoc zold

Amazon Linux (AWS EC2 default image)

$ sudo yum install zlib-devel gcc gcc-c++ ruby-devel rubygems ruby
$ gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
$ curl -sSL https://get.rvm.io | bash -s stable
$ source $HOME/.rvm/scripts/rvm
$ rvm install 2.5.1
$ gem install --no-ri --no-rdoc zold

PFSense Firewall Configuration

If your node is behind a pfsense firewall, you will need to make some special configurations in order to allow traffic to properly reach your node.

1) Open the PFSense Web GUI Administration console and navigate to Firewall > NAT > Port Forward, followed by clicking "Add"
2) Configure the NAT rules with the following:
    > Interface: WAN
    > Protocol: TCP
    > Source Port: defaults
    > Destination Port: 4096
    > Redirect Target IP: the interface on which your node is listening for requests
    > Redirect Target Port: 4096
    > Description: Port Forwarding Rule for ZOLD
    > Filter rule association: pass
3) Verify configuration using either of these two methods. If you see a JSON document you have properly setup your node:
    > CLI: curl <ip>:4096
    > Browser: http://<ip>:4096