(Closed Beta is now over, this repo is deprecated)

Souq:

For Souq to fully function, the path & secret to your Preferred node needs to be saved in its configuration, this is how you setup a Preferred server for Souq to sync up with.

Overview

A preferred server has a custom set of flows for the core api end points. Built with Node-Red, some additonal nodes, Redis, and Blockstack. All working in unison to enable Souq users to Tag and Fund Projects to the Blockchain.

This repo contains a manual setup guide & docker setup guide (this readme)

The flows for the core api end points can easily imported into your existing Node-Red instance assuming the prerequisite nodes are installed as well as Redis and Blockstack.

A Docker facilitated installation will be used to streamline the setup of all the components of a preferred server. (eg Blockstack, Redis, Node-Red with additional nodes and the flows for the Souq api end points)

Docker Setup Guide:

... insert docker setup steps here ...

Manual Setup Guide:

This guide assumes that you are using Ubuntu 16.04. Before you begin, you should have a non-root user account with sudo privileges set up on your system. (Still under construction)

Update

$ sudo apt-get update then y // update

Install Node

(nodeJS, version control, & Node-Red)

$ sudo apt-get install nodejs then y // install nodejs

$ sudo npm install -g n // to install nodejs version control

$ sudo n 6.10.0 // switch to nodejs version 6.10.0 (required for node-red)

$ sudo apt-get install npm then y // install npm

$ sudo npm install -g node-red then y // install node-red

$ sudo npm cache clean -f // clear npm cache

Test Run Node-Red

(manually test, replace later with P2M)

$ sudo node-red // to start manually

Browse to Server Path example: http://yoursite.com:1880 to test and make sure it loads the flows Editor.

Require Admin Auth on Node-Red Editor

add the following to your settings.js file:

adminAuth: {
    type: "credentials",
    users: [{
        username: "admin",
        password: "$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN.",
        permissions: "*"
    }]
}

The users property is an array of user objects. This allows you to define multiple users, each of whom can have different permissions.

This example configuration defines a single user called admin who has permission to do everything within the editor and has a password of password.

Change Admin Auth on Node-Red Editor

To generate a suitable password hash, you can use the node-red-admin command-line tool:

$ node-red-admin hash-pw

The tool will prompt you for the password you wish to use and then print out the hash that can be copied into the settings.js file.

Note: I would love to see Node-Red Editor support Blockstack Auth directly.

Install 3 additional Node-Red nodes via CLI

(or through the Node-Red palette management via the Editor http ui)

$ cd $HOME/.node-red // change directory to the node-red user data directory

$ npm install node-red-contrib-auth // install node-red jwt auth node via cli

$ npm install node-red-contrib-redis // install node-red redis node via cli

$ npm install node-red-node-mysql // install node-red mysql node via cli

Note: You need to stop and start Node-Red for it to recognized any new nodes.

Install PM2

(to keep Node alive if not using docker)

$ sudo npm install pm2 -g //install

$ cd /usr/local/lib/node_modules/node-red // change directory

$ sudo pm2 start red.js // Invoke Node-Red with PM2 [do not have it already running]

Install Redis

(to geospatially index Project locations)

$ cd $HOME // change to Home directory

$ wget http://download.redis.io/releases/redis-3.2.8.tar.gz

$ tar xvzf redis-3.2.8.tar.gz

$ cd redis-3.2.8

$ make

You might need to install tcl via $ sudo apt-get install tcl before you are able make test.

$ make test

Install Mysql

(to relationally index Project details)

$ ...

Install Blockstack

(to read/write to/from Blockchain)

$ sudo apt-get update && sudo apt-get install -y python-pip python-dev libssl-dev libffi-dev rng-tools // first install PIP & tools

$ sudo pip install --upgrade pip // install latest version (currently 9.0.1)

$ sudo pip install blockstack // install Blockstack CLI

$ blockstack whois fredwilson.id // do a whois lookup of fredwilson.id to test (you might be prompted to save your email to get notifications about blockstack updates, this is optional) ... assuming you eventually get the whois data of fredwilson.id move on.

$ blockstack info // if this is the first time, it will initialize a new wallet, you will be prompted to save a password, DO NOT LOSE THIS PASSWORD OR YOUR MASTER KEY

$ sudo rngd -r /dev/urandom // might be required if you are having troubles generating the wallet (if it stalls out when creating the password)

(Do not lose your master key and password)

Import & Setup Flow:

flows.json // Flow to Manually Import

Configure the JWT node with your Secret

Deploy Changes

Use JWT secret in Souq Full Mode Settings