Difference between revisions of "Core (real-time) Framework v0.1 - Installation Instructions"

Latest revision as of 08:28, 10 April 2014

This page only applies to v0.1 (2012) of the GPII framework - please see: Setting Up Your Development Environment for more current instructions

This release supports two platforms: Windows 7 and Fedora Linux with Gnome 3. Installation instructions can be found below.

Fedora 17

Requirements:

Fedora 17 needs to be installed. Installation requires super-user privileges.

Installation Instructions

Ensure pre-requisites

sudo yum install kernel-devel kernel-headers dkms gcc gcc-c++ \
  git openssl-devel glib-devel glib2-devel gtk3-devel \
  pcsc-lite-devel pcsc-lite pcsc-perl

Install node

sudo yum localinstall --nogpgcheck http://nodejs.tchol.org/repocfg/fedora/nodejs-stable-release.noarch.rpm
sudo yum install nodejs nodejs-devel nodejs-gyp nodejs-doc nodejs-debuginfo
sudo ln -s /usr/bin/node /usr/bin/nodejs

Install RFID listener

(only required if you want to use a RFID listener on the system)

Go to the location where you want to install the GPII

Clone the GPII PCSC Tools Repository

git clone https://github.com/GPII/linux-rfid-user-listener
cd linux-rfid-user-listener

Compile and install

make all
sudo make install

Final step is to start a daemon running in the background and the scanner

Start first daemon and then scanner:

sudo /usr/sbin/pcscd
./pcsc_scan

Install and run GPII Personalization Framework

Make sure you're in the directory where you want to install the GPII.

From the command line:

# Clone the GPII Linux repository:
git clone git://github.com/GPII/linux.git
cd linux
git checkout origin/v0.1

# Build the Framework:
./build.sh

# Start up the Personalization Framework:
./start.sh

Running the framework in general

After having followed the above steps, you will have installed the GPII and it should be running on the machine. In general (for example after a reboot), you would have to do the following steps:

To starts GPII, go to the GPII install dir, then:

cd linux
./start.sh

To enable the RFID listener, go to the GPII install dir, then:

cd linux-rfid-user-listener
sudo /usr/sbin/pcscd
./pcsc_scan

Windows Installation Instructions

Dependencies

Git
- Go to http://code.google.com/p/msysgit/downloads/list?q=full+installer+official+git and download the latest release of Git
- Or, for advanced developers, use Cygwin for a full Unix-like environment on Windows
- Be sure to choose "Run Git from the Windows Command Prompt" on the "Adjusting your PATH environment" panel

Node
- Go to http://nodejs.org/download/, and choose the 32-bit (x86) version for Windows. NB - we've had issues with the latest version of node, so to be on the safe side, we suggest you use 0.8.23, found here: http://nodejs.org/dist/v0.8.23/ - for windows, download the file ending in "x86.msi"

MinGW
- Download and run http://sourceforge.net/projects/mingw/files/Installer/mingw-get-inst/mingw-get-inst-20120426/
- When installing MinGW, make sure the C and C++ compiler checkboxes are on
- Add C:\MinGW\bin to your PATH variable (Right click My Computer > Properties > Advanced > Environment Variables)
Microsoft Visual C++ 2010 Redistributable Package (x86)
- Download and install from http://www.microsoft.com/en-us/download/details.aspx?id=5555
Microsoft Hotfix for issue KB2516889 - this issue prevents the application of the "High Contrast" desktop profile on all modern versions of Windows (7 and 8)
- Download and install from http://support.microsoft.com/kb/2516889

Building and Starting

Open up cmd.exe (Start > Run > cmd.exe)
Create a GPII directory
- mkdir c:\gpii (or wherever you prefer)
- cd c:\gpii
Clone the GPII Windows repository and make sure we got the correct version
- git clone git://github.com/GPII/windows.git
- cd windows
- git checkout origin/v0.1
Compile the GPII Windows native code (run the following command from the Windows/DOS shell):
- build.cmd
Start the GPII Framework and the USB Listener (from the Windows/DOS shell - not the Git Bash sell - while in the gpii\windows folder):
- start.cmd

Setup and Configuration

On Windows 7, the GPII can't currently kill applications using taskill unless you:
- Go into Control Panel > User Accounts and Family Safety > User Accounts > User Account Control Settings
- Set the notification level to "Never notify"

RFID Listener

The RFID is currently at an experimental state and only available as an exe. It can be found here: https://www.dropbox.com/s/n7ntpzvj4v1ksm8/GpiiUserListener110.exe

