Cloud4all Pilot 3 - Set up and installation

From wiki.gpii
Jump to: navigation, search

Read me first:

  • This page will describe the installation instructions for all the software that will be needed in Cloud4all's third pilot phase. (These instructions replace those for the second pilot phase).
  • For installation instructions that can be used independently of any Cloud4all evaluation phase, see Setting Up Your Development Environment.
  • The "home page" for everything related to the third pilot phase is Cloud4all 3rd Pilots iteration.
  • The review3 branch contains the code that will be used for the third pilot. (It made no sense to create a new pilot3 branch.)

Dual-Booting Windows 7 and Fedora 21

Although not required, it is fairly straightforward to set up PCs with both Windows 7 and Fedora 21. If you set up a dual-boot machine with a single hard disk, the basic steps are as follows:

  1. Install Windows 7. (Windows must be installed before GNU/Linux. Installing Windows after GNU/Linux would overwrite GNU/Linux.)
  2. In Windows, reduce the size of the hard disk partition used by Windows. You can use Windows' built-in Disk Management tool for this. A new partition of 50 GB should be sufficient for Fedora 21. You don't need to format the newly crated partition or assign it a drive letter.
  3. Insert a DVD with a Fedora 21 ISO image and restart the PC; make sure that the PC boots from the DVD. (You may need to access the boot menu, or, in the worst case, change the BIOS settings for this.)
  4. Go through the Fedora 21 installation process.
    1. After a few steps, the Fedora installer will ask you to define the "installation destination". Here, you select the drive where you created the new partition.
    2. After selecting "Done", there will be another dialog that says that there isn't enough disk space available. Select the "Reclaim space" button and "delete" the new partition, then reclaim it for Fedora.
  5. The rest of the installation process is like a normal Fedora installation: set up a user, pick an administrator password, etc.
  6. When the installation finishes, press "Quit", remove the DVD and shut down the computer. Then check whether you can reboot into Windows and Linux before you install any other software. (You will also note that Fedora allows you to access the Windows partition, but that Windows does not give you access to the Fedora partition.)

Some other notes:

Installing the GPII Framework

Installing GPII on Fedora

The third pilots will run on Fedora 21. You can install this using the Fedora 21 Live Desktop ISO Image (x86_64).

  1. To install Fedora:
    • From a Live CD, choose Applications > System Tools > Install to Hard Drive
    • From an Install ISO, choose Activities > Install to Hard Drive
  2. To install the GPII framework, follow the steps in the GPII on Fedora 21 installation instructions (on Google Drive).

As an alternative, you can also install the GPII on Fedora yourself by following the instructions in Setting Up Your Development Environment, but for the pilots, it is highly recommended to install it by using the RPM packages.

Installing Additional Linux Tools

In addition to GPII, it is also necessary to install at least the dconf-editor and the gnome-tweak-tool. GIMP is optional but can be useful for taking screenshots. To install all of these at once, open a terminal window and enter the following command:

 sudo yum install dconf-editor gnome-tweak-tool gimp

Orca Configuration for Firefox

After installing Fedora, it is a good idea to briefly launch Orca. Going through the configuration for Firefox described below is sufficient for this. (Until Orca is launched for the first time, there is no file with Orca settings at /home/<user>/.local/share/orca/user-settings.conf; the orca directory is created when Orca is started for the first time.)

Make sure that caret navigation when using Firefox with Orca is handled by Orca. First start Orca, then start Firefox. While you are in Firefox, press Ctrl+Orca Modifier+Space (on a desktop PC, the Orca modifier is usually the Insert key, so you should press Ctrl+Insert+Space). You should then see the Orca settings dialog with a Firefox tab. On this tab, disable the first setting: "Control caret navigation". (See this dialog.)

Installing GPII on Windows 7

The third pilot phase will use the 74-bit version of Windows 7. The OS should be installed with Aero Themes (in order to enable lens mode and full screen mode in the Magnifier).

