Skip to content

Latest commit

 

History

History
325 lines (213 loc) · 7.17 KB

BinaryInstall.md

File metadata and controls

325 lines (213 loc) · 7.17 KB
Raw

Installing Crypti (from Binaries)

This tutorial describes how to install the Crypti - Delegate and Developer Edition, using pre-built binary packages.

To complete the installation, you will need to have bash, wget and unzip installed. The majority of operating systems have these installed by default.

1. Select Platform

The following operating systems and architectures are supported:

If you are unsure which platform to choose from, open a terminal and run the following command:

uname -sm

The resulting output, should tell you if your machine is running on a supported operating system and architecture.

If your architecture is not supported yet, you can try building your own packages using the crypti-build automated package building tool.

2. Download Crypti

Follow the relevant download instructions for your selected platform as listed below.

Linux (x86_64)

  1. Download the archive:
wget http://downloads.cryptichain.me/crypti-0.5.4-Linux-x86_64.zip
  1. Unzip the archive:
unzip crypti-0.5.4-Linux-x86_64.zip
  1. Change directory:
cd crypti-0.5.4-Linux-x86_64
  1. Proceed with the next step in this tutorial to Start Crypti.

Linux (i686)

  1. Download the archive:
wget http://downloads.cryptichain.me/crypti-0.5.4-Linux-i686.zip
  1. Unzip the archive:
unzip crypti-0.5.4-Linux-i686.zip
  1. Change directory:
cd crypti-0.5.4-Linux-i686
  1. Proceed with the next step in this tutorial to Start Crypti.

Linux (armv6l)

Tested devices: Raspberry Pi 1 Model B+ / Raspberry Pi Zero

  1. Download the archive:
wget http://downloads.cryptichain.me/crypti-0.5.4-Linux-armv6l.zip
  1. Unzip the archive:
unzip crypti-0.5.4-Linux-armv6l.zip
  1. Change directory:
cd crypti-0.5.4-Linux-armv6l
  1. Proceed with the next step in this tutorial to Start Crypti.

Linux (armv7l)

Tested devices: Raspberry Pi 2 Model B / C.H.I.P.

  1. Download the archive:
wget http://downloads.cryptichain.me/crypti-0.5.4-Linux-armv7l.zip
  1. Unzip the archive:
unzip crypti-0.5.4-Linux-armv7l.zip
  1. Change directory:
cd crypti-0.5.4-Linux-armv7l
  1. Proceed with the next step in this tutorial to Start Crypti.

Darwin (x86_64)

  1. Download the archive:
wget http://downloads.cryptichain.me/crypti-0.5.4-Darwin-x86_64.zip
  1. Unzip the archive:
unzip crypti-0.5.4-Darwin-x86_64.zip
  1. Change directory:
cd crypti-0.5.4-Darwin-x86_64
  1. Proceed with the next step in this tutorial to Start Crypti.

FreeBSD (amd64)

  1. Download the archive:
wget http://downloads.cryptichain.me/crypti-0.5.4-FreeBSD-amd64.zip
  1. Unzip the archive:
unzip crypti-0.5.4-FreeBSD-amd64.zip
  1. Change directory:
cd crypti-0.5.4-FreeBSD-amd64
  1. Proceed with the next step in this tutorial to Start Crypti.

3. Start Crypti

To start crypti, simply run the following command from within the current directory:

bash crypti.sh autostart

On the first invocation of this command: Crypti will configure itself to automatically start when booting your machine, and a snapshot of the blockchain will be downloaded for your convenience.

To access the Crypti web client, open: http://localhost:8040/, or replace localhost with your public IP address.

The Crypti web client should launch successfully.

4. Enable Forging

If you are running your node from a local machine, you can enable forging through the web client, without further interruption. NOTE: Should the Crypti node or machine need to be restarted, you will need to re-enable forging again.

If your node is running on a remote machine, or if you want to keep forging persistently enabled, you will need to follow the below instructions.

Stop the running Crypti node:

bash crypti.sh stop

Open config.json:

nano config.json

Arrow down until you find the following section:

"forging": {
  "secret" : [""]
}

Set the secret parameter to your account secret phrase.

"forging": {
  "secret" : ["YourDelegatePassphrase"] <- Replace with your delegate passphrase
}

(Optional) In the forging section you will also see an access property, this is used to allow only your IP address to enable forging through the web client.

"access": {
  "whiteList": ["127.0.0.1"] <- Replace with the IP which you will use to access your node
}

To set 2 accounts to forge on a single node, enter both account passphrases like below.

"forging": {
  "secret" : ["YourDelegatePassphrase1","YourDelegatePassphrase2"] <- Replace with your delegate passphrases
  "access": {
    "whiteList": ["127.0.0.1"]
  }
}

After you have typed in your passphrase. Hit: Ctrl+ X Then: Y

Start Crypti:

bash crypti.sh start

Then, open the Crypti web client and wait for the blockchain to load. Once the blockchain has loaded, navigate to "Forging" section, and verify that Forging (Enabled) appears in the top left corner.

5. Enable Secure Sockets Layer (SSL)

NOTE: To complete this step you require a signed certificate (from a CA) and a public and private key pair.

Stop the running Crypti node:

bash crypti.sh stop

Open config.json:

nano config.json

Arrow down until you find the following section:

"ssl": {
  "enabled": false,         < Change FROM false TO true
  "options": {
    "port": 443,            < Default SSL Port
    "address": "0.0.0.0",   < Change only if you wish to block web access to the node
    "key": "path_to_key",   < Replace FROM path_to_key TO actual path to key file
    "cert": "path_to_cert"  < Replace FROM path_to_cert TO actual path to certificate file
  }
}

After you are done, save changes and exit. Hit: Ctrl+ X Then: Y

NOTE: If SSL Port configured above (ssl > options > port) is within well known ports range (below 1024), you must start Crypti with admin rights:

sudo bash crypti.sh start

If the port is above 1023, you can start Crypti normally:

bash crypti.sh start

Open the web client. You should now have an SSL enabled connection.

6. Available Commands

Listed below, are the available commands which can be used to manage your Crypti node.

To check the status of crypti:

bash crypti.sh status

To monitor the log file of crypti:

bash crypti.sh logs

To stop/restart/start crypti:

bash crypti.sh stop
bash crypti.sh start
bash crypti.sh restart

To automatically start crypti when booting the machine:

bash crypti.sh autostart

To replace the blockchain with a new snapshot:

bash crypti.sh rebuild