Testing

Once you start the system (by using the start.cmd/start.sh scripts), you can test it without USB by navigating your browser to the following URLs:

http://localhost:8081/user/sammy/login (This will run the windows magnifier which can be exited with the WindowsKey + Esc)

http://localhost:8081/user/sammy/logout

To test the USB listener create a file '.gpii-user-token.txt' in the root of a USB memory stick containing the text "sammy" (no quotes). Insert the stick to login and remove it to logout.

Difference between revisions of "Core (real-time) Framework v0.1 - Installation Instructions"

Latest revision as of 08:28, 10 April 2014

Contents

Fedora 17

Requirements:

Installation Instructions

Ensure pre-requisites

Install node

Install RFID listener

Install and run GPII Personalization Framework

Running the framework in general

Windows Installation Instructions

Dependencies

Building and Starting

Setup and Configuration

RFID Listener

Testing

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

GPII Implementation

User Involvement

Developers Space

Other

Policies

Special Pages

Tools

@@ Line 1: / Line 1: @@
-= Installation Instrutions =
+<span style="color:#ff0000; font-size:large">This page only applies to v0.1 (2012) of the GPII framework - please see: [[Setting Up Your Development Environment]] for more current instructions</span>
-This release supports two platforms; windows 7 and Fedora Linux with Gnome 3. Installation instructions can be found below
+This release supports two platforms: Windows 7 and Fedora Linux with Gnome 3. Installation instructions can be found below.
-= Fedora 17 =
+== Fedora 17 ==
 === Requirements: ===
-* Fedora 17 needs to be installed. Installation requires super-user privileges.
+*Fedora 17 needs to be installed. Installation requires super-user privileges.
 === Installation Instructions ===
+==== Ensure pre-requisites ====
 <pre>sudo yum install kernel-devel kernel-headers dkms gcc gcc-c++ \
    git openssl-devel glib-devel glib2-devel gtk3-devel \
    pcsc-lite-devel pcsc-lite pcsc-perl
 </pre>
-=== Node.js ===
+==== Install node ====
 <pre>sudo yum localinstall --nogpgcheck http://nodejs.tchol.org/repocfg/fedora/nodejs-stable-release.noarch.rpm
 sudo yum install nodejs nodejs-devel nodejs-gyp nodejs-doc nodejs-debuginfo
-sudo ln -s /usr/bin/nodejs /usr/bin/node
+sudo ln -s /usr/bin/node /usr/bin/nodejs
 </pre>
-=== Other Dependencies ===
+==== Install RFID listener ====
-#Google Chrome
+(only required if you want to use a RFID listener on the system)
-##[https://www.google.com/chrome/index.html https://www.google.com/chrome/index.html]
-=== RFID User Listener ===
+Go to the location where you want to install the GPII
-In your GPII code directory:
+Clone the GPII PCSC Tools Repository
-<pre># Clone the GPII PCSC Tools Repository
+<pre>git clone https://github.com/GPII/linux-rfid-user-listener
-git clone https://github.com/GPII/linux-rfid-user-listener # TODO: Update this with a project repo URL
 cd linux-rfid-user-listener
+</pre>
-# Compile and install
+Compile and install
-make all
+<pre>make all
 sudo make install
+</pre>
+Final step is to start a daemon running in the background and the scanner
-# Start PCSC the daemon
+Start first daemon and then scanner:
-sudo /usr/sbin/pcscd
+<pre>sudo /usr/sbin/pcscd
-# Run the scanner
 ./pcsc_scan
 </pre>
