DFX Installation Guide

This chapter provides documentation about the DFX installation process.

Prerequisites

DFX runs on Unix based systems (Linux, MAC OS etc). First, you have to install these libraries and servers:

• Node.js >= 6.0.0 and Npm >= 3.8.6: https://nodejs.org/en/download/package-manager/
• Mongo DB >= 3.00: https://docs.mongodb.com/manual/installation/
• Grunt >= 0.4.5: http://gruntjs.com/getting-started
• Redis >= 3.2.1: https://redis.io/topics/quickstart
• Git >= 1.9.1: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git. Note, that Git should be accessible via ssh without authentication.

If you don't have installed GitHub SSH Key, you have to do two additional steps:

• Generate GitHub SSH Key and install it: https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/
• Add SSH key to your GitHub account: https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/

Important: after installing, you have to run Mongo and Redis servers.

Install DFX

DFX contains several main modules:

• DFM - DreamFace Manager
• DFX - DreamFace Server
• DFC - DreamFace Compiler

You can install the whole product by installing DFM using the operational system command line. DFM will install other modules itself.

Steps to install DFX via command line:

• Create folder where DFX will be installed: mkdir /var/lib/dreamface or sudo mkdir /var/lib/dreamface

• Change folder owner to your account: sudo chown 'your_user_name': /var/lib/dreamface

• Go to the product folder: cd /var/lib/dreamface

• Clone the project from Git (more exactly, its DFM module): git clone https://github.com/InteractiveClouds/dfm.git

• Go to the cloned project and install node modules: cd dfm && npm install

• Create a symbolic link: sudo ln -s /var/lib/dreamface/dfm/index.js /usr/local/bin/dreamface

• Clone services and create folders structure: dreamface install 50.50.50.50 (where 50.50.50.50 is your external server IP. If you do not specify this parameter, '127.0.0.1' will be use by default)

  • If dreamface command does not run, you can try another way: run back to back commands cd /var/lib/dreamface/dfm and node index.js install 50.50.50.50

• Start DFX - run the command dreamface update or node index.js update (which internally runs grunt build && npm install in /var/lib/dreamface/dfc and /var/lib/dreamface/dfx folders)

Start using DFX

Right now, DFX Studio supports Chrome browser.

• Open DFX Console using this URL: http://[localhost]:3000/console. Do not forget to replace localhost for your IP address. Port 3000 is your DFX Server port number. Default credentials for DFX Console are:

Login: sys

Password: admin

• After login into DFX Console, you will be asked to change default credentials.
• Next step is to create tenant to build your applications:

• Then, open DFX Studio by clicking on "Open Studio" button near your tenant. Default credentials for your tenant (do not confuse with credentials to DFX console):

Login: admin

Password: the one that you provided when created tenant above.

• Start creating your applications!