If you want to install GPII on a Windows PC where the second pilot version of GPII was installed, it is probably safer to go through the following steps first:

  • delete the folder C:\Users\<USER_NAME>\AppData\Roaming\npm-cache
  • delete the gpii folder you created for the second pilot (or you can just rename it to "gpii-pilot2" if you want to keep it; just don't install the review3 code in the same directory as the second pilots code).

The following manual instructions assume that there is no Windows installer for GPII with the review3 branch. (Until now, the Windows installer was based on GPII's master branch.)

Dependencies

  • Git
  • Node.js
    • Next you need to install Node.js v0.10.x. Use this direct link: http://nodejs.org/dist/v0.10.38/node-v0.10.38-x86.msi - or go to http://nodejs.org/download/ and download the 32-bit version of v0.10.38 - look under "other releases. The system currently FAILS WITH THE LATEST NODE VERSION
      • if you see the error FATAL ERROR: Uncaught exception: %1 is not a valid Win32 application. you probably have the 64-bit version of Node.js.
    • Troubleshooting:
      • Node v0.10.33 has a bug with the installer, the folder %APPDATA%\npm doesn't get created. If you see an error like: "Error: ENOENT, stat 'C:\Users\<USERNAME>\AppData\Roaming\npm'" on install, simply create the folder by typing "mkdir %APPDATA%\npm"
      • to ensure nodejs folder is on the path ("echo %PATH%") and add it before nodejs\node_modules\npm if required.

Other:

  • Windows 7 has a bug with high-contrast mode in the 64-bit version. If you're running this Windows version, you'll need to install the hotfix linked from this Microsoft support page (x64 only).

Building and Starting the GPII Personalization Framework on Windows

  • Open a command line window (Start > Run > cmd).
  • Create a GPII directory
    • mkdir c:\gpii (or wherever you prefer, but the rest of these instructions will assume c:\gpii)
    • cd c:\gpii
  • Clone the GPII Windows repository
    • git clone git://github.com/GPII/windows.git
    • cd windows
  • Install dependencies of the framework
  • Make sure grunt is installed:
    • npm install grunt
    • npm install -g grunt-cli
  • Build the framework:
    • grunt build
  • You should now be able to start the GPII Framework by running the following command in the gpii\windows folder:

However, at this point, you are still using GPII's master branch of universal. (You can check this by going to c:\gpii\node_modules\universal and running the command git branch )

  • Check out the review3 branch of universal
    • cd c:\gpii\node_modules\universal
    • (git fetch origin [just in case the local is not fully up to date with some changes in master])
    • git checkout review3
    • (You are now on the review3 branch. You can check this by running git branch  .)
  • Remove the folder c:\gpii\node_modules\universal\node_modules.
  • Run npm install
  • Remove duplicate versions of Infusion by running the following command:
    • grunt dedupe-infusion
  • You can now start the GPII Framework with the review3 branch:
    • While in c:\gpii\windows run the command node gpii.js.
    • (Do not use grunt start; issues have been reported with this command.)

Installing the USB and RFID listeners

  • Use the Windows installer.
  • Or, if the Windows installer is not available, download the installer from https://github.com/OpenDirective/GPII-windows/releases/tag/Listeners_V1.3.0 and run it.
    • The installer will ask you for an installation directory for these files. You can choose the directory proposed by the installer, i.e. C:\Program Files\GPII or C:\Program Files (x86)\GPII (depending on your Windows version).
    • In the dialog window with installation options, make sure that the checkboxes for the USB listener and the RFID/NFC listener are checked. If you want to start the listeners from the Windows start menu, also check the checkbox for adding menu icons. If you want the listeners to start automatically when you start Windows, also check the checkboxes for that.

If you don't want the listeners to start automatically when Windows launches, you have several options: starting them through the Windows Start menu or using the CMD file that you can use to start GPII. The steps below explain how to adapt the CMD file to start the listeners.

  • Go to C:\gpii\windows, create a copy of the file start.cmd, rename this copy to startp3.cmd and open it in an editor such as Notepad.
  • Delete the line start UsbUserListener\bin\UsbUserListener.exe and add the following (if you installed the listeners in C:\Program Files\GPII, and don't forget the quotes!)
    • start "C:\Program Files\GPII\GPII_USBListener.exe"
    • start "C:\Program Files\GPII\GPII_RFIDListener.exe"
  • However, if you have a 64-bit version of Windows, these lines will need to read:
    • start "C:\Program Files (x86)\GPII\GPII_USBListener.exe"
    • start "C:\Program Files (x86)\GPII\GPII_RFIDListener.exe"
  • After this, running startp3.cmd or startp3-64.cmd should start GPII with both the USB and the RFID listener.

Running start.cmd will only start GPII, and you'll need to start the listeners separately.

Windows Desktop Shortcut

This is optional.

  • Download the Cloud4all icon for the Windows desktop.
  • Go to <gpii>\windows\, right-click on start.cmd, startp3.cmd or startp3-64.cmd (this step assumes you downloaded one of the CMD files mentioned above to GPII's windows folder) and select Send to > Desktop (create shortcut).
  • Go to the Windows desktop and right-click on the newly created shortcut, select "Properties" and then "Change Icon ..." (on the Shortcut tab); then browse to the downloaded icon to set it as the icon for the shortcut.
  • Right-click the shortcut or icon again and select "Rename" to give it a more user-friendly name, e.g. "Start Cloud4all".

Updating GPII on Windows

To update GPII on Windows, go through the following steps:

  • Go to gpii\node_modules\universal and execute the following commands:
    • git fetch origin
    • git merge origin/review3
  • (Optionally, you can also run git log to see what changed; you can then quit the log listing by entering q.)
  • After the update, the GPII framework needs to be restarted.

Additional Windows Configuration

  • In order to allow adaptations to the screen resolution (as part of the scenario with c4a_p3_martha), you need to do the following:
    • First, you will almost certainly need to install vcredist_x86.exe from the MSVC redistributables for VS2013 from Microsoft.
    • Then, download the file winsetres.exe and
    • save the file in C:\Program Files (x86)\ (on a 64-bit version of Windows).
    • There is no need to restart or update GPII to enable the adaptations to the screen resolution.
  • To be able to change the screen resolution you need to:
  • On Windows 7, the GPII cannot kill applications using taskill unless you change the user account control settings:
    • Go into Control Panels > User Accounts and Family Safety > User Accounts > User Account Control Settings
    • Set the notification level to "Never notify".
    • You need to reboot Windows to apply this setting.
  • The Magnifier may be set to change magnification in steps of 100% by default. In order to enable smaller steps, start the Magnifier, open the Options (the cogwheel icon) and change the slider to 25%.
  • The following is optional but useful if you want to report back on bugs:
    • Open a command line and right-click on the command line's window.
    • In the context menu that pops up, select the "Layout" tab.
    • In the layout tab, change the "Height" of the "Screen Buffer Size" to a much higher number, e.g. 900. Then click OK to confirm the change.
    • As a result of this, most of the DOS windows that pop up when you start GPII will "store" more logging lines. These logging lines can be copied and pasted into bug reports. For guidance on how to copy those logging lines, see Microsoft's article To copy text from a command prompt window.

Installing GPII on Android

Installation instructions

Additional Configuration for ensuring the use of the preferences server and matchmakers

Source: Kasper's message from 15 January.

The system will run using the review3 branch of "universal" with the following components:

  • remote preferences server,
  • remote rule-based matchmaker,
  • remote statistical matchmaker.

(The config can be inspected in pull request 310).

In addition, the environment variable NODE_ENV needs to be adapted:

  • on Windows, use SET NODE_ENV=production.with.logging ;
  • on Linux and Mac OS, use export NODE_ENV=production.with.logging .

After this, the real-time framework can be started in the usual way.

Note for Linux - If you've installed the GPII via RPMs, the "GPII Pilot3" launcher is already using this configuration, so it's not required for you to set that variable manually.

Installing the PCP and PMT

Note: Running the PMT on Node.js; this requires this pull request; see JIRA ticket GPII-1091, which has been merged into the review3 branch.

Installing PMT and PCP on Windows OS

Step 1. Install supported web browser

  1. Visit https://www.mozilla.org or http://www.getfirefox.net.
  2. Download the latest version of Mozilla Firefox in your locale using the Download button provided there. Note: The locale version of Mozilla Firefox will be downloaded will determine the language that PMT will use.
  3. Run the installer
  4. During the installation process there will be a checked selection to make Firefox your default browser. Leave that selection checked.

Step 2: Install and run PMT and PCP (using Git and Kettle)

The following steps will guide you on installing and running PMT:

  1. Download the prefsEditors repo with your favourite Git client or using the command line:
    git clone https://github.com/GPII/prefsEditors


  1. navigate to the prefsEditors directory:
    cd prefsEditors
  2. checkout the review 3 branch:
    git checkout review3
  3. install dependencies:
    npm install
  4. now the web server can be started from the prefsEditors folder by running node start.js:
    node start.js. This will also automatically open the PMT in your default web browser.

Installing PMT and PCP on Fedora OS

The following steps will guide you on installing and running PMT:

  1. Create PMT folder inside home folder.
    mkdir pmt
  2. Navigate to the PMT directory:
    cd pmt
  3. Download the prefsEditors repo with your favourite Git client or using the command line:
    git clone https://github.com/GPII/prefsEditors


  1. Navigate to the prefsEditors directory:
    cd prefsEditors
  2. Checkout the review 3 branch:
    git checkout review3
  3. Install npm:
    sudo yum install npm
  4. Replace the git protocol (eg. because of firewalls or the like) with https protocol (http://wiki.gpii.net/w/Installation_Instructions_First_Pilots#Troubleshooting):
    git config --global url."https://".insteadOf git://
  5. Install dependencies:
    npm install
  6. Now the web server can be started from the prefsEditors folder by running node start.js:
    node start.js. This will also automatically open the PMT in your default web browser.

Running the PMT and PCP

Assuming that you are using port 8888 for both tools, you can access the PMT http://localhost:8888/demos/prefsEditor/index.html and the PCP at http://localhost:8888/demos/prefsEditor/pcp.html.


Installing the pilotsConfig Tool

This section will be filled in if/when the pilotsConfig tool has been updated. (We can probably reuse the instructions from the second pilot phase.) However, the pilotsConfig tool will probably not be needed in the third pilot phase.

Installing SP3 Solutions

Note: SP3 solution details contains installation instructions for many SP3 solutions.

Windows 7 Built-in AT

Make sure that the On-Screen Keyboard and the Windows Magnifier are installed on your version of Windows 7.

NVDA

Get the latest stable release from SourceForge. Double-click the EXE file to install the screen reader.

(The user guide is available online; check especially the section Navigating with NVDA.)

SuperNova

For the January 2015 review, the required version is 13 (as in the second pilot phase), not version 14.

Installation:

  • Run the installer for SuperNova Access Suite 13.
  • At the end of the installation process you will be asked whether you want to configure SuperNova. During this configuration process, disable the option to start SuperNova automatically during the Windows booting process.
  • Download the additional file and run it. This file connects SuperNova with GPII.

Note: If you have leftover files from previous installations of SuperNova, these need to be removed. Go to C:\Users\<userAccount>\AppData\Local\dolphin and make sure that there is only one folder for SuperNova. (See this message to the Architecture list.)

ReadWrite Gold

See SP3 solution details (added January 2015).

Maavis

See SP3 solution details (updated January 2015).

Note: There seems to be a regression in that the high-contrast theme is missing in the current release; will be fixed after the review.

Cloud4Chrome

See SP3 solution details (updated January 2015).

Java ME for Feature Phones

See SP3 solution details.

Useful Links

Tools:

Other:

Wiki Categories