-We also include a utility for reading and writing the tokens on smart cards.
+==== Install and run GPII Personalization Framework ====
-<pre># If you haven't started the daemon already do so.
-sudo /usr/sbin/pcscd
-# Shows the model of tag you're using
-python pcscutil.py get model
-# Shows the current token stored on the card
-python pcscutil.py get gpiitoken
-# Sets the card token to 'nisha'
-python pcscutil.py set gpiitoken nisha
-</pre>
-== Ubuntu 12 Installation Instructions ==
-=== Required packages ===
-Use 'sudo apt-get install' to install the following packages:
-<pre>  git
-  g++
-  curl
-  libglib2.0-dev
-  nodejs (*)
-  nodejs-dev (required for node-gyp)
-  pcscd (**)
-</pre>
-(*) If nodejs won't install via 'sudo apt-get install' use the following:
-<pre>  sudo apt-get install python-software-properties
-  sudo add-apt-repository ppa:chris-lea/node.js
-  sudo apt-get update
-  sudo apt-get install nodejs npm
-</pre>
-(**) For the RFID User Listener (optional).
-''Other packages may be required. This will become clear when you run the build.sh bash file ([http://wiki.gpii.net/index.php/Setting_Up_Your_Development_Environment#The_GPII_Personalization_Framework see bellow]).''
-=== Other Dependencies ===
-#Google Chrome
-  You can either:
-  [https://www.google.com/chrome/index.html Download the installer]
-  OR
-  use 'sudo apt-get install google-chrome-stable'
-=== RFID User Listener ===
-Follow the steps described in the [http://wiki.gpii.net/index.php/Setting_Up_Your_Development_Environment#Fedora_17_Installation_Instructions Fedora 17 Installation Instructions]
-== The GPII Personalization Framework ==
+Make sure you're in the directory where you want to install the GPII.
 From the command line:
@@ Line 98: / Line 50: @@
 git clone git://github.com/GPII/linux.git
 cd linux
+git checkout origin/v0.1
 # Build the Framework:
@@ Line 105: / Line 58: @@
 ./start.sh
 </pre>
-=== Fedora In VirtualBox ===
+==== Running the framework in general ====
-Most of the GPII development team run Fedora Linux as a virtual machine with VirtualBox.
+After having followed the above steps, you will have installed the GPII and it should be running on the machine. In general (for example after a reboot), you would have to do the following steps:
-#Ensure you're running VirtualBox 4.1.10 or higher ([https://www.virtualbox.org/ https://www.virtualbox.org/])
-#Set up a new Virtual Box VM
-##Choose "Enable 3D Acceleration" in the Display tab
-##Ensure you allocate sufficient disk space and RAM to support a full Fedora installation with GNOME Shell 3
-#Update your kernel by running, as root: yum -y update kernel
-#Restart your virtual machine
-#Mount the VirtualBox Guest Additions disk by choosing '''Devices''' > '''Install Guest Additions''' from the VirtualBox menu bar
-#As root:
-##cd /run/meda/&lt;username&gt;/VBOXADD...
-##sh ./VBoxLinuxAdditions.run
-##restorecon -R -v /opt
-#Restart your virtual machine
+To starts GPII, go to the GPII install dir, then:
+<pre>cd linux
+./start.sh
+</pre>
+To enable the RFID listener, go to the GPII install dir, then:
+<pre>cd linux-rfid-user-listener
+sudo /usr/sbin/pcscd
+./pcsc_scan
+</pre>
 == Windows Installation Instructions ==
@@ Line 132: / Line 81: @@
 *Node
-**Go to [http://nodejs.org/download/ http://nodejs.org/download/], and choose the 32-bit (x86) version for Windows.
+**Go to [http://nodejs.org/download/ http://nodejs.org/download/], and choose the 32-bit (x86) version for Windows. NB - we've had issues with the latest version of node, so to be on the safe side, we suggest you use 0.8.23, found here: [http://nodejs.org/dist/v0.8.23/ http://nodejs.org/dist/v0.8.23/] - for windows, download the file ending in "x86.msi"
 *MinGW
@@ Line 138: / Line 87: @@
 **When installing MinGW, make sure the C and C++ compiler checkboxes are on
 **Add C:\MinGW\bin to your PATH variable (Right click My Computer > Properties > Advanced > Environment Variables)
-*Microsoft Visual C++ Redistributable Package (x86)
+*Microsoft Visual C++ 2010 Redistributable Package (x86)
 **Download and install from [http://www.microsoft.com/en-us/download/details.aspx?id=5555 http://www.microsoft.com/en-us/download/details.aspx?id=5555]
+*Microsoft Hotfix for issue KB2516889 - this issue prevents the application of the "High Contrast" desktop profile on all modern versions of Windows (7 and 8)
+**Download and install from [http://support.microsoft.com/kb/2516889 http://support.microsoft.com/kb/2516889]
 === Building and Starting ===
@@ Line 147: / Line 98: @@
 **mkdir c:\gpii (or wherever you prefer)
 **cd c:\gpii
-*Clone the GPII Windows repository
+*Clone the GPII Windows repository and make sure we got the correct version
 **git clone <nowiki>git://github.com/GPII/windows.git</nowiki>
 **cd windows
+**git checkout origin/v0.1
 *Compile the GPII Windows native code (run the following command from the Windows/DOS shell):
 **build.cmd
@@ Line 158: / Line 110: @@
 *On Windows 7, the GPII can't currently kill applications using taskill unless you:
-**Go into Control Panels > User Accounts and Family Safety > User Accounts > User Account Control Settings
+**Go into Control Panel > User Accounts and Family Safety > User Accounts > User Account Control Settings
 **Set the notification level to "Never notify"
-== Troubleshooting ==
+=== RFID Listener ===
+The RFID is currently at an experimental state and only available as an exe. It can be found here: [https://www.dropbox.com/s/n7ntpzvj4v1ksm8/GpiiUserListener110.exe https://www.dropbox.com/s/n7ntpzvj4v1ksm8/GpiiUserListener110.exe]
+== Testing ==
 Once you start the system (by using the start.cmd/start.sh scripts), you can test it without USB by navigating your browser to the following URLs:
-[http://localhost:8081/user/sammy/login http://localhost:8081/user/sammy/login]
+[http://localhost:8081/user/sammy/login http://localhost:8081/user/sammy/login] (This will run the windows magnifier which can be exited with the WindowsKey + Esc)
 [http://localhost:8081/user/sammy/logout http://localhost:8081/user/sammy/logout]
-== Mac Installation Instructions ==
+To test the USB listener create a file '.gpii-user-token.txt' in the root of a USB memory stick containing the text "sammy" (no quotes). Insert the stick to login and remove it to logout.
-Covering the installation of the universal package and node.js.
-<span style="color:#ff0000;">'''The Mac installation doesn't do much yet except running gpii in node.js. There are no settings handlers or listeners implemented yet, so only the http GET or POST requests will work.'''</span>
+[[Category:GPII Architecture]]
-*Installing make: The make compiler is not automatically included in a Mac, but is included in the Xcode development package.
-**If you have already installed xcode, you can skip this step. Otherwise there are two possibilities as described below. Anyway you need an apple developer account, which is for free at this time.
-**Download and install Xcode from the apple developers page [https://developer.apple.com/devcenter/ Apple Developer Center]
-**or only install the "Command Line Tools For XCode" from [https://developer.apple.com/downloads/ Apple Developer Downloads]
-*Install [https://help.github.com/articles/set-up-git git]. The GUI-Tools automatically install the command line tools too.
-*Install node.js in the terminal:
-<pre>git clone git://github.com/ry/node.git
-cd /node
-./configure
-make
-sudo make install</pre>
-*Install GPII Universal
-(to be tested.)
-<pre>git clone git://github.com/GPII/universal.git</pre>
-finally you need to mimic the structure in the git gpii linux version.
-*move the just downloaded "universal" directory to a place you like.
-*create a folder-structure looking like this
-<pre>- gpii
-- mac
--- index.js
-- node-modules
--- universal
-</pre>
-*the index.js file needs to be created and for the beginning can contain
-<pre>/*!
-GPII Linux Personalization Framework Node.js Bootstrap
-Copyright 2012 OCAD University
-Licensed under the New BSD license. You may not use this file except in
-compliance with this License.
-You may obtain a copy of the License at
-https://github.com/gpii/universal/LICENSE.txt
-*/
-var fluid = require("universal"),
-    gpii = fluid.registerNamespace("gpii");
-// fluid.require("gsettingsBridge", require); /* linux specific, like this you can load the handlers and listeners as soon as they are developed. */
-gpii.config.makeConfigLoader({
-    nodeEnv: gpii.config.getNodeEnv("fm.ps.sr.dr.mm.os.development"),
-    configPath: gpii.config.getConfigPath() || "../node_modules/universal/gpii/configs"
-});
-</pre>
-*the "universal" folder is the recently downloaded folder from github, containing all the downloaded files.
-*open the terminal and go to the just created index.js file. run:
-<pre>node index.js
-</pre>
-Well done, this will start the node.js server and make gpii running and listening. The Port number on which it is listening should be shown in the second-last output line, like this:
-<pre>...
-:04:25.786:   Firing event registerMiddleware of component with typename gpii.requests and id 9c0m8p6e-14 to list of 1 listeners
-:04:25.787:   Firing event onHandlers of component with typename gpii.server and id 9c0m8p6e-9 to list of 1 listeners
-:04:25.789:   Server is running on port: 8081
-:04:25.789:   Cleared instantiators (last id 9c0m8p6e-8) from threadLocal for end of flowManager.preferencesServer.solutionsRegistry.deviceReporter.matchMaker.ontologyServer.development
-</pre>